webclient.help.wp.html Maven / Gradle / Ivy

Go to download


	
		
		Untitled Document
		
	
	
		i2b2 Workplace View
		Information in the Workplace view is related to the most common concepts and queries that an individual uses and in essence becomes their personal workspace. The main objectives of this view 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 view plug-in.
		
		Introduction
		This section describes the layout and contents of this view.
		 
		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.
		
		 
		
		 
		 
		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 (). 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
		A folder () 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 () or negative sign () 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 ()
			
			Group of concepts (ontology folder) ()
			
			Modifiers ()
			
			Group of modifiers (modifier folder) ()
			
			Patient set ()
			
			Encounter set ()
			
		
		 
		 
		Navigation
		Expand / Collapse a Folder
		Users can expand or collapse a folder by clicking on the plus sign () or negative sign () next to the folder icon.
		
		 
		Expand (Open) a Folder
		
			Click on the plus sign () next to the folder in the Workplace view.
			
			The folder will open and all the items in the folder will display.
		
		 
		 
		Collapse (Close) a Folder
		
			Click on the negative sign () next to the folder in the  Workplace view.
			
			The folder will close and all the items in the folder will display.
		
		
		
		 
		 
		Add a Workplace Folder
		 
		
			Using the right mouse button, click on your user folder in the  Workplace view.
			A pop-up menu will open.
			 
			
			 
			 
			Select New Folder.
			A new window will open.
			 
			
			 
			 
			In the text box enter the name you want to be displayed.
			Click on the OK button.
			The new folder will appear in the Workplace view.
			 
			
		
		 
		 
		Rename a Folder
		Users can easily rename an existing folder.
		
			Using the right mouse button, click on the folder you want to rename.
			A pop-up menu will open.
			 
			
			 
			 
			Select Rename from the list.
			 
			
			 
			 
			A new window will open.
			 
			
			 
			 
			In the text box change the current name to the new name.
			Click on the OK button.
			The  folder will appear in the Workplace view with the new name.
			 
			
		
		 
		 
		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.
					
				
			
		
		 
		 
		
			Using the right mouse button, click on the folder you want to annotate.
			A pop-up menu will open.
			 
			
			 
			 
			Select Annotate from the list.
			 
			
			 
			 
			A new window will open.
			 
			
			
			 
			 
			In the text box enter the text you want to appear when the tooltip is displayed.
			Click on the OK button.
			Using the mouse, hover over the folder you just annotated.
			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.
					
				
			
		
		 
		 
		
			Using the right mouse button, click on the folder you want to delete.
			A pop-up menu will open.
			 
			
			 
			 
			Select Delete from the list.
			 
			
			 
			 
			A message box will open.
			 
			
			 
			 
			Click on the OK button.
			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.
		
			Using the right mouse button, click on the item you want to rename.
			A pop-up menu will open.
			 
			
			 
			 
			Select Rename from the list.
			 
			
			 
			 
			A new window will open.
			 
			
			 
			 
			In the text box change the current name to the new name.
			Click on the OK button.
			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.
					
				
			
		
		 
		 
		
			Using the right mouse button, click on the item you want to annotate.
			A pop-up menu will open.
			 
			
			 
			 
			Select Annotate from the list.
			 
			
			 
			 
			A new window will open.
			 
			
			 
			 
			In the text box enter the text you want to appear when the tooltip is displayed.
			Click on the OK button.
			Using the mouse, hover over the item you just annotated.
			The text you entered will display as a tool tip.
		
		 
		 
		Delete Items
		Users can remove items from the Workplace view.
		 
		
			Using the right mouse button, click on the item you want to delete.
			A pop-up menu will open.
			 
			
			 
			 
			Select Delete from the list.
			 
			
			 
			 
			A message box will open.
			 
			
			 
			 
			Click on the OK button.
			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.
		
		 
		
			Folder
			A folder () 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
			
			 
			 
			Modifier Folder
			A modifier folder () 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
			
			 
			 
			Concept
			 A concept () can be added to Workplace by dragging the name of the concept from one of the following views.
			
			 
			
				Find Terms view.
				Navigate Terms view
			
			 
			 
			Modifier
			 A modifier () can be added to Workplace by dragging the name of the modifier from one of the following views.
			
			 
			
				Find Terms view.
				Navigate Terms view
			
			 
			 
			Patient Set 
			A Patient set () can be added to Workplace by dragging the name of the patient set from the following view.
			
			 
			
				Previous Query view.
			
			 
			 
			Encounter Set 
			An Encounter set () can be added to Workplace by dragging the name of the encounter set from the following view.
			
			 
			
				Previous Query view.
			
			 
			 
			Previous Query
			A previous query () 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.
		 
		
		 
		 
		
			
				
					NOTE: 
					For detailed information on how to search for terms, please see the i2b2 Find Terms help.
					
				
			
		
		 
		 
		
		Add Folder / Concept From Find Terms View
		 
		
			In the Find Terms view, search for the item(s) you want to add.
			Highlight the folder () or concept () by clicking on its name.
			
			While holding the left mouse button down, drag the item over to the Workplace view.
			Drop the item into either your workplace folder or the shared folder.
			 
			
			 
			 
			The item will now display in the Workplace view with the same name.
			 
			
		
		 
		 
		 
		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.
		
		 
		
		 
		 
		
			
				
					NOTE: 
					How the items are grouped and displayed is dependent on how the database is setup.
					
				
			
		
		 
		 
		Add Folder / Concept From Navigate Terms View
		 
		
			In the Navigate Terms view, expand the folder(s) that contains the concept or grouping of concepts you want to add.
			
			Highlight the folder () or concept () by clicking on its name.
			
			While holding the left mouse button down, drag the item over to the Workplace view.
			Drop the item into either your workplace folder or the shared folder.
			 
			
			 
			 
			The item will now display in the Workplace view with the same name.
			 
			
		
		 
		 
		 
		 
		Add Modifier Folders and Modifiers to Workplace View
		 
		Find Terms View
		The Find Terms view provides a way to search for a particular concept.
		 
		
		 
		 
		
			
				
					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
		 
		
			In the Find Terms view, search for the item(s) you want to add.
			Highlight the modifier folder () or modifier () by clicking on its name.
			
			While holding the left mouse button down, drag the item over to the Workplace view.
			Drop the item into either your workplace folder or the shared folder.
			 
			
			 
			 
			The item will now display in the Workplace view with the same name.
			 
			
		
		 
		 
		 
		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.
		
		 
		
		 
		 
		
			
				
					NOTE: 
					How the items are grouped and displayed is dependent on how the database is setup.
					
				
			
		
		 
		 
		Add Modifier Folder / Modifier From Navigate Terms View
		 
		
			In the Navigate Terms view, expand the folder(s) that contains the modifiers or grouping of modifiers you want to add.
			
			Highlight the modifier folder () or modifier () by clicking on its name.
			
			While holding the left mouse button down, drag the item over to the Workplace view.
			Drop the item into either your workplace folder or the shared folder.
			 
			
			 
			 
			The item will now display in the Workplace view with the same name.
			 
			
		
		 
		 
		 
		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
		
		 
		
		 
		 
		Add Previous Query From Previous Query View
		 
		
			Highlight the previous query () by clicking on the name of the query.
			
			While holding the left mouse button down, drag the item   to the Workplace view.
			Drop the previous query into either your workplace folder or the shared folder.
			 
			
			 
			 
			The previous query will now appear in the workplace with the same name.
			 
			
		
		 
		 
		Add Patient Set From Previous Query View
		 
		
			Click on the plus sign () next to the name of the previous query that contains the patient set.
			
			Click on the plus sign () next to the results folder.
			
			Highlight the Patient set () by clicking on its name.
			
			While holding the left mouse button down, drag the Patient Set to the Workplace view.
			
			Drop the patient set into either your workplace folder or the shared folder.
			 
			
			 
			 
			The patient set will now appear in the workplace.
			 
			
		
		 
		 
		 
		Add Encounter Set From Previous Query View
		 
		
			Click on the plus sign () next to the name of the previous query that contains the encounter set.
			
			Click on the plus sign () next to the results folder.
			
			Highlight the Encounter set () by clicking on its name.
			
			While holding the left mouse button down, drag the Encounter Set to the Workplace view.
			
			Drop the encounter set into either your workplace folder or the shared folder.
			 
			
			 
			 
			The encounter set will now appear in the workplace.
			 
			
		
		 
		 
		 
		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.
		
		 
		
			Ontology Folder
			An ontology folder () 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.
						
					
				
			
			 
			 
			Modifier Folder
			A modifier folder () 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.
			
			 
			 
			Concept
			 A concept () 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.
			
			 
			 
			Modifier
			 A modifier () 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.
			
			 
			 
			Previous Query
			A previous query () 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.
			
			 
			 
			Patient Set 
			A specific set of patients can be added to other views by dragging the Patient set  () from Workplace to one of the following view.
			
			 
			
				Query Tool view; drop in the panel.
			
			 
			 
			Encounter Set 
			A specific set of encounters (visit list) can be added to the other views by dragging the Encounter set () 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 view and dropping it into one of the panels in the Query Tool view.
		
		 
		Add Folder to Query Tool View
		 
		
			Highlight the folder () by clicking on the name of the folder.
			
			While holding the left mouse button down, drag the item over to the Query Tool view.
			Drop the item into the panel labeled Group 1.
			 
			
			 
			 
			The folder will now display in the panel for Group 1.
			 
			
		
		 
		 
		Add Concept to Query Tool View
		 
		
			Highlight the concept () by clicking on the name of the folder.
			
			While holding the left mouse button down, drag the item over to the Query Tool view.
			Drop the item into the panel labeled Group 1.
			 
			
			 
			 
			The concept will now display in the panel for Group 1.
			 
			
		
		 
		 
		 
		 
		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
		
			Highlight the modifier () by clicking on the name of the modifier.
			
			While holding the left mouse button down, drag the item over to the Query Tool view.
			Drop the item into the panel labeled Group 1.
			 
			
			 
			 
			The name of the concept associated to the modifier plus the modifier will now display in the panel for Group 1.
			
			 
			
		
		 
		 
		 
		Using Previous Query
		A 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 field
				The 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 ()  and temporal queries ().
					
				
			
		
		 
		 
		 
		Add Previous Query to Query Name (New Query)
		 
		
			Highlight the previous query ( / ) by clicking on the name of the query.
			
			While holding the left mouse button down, drag the item  to the Query Tool view.
			Drop the item into the Query Name field.
			 
			
			 
			 
			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.
			
			 
			
		
		 
		 
		
			
				
					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)
		 
		
			Highlight the previous query ( / ) by clicking on the name of the query.
			
			While holding the left mouse button down, drag the item  to the Query Tool view.
			Drop the item into the panel labeled Group 1.
			 
			
			
			 
			 
			The previous query will now display in the panel for Group 1.
			 
			
		
		 
		 
		 
		Using Patient Set
		A 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
		
			In the Workplace  view, expand the folder(s) that contains the list of patients you want to add.
			
			Highlight the Patient set () by clicking on its name.
			
			While holding the left mouse button down, drag the item over to the Query Tool view
			Drop the item into the panel labeled Group 1.
			 
			
			 
			 
			The item will now display in the panel for Group 1.
			 
			
		
		 
		 
		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
		
			In the Workplace  view, expand the folder(s) that contains the list of patients you want to add.
			
			Highlight the Encounter set () by clicking on its name.
			
			While holding the left mouse button down, drag the item over to the Query Tool view
			Drop the item into the panel labeled Group 1.
			 
			
			 
			 
			The item will now display in the panel for Group 1.
Query Name field	The 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.