i2b2 Web Client
Space shortcuts
Space Tools

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Information in the 'Workplace' is related to the most common concepts and queries that an individual uses and in essence becomes their personal workspace. The main objectives of the 'Workplace' are: 

  • Save and organize user specific items.
  • Share information with other project users.
  • Project managers can view the workplace for individual team members.

 The items stored in the Workplace view can be used in many of the i2b2 views and plug-ins, such as the 'Query Tool'.

7.1. Layout of the Workplace View

As stated above the Workplace view is a place for users to store and organize those items they use on a regular basis. It is also a way to share these items with other users by placing them in the SHARED folder.

 

wpViewImage Added

 

 

The Workplace view is hierarchical display of the items added by the user. There are three main branches or components of the tree that displays.

 

 

User Folder

The highest level is the individual user folder (containerImage Added). This folder is automatically created with the user's name and it is used to store items added by the individual user. This level cannot be used when creating a query.

 

NOTE:

This also includes the shared folder.

 

 

Folders

folder (folderImage Added) in the workplace view contains other folders and / or items added by the user. It can be expanded and collapsed by clicking on the plus sign (plusSignImage Added) or negative sign (minusSignImage Added) next to it. A user defined folder can not be dragged to other i2b2 views. It can be moved around within the Workplace view.

 

Items

Items are the lowest level of the hierarchy. They can not be expanded further. Some examples of items are listed below.

 

  • Concepts (leafImage Added)
  • Group of concepts (ontology folder) (folderConceptsImage Added)
  • Modifiers (modifierImage Added)
  • Group of modifiers (modifier folder) (folderModifierImage Added)
  • Patient set (ptSetImage Added)
  • Encounter set (ptSetImage Added)

 

 

Navigation

Expand / Collapse a Folder

Users can expand or collapse a folder by clicking on the plus sign (plusSignImage Added) or negative sign (minusSignImage Added) next to the folder icon.

 

Expand (Open) a Folder

  1. Click on the plus sign (plusSignImage Added) next to the folder in the Workplace view.
  2. The folder will open and all the items in the folder will display.

 

 

Collapse (Close) a Folder

  1. Click on the negative sign (minusSignImage Added) next to the folder in the Workplace view.
  2. The folder will close and all the items in the folder will display.



 

 

Add a Workplace Folder

 

    1. Using the right mouse button, click on your user folder in the Workplace view.
    2. A pop-up menu will open.

 

wpAddNewFolderImage Added

 

 

    1. Select New Folder.
    2. A new window will open.

 

wpAddNewFolderWindowImage Added

 

 

    1. In the text box enter the name you want to be displayed.
    2. Click on the OK button.
    3. The new folder will appear in the Workplace view.

 

wpFolderAddedImage Added

 

 

Rename a Folder

Users can easily rename an existing folder.

    1. Using the right mouse button, click on the folder you want to rename.
    2. A pop-up menu will open.

 

wpMenuFolderImage Added

 

 

    1. Select Rename from the list.

 

wpFolderRenameSelectImage Added

 

 

    1. A new window will open.

 

wpFolderRenameWindowImage Added

 

 

    1. In the text box change the current name to the new name.
    2. Click on the OK button.
    3. The folder will appear in the Workplace view with the new name.

 

wpFolderRenamedImage Added

 

 

Annotate a Folder

Users can change the default annotation for any of their folders in the Workplace view.

 

NOTE:

The annotation is what is displayed in the tool tip.

 

 

    1. Using the right mouse button, click on the folder you want to annotate.
    2. A pop-up menu will open.

 

wpMenuFolderImage Added

 

 

    1. Select Annotate from the list.

 

wpAnnotateSelectImage Added

 

 

    1. A new window will open.

 

wpFolderAnnotateWindowImage Added

 

 

  1. In the text box enter the text you want to appear when the tooltip is displayed.
  2. Click on the OK button.
  3. Using the mouse, hover over the folder you just annotated.
  4. The text you entered will display as a tool tip.

 

 

Delete a Folder

Users can remove a folder from the Workplace view.

 

WARNING:

All items in the folder will be deleted when the folder is removed. It is recommended that you move those items you want to keep to another folder.

 

 

    1. Using the right mouse button, click on the folder you want to delete.
    2. A pop-up menu will open.

 

wpMenuFolderImage Added

 

 

    1. Select Delete from the list.

 

wpFolderDeleteSelectImage Added

 

 

    1. A message box will open.

 

wpFolderDeleteWarningImage Added

 

 

  1. Click on the OK button.
  2. The folder and all of its contents will no longer appear in the Workplace view.

 

 

Rename Items

Users can easily rename an item in the Workplace view.

    1. Using the right mouse button, click on the item you want to rename.
    2. A pop-up menu will open.

 

wpMenuItemImage Added

 

 

    1. Select Rename from the list.

 

wpItemRenameSelectImage Added

 

 

    1. A new window will open.

 

wpItemRenameWindowImage Added

 

 

  1. In the text box change the current name to the new name.
  2. Click on the OK button.
  3. The item will appear in the Workplace view with the new name.

 

Annotate Items

Users can change the default annotation for any of the items in their Workplace folder.

 

NOTE:

The annotation is what is displayed in the tool tip.

 

 

    1. Using the right mouse button, click on the item you want to annotate.
    2. A pop-up menu will open.

 

wpMenuItemImage Added

 

 

    1. Select Annotate from the list.

 

wpItemAnnotateSelectImage Added

 

 

    1. A new window will open.

 

wpItemAnnotateWindowImage Added

 

 

  1. In the text box enter the text you want to appear when the tooltip is displayed.
  2. Click on the OK button.
  3. Using the mouse, hover over the item you just annotated.
  4. The text you entered will display as a tool tip.

 

 

Delete Items

Users can remove items from the Workplace view.

 

    1. Using the right mouse button, click on the item you want to delete.
    2. A pop-up menu will open.

 

wpMenuItemImage Added

 

 

    1. Select Delete from the list.

 

wpItemDeleteSelectImage Added

 

 

    1. A message box will open.

 

wpItemDeleteMsgImage Added

 

 

  1. Click on the OK button.
  2. The item will no longer appear in the Workplace view.


 

 

Adding Items to Workplace View

This section describes how to add items to the Workplace view.

 

Items Draggable to Workplace

Items can be dragged and dropped (copied) into the Workplace view from other views in the i2b2 Web Client.

 

    1. Folder

folder (folderImage Added) and all its concepts (children) can be added to Workplace by dragging the folder name from one of the following views.

 

      • Find Terms view
      • Navigate Terms view

 

 

    1. Modifier Folder

modifier folder (modifierFolderImage Added) and all its modifiers (children) can be added to Workplace by dragging the folder name from one of the following views.

 

      • Find Terms view
      • Navigate Terms view

 

 

    1. Concept

concept (leafImage Added) can be added to Workplace by dragging the name of the concept from one of the following views.

 

      • Find Terms view.
      • Navigate Terms view

 

 

    1. Modifier

modifier (modifierImage Added) can be added to Workplace by dragging the name of the modifier from one of the following views.

 

      • Find Terms view.
      • Navigate Terms view

 

 

    1. Patient Set

Patient set (ptSetImage Added) can be added to Workplace by dragging the name of the patient set from the following view.

 

      • Previous Query view.

 

 

    1. Encounter Set

An Encounter set (ptSetImage Added) can be added to Workplace by dragging the name of the encounter set from the following view.

 

      • Previous Query view.

 

 

    1. Previous Query

previous query (previousQueryImage Added) can be added to Workplace by dragging the name of the previous query from the following view.

 

    • Previous Query view.

 

 

Add Folders and Concept to Workplace View

 

Find Terms View

The Find Terms view provides a way to search for a particular concept.

 

ftViewImage Added

 

 

NOTE:

For detailed information on how to search for terms, please see the i2b2 Find Terms help.

 

 


Add Folder / Concept From Find Terms View

 

    1. In the Find Terms view, search for the item(s) you want to add.
    2. Highlight the folder (folderImage Added) or concept (leafImage Added) by clicking on its name.
    3. While holding the left mouse button down, drag the item over to the Workplace view.
    4. Drop the item into either your workplace folder or the shared folder.

 

wpDragFolderImage Added

 

 

    1. The item will now display in the Workplace view with the same name.

 

wpDropFolderImage Added

 

 

 

Navigate Terms View

The Navigate Terms view contains a hierarchical display of all the concepts and modifiers that can be used to search the database.

 

ntViewImage Added

 

 

NOTE:

How the items are grouped and displayed is dependent on how the database is setup.

 

 

Add Folder / Concept From Navigate Terms View

 

    1. In the Navigate Terms view, expand the folder(s) that contains the concept or grouping of concepts you want to add.
    2. Highlight the folder (folderImage Added) or concept (leafImage Added) by clicking on its name.
    3. While holding the left mouse button down, drag the item over to the Workplace view.
    4. Drop the item into either your workplace folder or the shared folder.

 

wpDragConceptImage Added

 

 

    1. The item will now display in the Workplace view with the same name.

 

wpDropConceptImage Added

 

 

 

 

Add Modifier Folders and Modifiers to Workplace View

 

Find Terms View

The Find Terms view provides a way to search for a particular concept.

 

ftViewImage Added

 

 

NOTE:

For detailed information on how to search for terms and modifiers, please see the i2b2 Find Terms help.

 

 

Add Modifier Folder / Modifiers From Find Terms View

 

    1. In the Find Terms view, search for the item(s) you want to add.
    2. Highlight the modifier folder (modiferFolderImage Added) or modifier (modifierImage Added) by clicking on its name.
    3. While holding the left mouse button down, drag the item over to the Workplace view.
    4. Drop the item into either your workplace folder or the shared folder.

 

wpDragModifierImage Added

 

 

    1. The item will now display in the Workplace view with the same name.

 

wpDropModifierImage Added

 

 

 

Navigate Terms View

The Navigate Terms view contains a hierarchical display of all the concepts and modifiers that can be used to search the database.

 

ntViewImage Added

 

 

NOTE:

How the items are grouped and displayed is dependent on how the database is setup.

 

 

Add Modifier Folder / Modifier From Navigate Terms View

 

    1. In the Navigate Terms view, expand the folder(s) that contains the modifiers or grouping of modifiers you want to add.
    2. Highlight the modifier folder (modifierFolderImage Added) or modifier (modifierImage Added) by clicking on its name.
    3. While holding the left mouse button down, drag the item over to the Workplace view.
    4. Drop the item into either your workplace folder or the shared folder.

 

wpDragModiferImage Added

 

 

    1. The item will now display in the Workplace view with the same name.

 

wpDropModifierImage Added

 

 

 

Add Previous Query, Patient Set and Encounter Set to Workplace View

 

Previous Query View

The Previous Query view displays the queries that were run by the user. Each previous query contains a set of results; within these results are the result options that were selected when the query was originally run. The result options include Patient set, Encounter set, Number of patients as well as various other patient breakdowns

 

pqViewImage Added

 

 

Add Previous Query From Previous Query View

 

    1. Highlight the previous query (prevQueryImage Added) by clicking on the name of the query.
    2. While holding the left mouse button down, drag the item to the Workplace view.
    3. Drop the previous query into either your workplace folder or the shared folder.

 

dragPqToWpImage Added

 

 

    1. The previous query will now appear in the workplace with the same name.

 

dropPqInWpImage Added

 

 

Add Patient Set From Previous Query View

 

    1. Click on the plus sign (plusSignImage Added) next to the name of the previous query that contains the patient set.
    2. Click on the plus sign (plusSignImage Added) next to the results folder.
    3. Highlight the Patient set (ptSetImage Added) by clicking on its name.
    4. While holding the left mouse button down, drag the Patient Set to the Workplace view.
    5. Drop the patient set into either your workplace folder or the shared folder.

 

dragPtSetToWpImage Added

 

 

    1. The patient set will now appear in the workplace.

 

dropPtSetInWpImage Added

 

 

 

Add Encounter Set From Previous Query View

 

    1. Click on the plus sign (plusSignImage Added) next to the name of the previous query that contains the encounter set.
    2. Click on the plus sign (plusSignImage Added) next to the results folder.
    3. Highlight the Encounter set (ptSetImage Added) by clicking on its name.
    4. While holding the left mouse button down, drag the Encounter Set to the Workplace view.
    5. Drop the encounter set into either your workplace folder or the shared folder.

 

dragEncSetToWpImage Added

 

 

    1. The encounter set will now appear in the workplace.

 

dropEncSetInWpImage Added

 

 

 

Using Items in Workplace View

This section describes how to use items in the Workplace view.

 

Items Draggable from Workplace

Items can be dragged and dropped (copied) from the Workplace view to other views in the i2b2 Web client.

 

    1. Ontology Folder

An ontology folder (folderImage Added) and all its concepts (children) can be added to other views by dragging the folder name from Workplace to one of the following views.

 

      • Query Tool view; drop in the panel.

 

NOTE:

User folders can not be dragged from the Workplace view.

 

 

    1. Modifier Folder

modifier folder (modifierFolderImage Added) and all its modifiers (children) can be added to other views by dragging the modifier folder name from Workplace to one of the following views.

 

      • Query Tool view; drop in the panel.

 

 

    1. Concept

concept (leafImage Added) can be added to other views by dragging the name of the concept from Workplace to one of the following views.

 

      • Query Tool view; drop in the panel.

 

 

    1. Modifier

modifier (modifierImage Added) can be added to other views by dragging the name of the modifier from Workplace to one of the following views.

 

      • Query Tool view; drop in the panel.

 

 

    1. Previous Query

previous query (prevQueryImage Added) can be added to other views by dragging the previous query name from Workplace to one of the following views.

 

      • Query Tool view; drop in the panel or Query Name.

 

 

    1. Patient Set

A specific set of patients can be added to other views by dragging the Patient set (ptSetImage Added) from Workplaceto one of the following view.

 

      • Query Tool view; drop in the panel.

 

 

    1. Encounter Set

A specific set of encounters (visit list) can be added to the other views by dragging the Encounter set (ptSetImage Added) from Workplace to one of the following view.

 

    • Query Tool view; drop in the panel.

 

 

 

Using Concepts and Folders

 

A folder or individual concept can be added to the query tool view by simply dragging the item from Workplace viewand dropping it into one of the panels in the Query Tool view.

 

Add Folder to Query Tool View

 

    1. Highlight the folder (folderImage Added) by clicking on the name of the folder.
    2. While holding the left mouse button down, drag the item over to the Query Tool view.
    3. Drop the item into the panel labeled Group 1.

 

qtDragFolderMIImage Added

 

 

    1. The folder will now display in the panel for Group 1.

 

qtDropFolderMIImage Added

 

 

Add Concept to Query Tool View

 

    1. Highlight the concept (leafImage Added) by clicking on the name of the folder.
    2. While holding the left mouse button down, drag the item over to the Query Tool view.
    3. Drop the item into the panel labeled Group 1.

 

qtDragConceptMIImage Added

 

 

    1. The concept will now display in the panel for Group 1.

 

qtDropConceptMIImage Added

 

 

 

 

Using Modifiers and Modifier Folders

A modifier folder or individual modifier can be added to the query tool view by simply dragging the item from the Workplace view and dropping it into one of the panel in the Query Tool view.

 

 

Add Modifier to Query Tool View

    1. Highlight the modifier (modifierImage Added) by clicking on the name of the modifier.
    2. While holding the left mouse button down, drag the item over to the Query Tool view.
    3. Drop the item into the panel labeled Group 1.

 

qtDragModPrincDxImage Added

 

 

    1. The name of the concept associated to the modifier plus the modifier will now display in the panel for Group 1.

 

qtDropModPrincDxImage Added

 

 

 

Using Previous Query

previous query can be used to run a new query or as an item within a query (query-in-query). To add a previous query to the Query Tool view simply drag the query name from the Workplace view.

 

Within the Query Tool view, the previous query can be added to one of the following two locations.

 

Query Name fieldThe items and constraints from the original query will be used to create a new query. This information can be edited to make a new query or can be used as is to run the query again.
Panel (Group)Used within a new query (query-in-query). The information associated with the previous query can not be edited. Add additional search criteria (items) to be used in the new query.

 

 

NOTE:

The process of adding a previous query to the Query Tool view is the same for both standard i2b2 queries (prevQueryImage Added)and temporal queries (Image Added).

 

 

 

Add Previous Query to Query Name (New Query)

 

    1. Highlight the previous query (prevQueryImage Added / Image Added) by clicking on the name of the query.
    2. While holding the left mouse button down, drag the item to the Query Tool view.
    3. Drop the item into the Query Name field.

 

dragPqImage Added

 

 

    1. The item(s) associated with the previous query will display in the appropriate group(s), the name of the query will appear at Query Name, and any constraints that were defined when the original query was run will now default with the new query.

 

dropPqImage Added

 

 

NOTE:

When you run the query it will receive a new name. This is to distinguish the first previous query from the second.

 

 


 

Add Previous Query to Query Name (Query-in-Query)

 

    1. Highlight the previous query (prevQueryImage Added / Image Added) by clicking on the name of the query.
    2. While holding the left mouse button down, drag the item to the Query Tool view.
    3. Drop the item into the panel labeled Group 1.

 

qtDragPqIschemicHrtPanelImage Added

 

 

    1. The previous query will now display in the panel for Group 1.

 

qtDropPqIschemicHrtPanelImage Added

 

 

 

Using Patient Set

Patient set can be used as an item within a query. To add a patient set to the Query Tool view simply drag the name of the patient set from the Workplace view.

 

 

Add Patient Set From Workplace View

    1. In the Workplace view, expand the folder(s) that contains the list of patients you want to add.
    2. Highlight the Patient set (ptSetImage Added) by clicking on its name.
    3. While holding the left mouse button down, drag the item over to the Query Tool view
    4. Drop the item into the panel labeled Group 1.

 

qtDragPtSetImage Added

 

 

    1. The item will now display in the panel for Group 1.

 

qtDropPtSetImage Added

 

 

Using Encounter Set

An Encounter set can be used as an item within a query. To add an encounter set to the Query Tool view simply drag the name of the encounter set from the Workplace view.

 

 

Add Encounter Set From Workplace View

    1. In the Workplace view, expand the folder(s) that contains the list of patients you want to add.
    2. Highlight the Encounter set (ptSetImage Added) by clicking on its name.
    3. While holding the left mouse button down, drag the item over to the Query Tool view
    4. Drop the item into the panel labeled Group 1.

 

qtDragEncSetImage Added

 

 

    1. The item will now display in the panel for Group 1.

 

qtDropEncSetImage Added


7.1 Workplace Operations

     a. Open/Close Folders

     b. Drop in items

         (Queries, Patients, Patient Sets, Terms)

     c. Renaming items

7.1. Personal Folder

7.2 SHARED Folder