<p>The <b>Find Terms view</b> is designed to allow users to search for concepts. Users can search by the name or by a particular code. Once the appropriate concept is found it can be used in many of the i2b2 views and plug-ins, such as the <i>Query Tool view</i>.
<p>This section describes the layout and contents of this view.</p>
<p> </p>
<h3><a name="ftLayout" id="ftLayout"></a>Layout of the Find Terms View</h3>
<p>The <b>Find Terms view</b> allows users to search for a concept, group of concepts, and their associated modifiers. There are basically two methods of searching available;(1) by name and (2) by code.
<p class=NoteParagraph>Regardless of how you search for the concept the layout of both tabs is the same.</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h4><a name="ftSearchOptions" id="ftSearchOptions"></a>Search by Options</h4>
<p>This section has two tabs; one is to <b>Search by Name</b> and the other <b>Search by Code</b>. Depending on which tab is active will determine which search method is used to find the concept.
<p>The qualifier is used to tell the system whether or not you are looking for an exact match or just a partial match. There are four different options to choose from.
<p>The clinical vocabulary that resides in the Ontology Management Cell was partially built using terminology from several standard coding systems. These codes can be used to search for a particular term (see section on <i>Search by Code</i>). The following are some examples of standard coding systems.
</p>
<p> </p>
<h4><a name="ftIcd9" id="ftIcd9"></a>ICD-9</h4>
<ul>
<li>International Classification of Diseases, 9th Revision</li>
<li>Primarily used for disease surveillance, immunization rates and environmental monitoring.</li>
<li>Maintained by the National Center for Health Statistics (NCHS) and Centers for Medicare and Medicaid Services (CMS).
<li>Logical Observation Identifiers Names and Codes</li>
<li>Primarily used for Clinical Health Information (CHI) such as laboratory and clinical test results, history and physicals, discharge summaries, operative notes, tumor registry and nursing observations.
</li>
<li>Licensed and maintained by Regenstrief Institute.</li>
<h3><a name="ftModLayout" id="ftModLayout"></a>Layout of the Find Modifiers Section of Find Terms View</h3>
<p>An additional section called <b>Find Modifiers </b> is located at the bottom of the <i>Find Terms view</i>. This section is only visible once you find a term and select to find the modifiers from the pop-up menu (see section on Finding Modifiers).
<p>The functionality of finding modifiers is very similar to finding terms in that you can search by name or by code and you can define the search criteria to be used when performing the search.
<p>The qualifier is used to tell the system whether or not you are looking for an exact match or just a partial match. There are four different options to choose from.
<h3><a name="ftExpCollFolder" id="ftExpCollFolder"></a>Expand / Collapse a Folder</h3>
<p>Depending on the search criteria, the results section may display groups of concepts which are contained in folders as well as individual concepts. The folders can be expanded to see the listing of concepts in that grouping by clicking on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> or negative sign <span style="color:#CCCCCC">(<img src="images/minusSign.png" alt="minusSign" />)</span> next to the folder icon.
</p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>The ability to expand and collapse folders also extends to the modifier result section which can contain modifiers.
</p>
</td>
</tr>
</table>
<p> </p>
<h4><a name="ftExpFolder" id="ftExpFolder"></a>Expand (Open) a Folder</h4>
<ol>
<li>Click on the <b>plus sign</b> <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the folder in the results section of <i>Find Terms view</i> or the Modifier folder in the <i>Find Modifiers section</i>.
</li>
<li>The folder will open and all the items in the folder will display.</li>
</ol>
<p> </p>
<h4><a name="ftCollFolder" id="ftCollFolder"></a>Collapse (Close) a Folder</h4>
<ol>
<li>Click on the <b>negative sign</b> <span style="color:#CCCCCC">(<img src="images/minusSign.png" alt="minusSign" />)</span> next to the folder in the results section of <i>Find Terms view</i> or the Modifier folder in the <i>Find Modifiers section</i>.
</li>
<li>The folder will close and all the items in the folder will no longer display.</li>
<p>Users can define how many concepts to display and whether or not to show hidden terms and/or synonyms. The display options are set in the Find Terms Options dialog window, which can be accessed by clicking on the <b>Show Options button</b> <span style="color:#CCCCCC">(<img src="images/options.png" alt="options" />)</span>.
<h4><a name="ftDisplayMax" id="ftDisplayMax"></a>Maximum to Display</h4>
<p>The <b>Maximum number of children to display</b> is used when retrieving the search results to be displayed in the results section of the <b>Find Terms view</b>. Once the maximum number is reached a message will appear informing you that the query has reached the maximum number of terms and suggests you try searching again with a more specific query. Running a search with a more specific query will narrow your results as the selection criteria will not be as broadly defined.
<p>In the metadata table, an attribute is set to determine whether or not a term is active, inactive or hidden. If an item is marked as hidden it will not appear in the list of terms. Selecting <b>Show Hidden Terms</b> will display those items marked to be hidden. For easy identification, hidden terms will be <span style="color:#FF0000">red</span> when displayed in the results list.
<p>Some terms may be flagged in the metadata table as a synonym of another term. Selecting <b>Show Synonymous Terms</b> will display both the original term and the synonym in the <i>Find Terms view</i>. For easy identification, synonymous terms will be <span style="color:#000099">blue</span> when displayed in the results list.
<p>The <b>Enable patient counts</b> option will display the total number of patients that have an observation fact entered for that item.
</p>
<p> </p>
<p> </p>
<h4><a name="ftUseShortTooltips" id="ftUseShortTooltips"></a>Use Short Tooltips</h4>
<p>By default, the tooltip that displays when you hover over an item will contain the entire path name and the tooltip that is specific to that item. Enabling the <b>Use short tooltips</b> option will only display the tooltip information; the path will not be included.
</p>
<p> </p>
<p> </p>
<h4><a name="ftShowConceptCd" id="ftShowConceptCd"></a>Show Concept Codes in Tooltips</h4>
<p>In addition to showing the tooltip, this option will also display the concept_cd associated to the item.
<p>This section describes how to search for a term using one of
the two available methods; (1) Search by Name and (2) Search by Code.
</p>
<p> </p>
<p>Regardless of whether you are searching by name or by code, the first step in entering the search criteria is defining a qualifier. The first field is the “qualifier” and it is a drop-down list with four options:
</p>
<p> </p>
<p></p>
<ol>
<li>Starting with</li>
<p>The results returned will contain only those terms whose name or code begins with the text entered in the search box.
</p>
<p> </p>
<li>Ending with</li>
<p>The results returned will contain only those terms whose name or code ends with the text entered in the search box.
</p>
<p> </p>
<li>Containing</li>
<p>The results returned will be those terms whose name or code ends with the text entered in the search box.
</p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>This search will return the broadest range of results.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<li>Exact</li>
<p>The results returned will be those terms whose name or code matches exactly to the text entered in the search box.
</p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>This search will return the narrowest range of results.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
</ol>
<h3><a name="ftSearchName" id="ftSearchName"></a>Search by Name</h3>
<p>The method of searching by the name is exactly what it sounds like; you can search for a concept by its name.
</p>
<p> </p>
<h4><a name="ftSearchNameStart" id="ftSearchNameStart"></a>Search Using "Starting with"</h4>
<p> </p>
<ol>
<li>Click on the <b>drop-down arrow</b> located in the qualifier field.</li>
<li>To narrow your search to a particular category, click on the <b>drop-down arrow</b> in the <i>category selection box</i>. Otherwise, accept the default of Any Category.
<li>To narrow your search to a particular category, click on the <b>drop-down arrow</b> in the <i>category selection box</i>. Otherwise, accept the default of Any Category.
<li>To narrow your search to a particular category, click on the <b>drop-down arrow</b> in the <i>category selection box</i>. Otherwise, accept the default of Any Category.
<li>To narrow your search to a particular category, click on the <b>drop-down arrow</b> in the <i>category selection box</i>. Otherwise, accept the default of Any Category.
<h3><a name="ftSearchCode" id="ftSearchCode"></a>Search by Code</h3>
<p>Some of the concepts have a standard code associated with them. This code can be used to search for a specific concept or a grouping of concepts.
</p>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>The steps listed in this section walk you through a code search using LOINC codes. These same steps can be used when doing a search of any type of code. In step 4, replace LOINC with the coding system you want to search.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<h4><a name="ftSearchLoinc" id="ftSearchLoinc"></a>Search Using LOINC Code</h4>
<p> </p>
<ol>
<li>In the text box enter the code for the term you are searching on.</li>
<p>A modifier is associated with a single term or a group of terms. Therefore in order to search for a modifier you must first search for the term. Once the term is found you can begin the process of finding the modifier. Overall the process of finding modifiers is very similar to searching for a term; you can search by name or by code.
</p>
<p> </p>
<p>Regardless of whether you are searching by name or by code, the first step in entering the search criteria is defining a qualifier. The first field is the “qualifier” and it is a drop-down list with four options:
</p>
<p> </p>
<p> </p>
<ol>
<li>Starting with</li>
<p>The results returned will contain only those modifiers whose name or code begins with the text entered in the search box.
</p>
<p> </p>
<li>Ending with</li>
<p>The results returned will contain only those modifiers whose name or code ends with the text entered in the search box.
</p>
<p> </p>
<li>Containing</li>
<p>The results returned will be those modifiers whose name or code ends with the text entered in the search box.
</p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>This search will return the broadest range of results.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<li>Exact</li>
<p>The results returned will contain only those modifiers whose name or code matches exactly to the text entered in the search box.
</p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>This search will return the narrowest range of results.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
</ol>
<h3><a name="ftModSearchName" id="ftModSearchName"></a>Find Modifiers by Name</h3>
<p>The method of searching by the name is exactly what it sounds like; you can search for a modifier by its name.
</p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>As stated above you must first search for the term before you can find the associated modifiers.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h4><a name="ftModSearchNameStart" id="ftModSearchNameStart"></a>Search Modifiers Using "Starting with"</h4>
<p> </p>
<ol>
<li>Search for your term by either name or code.</li>
<li>Using the <i>right mouse button</i>, click on the name of the <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> or <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="folder" />)</span>.
<h4><a name="ftModSearchNameEnd" id="ftModSearchNameEnd"></a>Search Modifiers Using "Ending with"</h4>
<p> </p>
<ol>
<li>Search for your term by either name or code.</li>
<li>Using the <i>right mouse button</i>, click on the name of the <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> or <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="folder" />)</span>.
<h4><a name="ftModSearchNameContain" id="ftModSearchNameContain"></a>Search Modifiers Using "Containing"</h4>
<p> </p>
<ol>
<li>Search for your term by either name or code.</li>
<li>Using the <i>right mouse button</i>, click on the name of the <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> or <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="folder" />)</span>.
<h4><a name="ftModSearchNameExact" id="ftModSearchNameExact"></a>Search Modifiers Using "Exact"</h4>
<p> </p>
<ol>
<li>Search for your term by either name or code.</li>
<li>Using the <i>right mouse button</i>, click on the name of the <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> or <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="folder" />)</span>.
<h3><a name="ftModSearchCode" id="ftModSearchCode2"></a>Find Modifiers by Code</h3>
<p>Some of the modifiers have a standard code associated with them. This code can be used to search for a specific modifier or a grouping of modifiers.
</p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>As stated above you must first search for the term before you can find the associated modifiers.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h4><a name="ftModSearchCode" id="ftModSearchCode2"></a>Search by Modifier Code</h4>
<p> </p>
<ol>
<li>Search for your term by either name or code.</li>
<li>Using the <i>right mouse button</i>, click on the name of the <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> or <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="folder" />)</span>.
<h3><a name="ftModSearchGetAll" id="ftModSearchGetAll"></a>Find All Modifiers</h3>
<p>In the Find Modifiers section of the Find Terms view there is a Get All button. This button will return all the modifiers associated to a term.
</p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>As stated above you must first search for the term before you can find the associated modifiers.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h4><a name="ftModSearchCode" id="ftModSearchCode3"></a>Get All Modifiers</h4>
<p> </p>
<ol>
<li>Search for your term by either name or code.</li>
<li>Using the <i>right mouse button</i>, click on the name of the <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> or <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="folder" />)</span>.
<p>Individual as well as groups of concepts and modifiers can be dragged and dropped (copied) from the Find Terms View to other views in the i2b2 Web Client.
</p>
<p> </p>
<ol>
<li>Folder</li>
<p>A <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" width="16" height="18" alt="folder" />)</span> and all its concepts (children) can be added to other views by dragging the folder name from <b>Find Terms</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool View;</b> drop in the <i>panel</i></li>
<li><b>Workplace View;</b> drop in a <i>user</i> or <i>shared folder</i></li>
</ul>
<p> </p>
<p> </p>
<li>Modifier Folder</li>
<p>A <b>modifier folder</b> <span style="color:#CCCCCC">(<img src="images/modifierfolder.png" width="16" height="18" alt="folder" />)</span> and all its concepts (children) can be added to other views by dragging the folder name from <b>Find Terms</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool View;</b> drop in the <i>panel</i></li>
<li><b>Workplace View;</b> drop in a <i>user</i> or <i>shared folder</i></li>
</ul>
<p> </p>
<p> </p>
<li>Concept</li>
<p>A <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> can be added to other views by dragging the name of the concept from <b>Find Terms</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool View;</b> drop in the <i>panel</i></li>
<li><b>Workplace View;</b> drop in a <i>user</i> or <i>shared folder</i></li>
</ul>
<p> </p>
<p> </p>
<li>Modifier</li>
<p>A <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" />)</span> can be added to other views by dragging the name of the modifier from <b>Find Terms</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool View;</b> drop in the <i>panel</i></li>
<li><b>Workplace View;</b> drop in a <i>user</i> or <i>shared folder</i></li>
</ul>
</ol>
<p> </p>
<p> </p>
<p> </p>
<h3><a name="ftAddToQt" id="ftAddToQt"></a>Add to Query Tool View</h3>
<p>A folder, individual concept, or modifier can be added to the query tool view by simply dragging the item from <b>Find Terms view</b> and dropping it into one of the panels in the <b>Query Tool view</b>.
</p>
<p> </p>
<p> </p>
<h4><a name="ftAddFolderToQt" id="ftAddFolderToQt"></a>Add Folder to Query Tool View</h4>
<ol>
<li>Highlight the <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" width="16" height="18" alt="folder" />)</span> by clicking on the name of the folder.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b>.</li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<h4><a name="ftAddConceptToQt" id="ftAddConceptToQt"></a>Add Concept to Query Tool View</h4>
<ol>
<li>Highlight the <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" width="16" height="17" />)</span> by clicking on the name of the concept.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b>.</li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<h4><a name="ftAddModToQt" id="ftAddModToQt"></a>Add Modifier to Query Tool View</h4>
<ol>
<li>Highlight the <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" width="16" height="17" />)</span> by clicking on the name of the modifier.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b>.</li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<h3><a name="ftAddToWp" id="ftAddToWp"></a>Add to Workplace View</h3>
<p>Information in the workplace is related to the most common concepts and queries that an individual uses and in essence becomes their personal workplace.
<h4><a name="ftAddFolderToWp" id="ftAddFolderToWp"></a>Add Folder to Workplace View</h4>
<p> </p>
<ol>
<li>Highlight the <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" width="16" height="18" alt="folder" />)</span> by clicking on the name of the folder.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Workplace view</b>.</li>
<li>Drop the item into either your workplace folder or the shared folder.</li>
<h4><a name="ftAddModToWp" id="ftAddModToWp"></a>Add Modifier to Workplace View</h4>
<p> </p>
<ol>
<li>Highlight the <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="leaf" />)</span> by clicking on the name of the modifier.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Workplace view</b>.</li>
<li>Drop the item into either your workplace folder or the shared folder.</li>
<p>The Navigate Terms view is designed to display the i2b2 vocabulary concepts that are maintained in the <b>Ontology Management Cell</b> of the <b>i2b2 Hive</b>. These concepts are used in many of the i2b2 views and plug-ins, such as the <i>Query Tool view</i>.
<p>This section describes the layout and contents of this view.</p>
<p> </p>
<h3><a name="ntLayout" id="ntLayout"></a>Layout of the Navigate Terms View</h3>
<p>The <b>Navigate Terms view</b> displays the terms listed in the metadata table(s). These terms are grouped (categorized) with other similar items. These groupings are displayed in a hierarchal tree that can be expanded to view all the concepts and modifiers in the associated category.
<p>As stated above, the <b>Navigate Terms view</b> is hierarchical display of the concepts and modifiers in the metadata table(s). The modifiers will always appear with their associated concept.
</p>
<p> </p>
<p>There are several branches or components of the tree that display.</p>
<p>A <b>container</b> <span style="color:#CCCCCC">(<img src="images/container.png" width="16" height="18" alt="container" />)</span> has other folders, concepts and / or modifiers. It can be expanded and collapsed by clicking on the <i>plus sign</i> <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" width="11" height="11" />) </span>or <i>minus sign</i> <span style="color:#CCCCCC">(<img src="images/minusSign.png" alt="minusSign" width="9" height="9" />)</span> next to it. It can not be dragged to other views.
<p>A <b>modifier container</b> <span style="color:#CCCCCC">(<img src="images/modifierContainer.png" width="16" height="18" alt="modifierContainer" />)</span> has other modifier folders and / or modifiers. It can be expanded and collapsed by clicking on the <i>plus sign</i> <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" width="11" height="11" />) </span>or <i>minus sign</i> <span style="color:#CCCCCC">(<img src="images/minusSign.png" alt="minusSign" width="9" height="9" />)</span> next to it. It can not be dragged to other views.
<p>A <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" width="16" height="18" alt="folder" />)</span> contains other folders, concepts and / or modifiers. It can be expanded and collapsed by clicking on the <i>plus sign</i> <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" width="11" height="11" />) </span>or <i>minus sign</i> <span style="color:#CCCCCC">(<img src="images/minusSign.png" alt="minusSign" width="9" height="9" />)</span> next to it. It can also be dragged to other views.
<p>A <b>modifier folder</b> <span style="color:#CCCCCC">(<img src="images/modifierFolder.png" width="16" height="18" alt="modifierFolder" />)</span> contains other modifier folders and / or modifiers. It can be expanded and collapsed by clicking on the <i>plus sign</i> <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" width="11" height="11" />) </span>or <i>minus sign</i> <span style="color:#CCCCCC">(<img src="images/minusSign.png" alt="minusSign" width="9" height="9" />)</span> next to it. It can also be dragged to other views.
<p>The <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" width="16" height="17" />)</span> is the lowest level of the hierarchy and cannot be expanded further.
<p>The <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" width="16" height="17" />)</span> is the lowest level of the hierarchy and cannot be expanded further.
<h3><a name="ntExpCollFolder" id="ntExpCollFolder"></a>Expand / Collapse a Folder</h3>
<p>Users can expand or collapse a folder by clicking on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> or negative sign <span style="color:#CCCCCC">(<img src="images/minusSign.png" alt="minusSign" />)</span> next to the folder icon.
</p>
<p> </p>
<h4><a name="ntExpFolder" id="ntExpFolder"></a>Expand (Open) a Folder</h4>
<ol>
<li>Click on the <b>plus sign</b> <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the folder in the <i>Navigate Terms view.</i>
</li>
<li>The folder will open and all the items in the folder will display.</li>
</ol>
<p> </p>
<h4><a name="ntCollFolder" id="ntCollFolder"></a>Collapse (Close) a Folder</h4>
<ol>
<li>Click on the <b>negative sign</b> <span style="color:#CCCCCC">(<img src="images/minusSign.png" alt="minusSign" />)</span> next to the folder in the <i>Navigate Terms view.</i>
</li>
<li>The folder will close and all the items in the folder will display.</li>
<p>Users can define how many concepts to display and whether or not to show hidden terms and/or synonyms. The display options are set in the Navigate Terms Options dialog window, which can be accessed by clicking on the <b>Show Options button</b> <span style="color:#CCCCCC">(<img src="images/options.png" alt="options" />)</span>.
<h4><a name="ntDisplayMax" id="ntDisplayMax"></a>Maximum to Display</h4>
<p>The <b>Maximum number of children to display</b> is used when expanding a folder in the <b>Navigate Terms view</b>. Once the maximum number is reached a message will appear informing you that you have reached the maximum and continuing to retrieve all the concepts in the list may affect performance. You will have the option to continue or to cancel the action.
<p>In the metadata table, an attribute is set to determine whether or not a term is active, inactive or hidden. If an item is marked as hidden it will not appear in the list of terms. Selecting <b>Show Hidden Terms</b> will display those items marked to be hidden. For easy identification, hidden terms will be <span style="color:#FF0000">red</span> when displayed in the results list.
<p>Some terms may be flagged in the metadata table as a synonym of another term. Selecting <b>Show Synonymous Terms</b> will display both the original term and the synonym in the <i>Find Terms view</i>. For easy identification, synonymous terms will be <span style="color:#000099">blue</span> when displayed in the results list.
<p>The <b>Enable patient counts</b> option will display the total number of patients that have an observation fact entered for that item.
</p>
<p> </p>
<p> </p>
<h4><a name="ntUseShortTooltips" id="ntUseShortTooltips"></a>Use Short Tooltips</h4>
<p>By default, the tooltip that displays when you hover over an item will contain the entire path name and the tooltip that is specific to that item. Enabling the <b>Use short tooltips</b> option will only display the tooltip information; the path will not be included.
</p>
<p> </p>
<p> </p>
<h4><a name="ntShowConceptCd" id="ntShowConceptCd"></a>Show Concept Codes in Tooltips</h4>
<p>In addition to showing the tooltip, this option will also display the concept_cd associated to the item.
<p>Individual as well as groups of concepts can be dragged and dropped (copied) from the Navigate Terms view to other views in the i2b2 Web Client.
</p>
<p> </p>
<ol>
<li>Folder</li>
<p>A <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" width="16" height="18" alt="folder" />)</span> and all its concepts (children) can be added to other views by dragging the folder name from <b>Navigate Terms</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i>.</li>
<li><b>Workplace view;</b> drop in a <i>user</i> or <i>shared folder</i></li>
</ul>
<p> </p>
<p> </p>
<li>Modifier Folder</li>
<p>A <b>modifier folder</b> <span style="color:#CCCCCC">(<img src="images/modifierFolder.png" width="16" height="18" alt="modifierFolder" />)</span> and all its concepts (children) can be added to other views by dragging the modifier folder name from <b>Navigate Terms</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i>.</li>
<li><b>Workplace view;</b> drop in a <i>user</i> or <i>shared folder</i></li>
</ul>
<p> </p>
<p> </p>
<li>Concept</li>
<p> A <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" width="16" height="17" />)</span> can be added to other views by dragging the name of the concept from <b>Navigate Terms</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i>.</li>
<li><b>Workplace view;</b> drop in a <i>user</i> or <i>shared folder</i></li>
</ul>
<p> </p>
<p> </p>
<li>Modifier</li>
<p> A <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" width="16" height="17" />)</span> can be added to other views by dragging the name of the modifier from <b>Navigate Terms</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i>.</li>
<li><b>Workplace view;</b> drop in a <i>user</i> or <i>shared folder</i></li>
</ul>
</ol>
<p> </p>
<h3><a name="ntAddToQt" id="ntAddToQt"></a>Add to Query Tool View</h3>
<p>A folder, individual concept, or modifier can be added to the query tool view by simply dragging the item from <b>Navigate Terms view</b> and dropping it into one of the panels in the <b>Query Tool view</b>.
</p>
<h4><a name="ntAddFolderToQt" id="ntAddFolderToQt"></a>Add Folder to Query Tool View</h4>
<ol>
<li>Highlight the <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" width="16" height="18" alt="folder" />)</span> by clicking on the name of the folder.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b>.</li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<h4><a name="ntAddConceptToQt" id="ntAddConceptToQt"></a>Add Concept to Query Tool View</h4>
<ol>
<li>Highlight the <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" width="16" height="17" />)</span> by clicking on the name of the concept.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b>.</li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<h4><a name="ntAddModToQt" id="ntAddModToQt"></a>Add Modifier to Query Tool View</h4>
<ol>
<li>Highlight the <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" width="16" height="17" />)</span> by clicking on the name of the modifier.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b>.</li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<h3><a name="ntAddToWp" id="ntAddToWp"></a>Add to Workplace View</h3>
<p>Information in the workplace is related to the most common concepts and queries that an individual uses and in essence becomes their personal workplace.
<h4><a name="ntAddFolderToWp" id="ntAddFolderToWp"></a>Add Folder to Workplace View</h4>
<ol>
<li>Highlight the <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" width="16" height="18" alt="folder" />)</span> by clicking on the name of the folder.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Workplace view</b>.</li>
<li>Drop the item into either your workplace folder or the shared folder.</li>
<h4><a name="ftAddModToWp" id="ftAddModToWp"></a>Add Modifier to Workplace View</h4>
<p> </p>
<ol>
<li>Highlight the <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="leaf" />)</span> by clicking on the name of the modifier.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Workplace view</b>.</li>
<li>Drop the item into either your workplace folder or the shared folder.</li>
<p>The <b>Previous Query view</b> is designed to display the most recent queries run by a user. The results associated to the query are also available for viewing.
<p>This section describes the layout and contents of the <b>Previous Query view</b>.</p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
There are two types of queries that can be run in the i2b2 Web Client;
</p>
<ol>
<li class=NoteParagraph>
A standard i2b2 query <span style="color:#CCCCCC">(<img src="images/prevQuery.png" alt="previousQuery" />)</span>
</li>
<li class=NoteParagraph>
A Temporal query <span style="color:#CCCCCC">(<img src="images/iconTemporalQry.png" alt="temporalQuery" />)</span>
</li>
</ol>
<p class=NoteParagraph> </p>
<p class=NoteParagraph>
Both of these types of queries will appear in the Previous Query view and throughout this document they will both be referred to as a "Previous query".
</p>
<p class=NoteParagraph> </p>
<p class=NoteParagraph>
For more detailed information on the distinction of these two types of queries please see the Query Tool help.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h3><a name="pqLayout" id="pqLayout"></a>Layout of the Previous Query View</h3>
<p>A <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.png" alt="previousQuery" /> / <img src="images/iconTemporalQry.png" alt="temporalQuery"/>)</span> is created when a query is run from the <i>Query Tool</i>.
The query is stored and displayed in the <b>Previous Query view</b>. These previous queries can be used to run new queries or to easily populate other views.
<p>The query in the previous query view is comprised of multiple hierarchical levels that can be seen by expanding each level of the tree. These levels are outlined below.
<p>The name of the previous query is the top level of the hierarchal tree and is comprised of these three components.
</p>
<p> </p>
<p> </p>
<ol>
<li><b>Query Name</b> - the name given at the time the query was created. The default name contains an abbreviated description and the time the query was run.
</li>
<li><b>Date</b> - the date the query was created.</li>
<li><b>User Id</b> - the user who created (ran) the query.</li>
<p>The <b>Results folder</b> <span style="color:#CCCCCC">(<img src="images/pqResultsFolder.png" alt="pqResultsFolder" width="16" height="16" />)</span> contains the results of the query. To see the query results simply expand the folder by clicking on the <i>plus sign</i> <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> located next to the result name.
<p>The results associated with a <b>previous query</b> are determined by the <b>query result type(s)</b> that are selected when the query is run in the <b>Query Tool view</b>.
<p>The <b>Patient set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> appears if <i>Patient set</i> or <i>Timeline</i> was checked at the time the query was run. The set contains all the patients who met the defined search criteria.
<p>The <b>Encounter Set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> appears if <i>Encounter set</i> was checked at the time the query was run. The set contains all the patients whose encounters met the defined search criteria.
<h5><a name="pqPtCount" id="pqPtCount"></a>Number of Patients</h5>
<p>The <b>Number of Patients</b> <span style="color:#CCCCCC">(<img src="images/ptCount.png" alt="ptCount" />)</span> appears if <i>Number of Patients</i> was checked at the time the query was run. The results are a total count for those patients who met the defined criteria.
<p>The <b>Gender patient breakdown</b> <span style="color:#CCCCCC">(<img src="images/ptBreakdowns.png" alt="ptBreakdowns" />)</span> appears if <i>Gender patient breakdown</i> was checked at the time the query was run. The results are a breakdown by gender for those patient who met the defined criteria.
<h5><a name="pqVitals" id="pqVitals"></a>Vital Status Patient Breakdown</h5>
<p>The <b>Vital Status patient breakdown</b> <span style="color:#CCCCCC">(<img src="images/ptBreakdowns.png" alt="ptBreakdowns" />)</span> appears if <i>Vital Status patient breakdown</i> was checked at the time the query was run. The results are a breakdown by vital status for those patient who met the defined criteria.
<p>The <b>Race patient breakdown</b> <span style="color:#CCCCCC">(<img src="images/ptBreakdowns.png" alt="ptBreakdowns" />)</span> appears if <i>Race patient breakdown</i> was checked at the time the query was run. The results are a breakdown by race for those patient who met the defined criteria.
<p>The <b>Age patient breakdown</b> <span style="color:#CCCCCC">(<img src="images/ptBreakdowns.png" alt="ptBreakdowns" />)</span> appears if <i>Age patient breakdown</i> was checked at the time the query was run. The results are a breakdown by age for those patient who met the defined criteria.
<li>Click on the <b>OK button</b> to delete the query</li>
<p> </p>
</ol>
<p> </p>
<p> </p>
<table id=warning>
<tr>
<td>
<p class=WarningHeading>WARNING: </p>
<p class=WarningParagraph>
Once you click on Delete, the previous query will be removed from the view and there is no way to restore it. Therefore you need to make sure you want to remove it from the list.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h3><a name="pqRefresh" id="pqRefresh"></a>Refresh the List</h3>
<p>Users can refresh the list of previous queries from the list by selecting <b>Refresh All</b> from the <i>pop-up menu</i>.
</p>
<p> </p>
<ol>
<li>Using the <i>right mouse button</i>, click on any of the previous queries in the list.</li>
<p>Users can define how many previous queries to display and the order in which they will appear in the list. The display options are set in the Options for Previous Queries window, which can be accessed by clicking on the <b>Show Options button</b> <span style="color:#CCCCCC">(<img src="images/options.png" alt="options" />)</span>.
<h4><a name="ptDisplayMax" id="ptDisplayMax"></a>Maximum to Display</h4>
<h5><a name="pqDisplayMaxQueries" id="pqDisplayMaxQueries"></a>Queries to Display</h5>
<p>The <b>Maximum number of queries to display</b> defines how many previous queries will be visible in the <b>Previous Query view</b>. Once the maximum number is reached the oldest query will no longer appear in the view.
</p>
<p> </p>
<p> </p>
<table id=tip>
<tr>
<td>
<p class=TipHeading>TIP: </p>
<p class=TipParagraph>
Recommendation: Use the Workplace view to save those previous queries that will be used often. In addition to being more convenient it will also prevent you from loosing a common query if the maximum number to display has been reached.
<h5><a name="pqSortDate" id="pqSortDate"></a>Sort by Create Date</h5>
<p>Selecting to sort <b>By Create Date</b> will sort the queries in the <b>Previous Query view</b> by the date and time the query was created. Once you select to sort by the creation date, you need to define whether or not it will be in ascending or descending order.
</p>
<p> </p>
<p><b>Ascending:</b> displays the <i>oldest</i> query <i>first</i>.</p>
<p> </p>
<p><b>Descending:</b> displays the <i>newest</i> query <i>first</i>.</p>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
Renaming a query will not affect the sort order as the date and time is stored with the previous query.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<h5><a name="pqSortName" id="pqSortName"></a>Sort by Name</h5>
<p>Selecting to sort <b>By Query Name</b> will sort the queries in the <b>Previous Query view</b> alphabetically by the name of the query. Once you select to sort by name, you need to define whether or not it will be in ascending or descending order.
</p>
<p> </p>
<p><b>Ascending:</b> queries are displayed in alphabetical order with the <i>beginning</i> of the <i>alphabet</i> at the <i>beginning</i> of the list. (A to Z)
</p>
<p> </p>
<p><b>Descending: </b>queries are displayed in alphabetical order with the <i>beginning</i> of the <i>alphabet</i> at the <i>end</i> of the list. (Z to A)
</p>
<p> </p>
<h2><a name="pqUsePq" id="pqUsePq"></a>Using a Previous Query</h2>
<p>This section describes how to use a previous query.</p>
<p>Different parts of the previous query can be dragged and dropped (copied) from the <b>Previous Query view</b> to other views in the i2b2 Web Client.
</p>
<p> </p>
<p> </p>
<ol>
<li>Previous Query</li>
<p>Associated with each <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.png" alt="previousQuery" /> / <img src="images/iconTemporalQry.png" alt="temporalQuery"/>)</span> are the items used to run the query, any constraints that were defined, and the results. A previous query can be added to other views by dragging the previous query name from <b>Previous Query view</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i> or <i>Query Name</i>.</li>
<li><b>Workplace view;</b> drop in a <i>user</i> or <i>shared folder</i></li>
</ul>
<p> </p>
<p> </p>
<li>Patient Set</li>
<p> A specific set of patients can be added to other views by dragging the <b>Patient set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> from <b>Previous Query view</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i>.</li>
<li><b>Workplace view;</b> drop in a <i>user</i> or <i>shared folder</i></li>
</ul>
<p> </p>
<p> </p>
<li>Encounter Set</li>
<p> A specific set of encounters (visit list) can be added to other views by dragging the <b>Encounter Set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> from <b>Previous Query view</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i>.</li>
<li><b>Workplace view;</b> drop in a <i>user</i> or <i>shared folder</i></li>
</ul>
</ol>
<p> </p>
<p> </p>
<h3><a name="pqAddToQt" id="pqAddToQt"></a>Add to Query Tool View</h3>
<p>The Query Tool view is designed to simplify the process of retrieving information from the database associated to the i2b2 Web Client.
<p>Within the <b>Previous Query view</b> there are several items that can be used in the Query Tool view to run a query. The following sections explain how to add the previous query, patient set and encounter set to the Query Tool view.
</p>
<p> </p>
<p> </p>
<h4><a name="pqAddPqToQt" id="pqAddPqToQt"></a>Add Previous Query to Query Tool View</h4>
<p> </p>
<p>Within the Query Tool view, a previous query can be added to one of the following two locations.</p>
<td>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.
</td>
</tr>
<tr>
<td><b>Panel (Group)</b></td>
<td>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.
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h4><a name="pqAddPqToQtNew" id="pqAddPqToQtNew"></a>Add Previous Query to the Query Name (New Query)</h4>
<p> </p>
<ol>
<li>Highlight the <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.png" alt="previousQuery" /> / <img src="images/iconTemporalQry.png" alt="temporalQuery"/>)</span> by clicking on the name of the query.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item to the <b>Query Tool view</b>.</li>
<li>Drop the item into the <b>Query Name field</b>.</li>
<li>The item(s) associated with the previous query will display in the appropriate group(s), the name of the query will appear at <b>Query Name</b>, and any constraints that were defined when the original query was run will now default with the new query.
When you run the query it will receive a new name. This is to distinguish the first previous query from the second.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h4><a name="pqAddPqToQtPanel" id="pqAddPqToQtPanel"></a>Add Previous Query to the Query Name (Query-in-Query)</h4>
<p> </p>
<ol>
<li>Highlight the <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.png" alt="previousQuery" /> / <img src="images/iconTemporalQry.png" alt="temporalQuery"/>)</span> by clicking on the name of the query.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item to the <b>Query Tool view</b>.</li>
<li>Drop the item into the <b>Query Name field</b>.</li>
<h4><a name="pqAddPtSetToQt" id="pqAddPtSetToQt"></a>Add Patient Set to the Query Tool View</h4>
<p> </p>
<ol>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the name of the previous query that contains the patient set.
</li>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the results folder.
</li>
<li>Highlight the <b>Patient set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the item into the<strong> </strong><b>panel</b> labeled <b>Group 1</b>.</li>
<h4><a name="pqAddEncSetToQt" id="pqAddEncSetToQt"></a>Add Encounter Set to the Query Tool View</h4>
<p> </p>
<ol>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the name of the previous query that contains the encounter set.
</li>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the results folder.
</li>
<li>Highlight the <b>Encounter set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the item into the<strong> </strong><b>panel</b> labeled <b>Group 1</b>.</li>
<h3><a name="pqAddToWp" id="pqAddToWp"></a>Add to Workplace View</h3>
<p>Information in the workplace is related to the most common concepts and queries that an individual uses and in essence becomes their personal workplace.
<h4><a name="pqAddPqToWp" id="pqAddPqToWp"></a>Add Previous Query to Workplace View</h4>
<ol>
<li>Highlight the <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.png" alt="previousQuery" /> / <img src="images/iconTemporalQry.png" alt="temporalQuery"/>)</span> by clicking on the name of the query.
</li>
<li>While holding the <i>left mouse button</i> down, drag the previous query name to the <b>Workplace view</b>.
</li>
<li>Drop the previous query into either your workplace folder or the shared folder.</li>
<h4><a name="pqAddPtSetToWp" id="pqAddPtSetToWp"></a>Add Patient Set to Workplace View</h4>
<ol>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the name of the previous query that contains the patient set.
</li>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the results folder.
</li>
<li>Highlight the <b>Patient set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the <b>Patient set</b> to the <b>Workplace view</b>.
</li>
<li>Drop the Patient set into either your workplace folder or the shared folder.</li>
<h4><a name="pqAddPtSetToWp" id="pqAddPtSetToWp2"></a>Add Encounter Set to Workplace View</h4>
<ol>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the name of the previous query that contains the encounter set.
</li>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the results folder.
</li>
<li>Highlight the <b>Encounter Set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the <b>Encounter set</b> to the <b>Workplace view</b>.
</li>
<li>Drop the encounter set into either your workplace folder or the shared folder.</li>
<p>This section describes the layout and contents of this view.</p>
<p> </p>
<p> </p>
<h3><a name="qtLayout" id="qtLayout"></a>Layout of the Query Tool View</h3>
<p>The <b>Query Tool view</b> is used to define and run a "select query" that will retrieve information from the database associated to the i2b2 Web Client.
<p>The name of a query will be assigned when it is run and will display in the <b>Query Name</b> field.
</p>
<p> </p>
<p>The only time a query name will appear prior to running the query is when you drag a <b>previous query</b> from either the<b> Previous Query</b> or <b>Workplace views</b> and drop it into the Query Name field.
<p>A panel is the section of the Query Tool view that contains information about a group of concepts. The panel can be broken down into the following sections.
<p>The content in the information box will change depending on whether or not a term is listed in the panel / group.
</p>
<p> </p>
<ol>
<li>No term(s) listed</li>
<ul>
<li>The message will appear as "<b>drop a term on here</b>"</li>
<li>The color of the box will be yellow</li>
</ul>
<p> </p>
<p> </p>
<li>Term(s) listed</li>
<ul>
<li>The message will appear as "<b>one or more of these</b>"</li>
<li>The color of the box will be green</li>
<li>An additional information box will appear between panels</li>
</ul>
</ol>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
Once you add an item to a panel, an additional information box will appear between the two panels containing the text "AND". This is to indicate that each panel will be joined with an AND operator when the SQL query is created.
<p>On the toolbar for the Query Tool there is a single button for running and canceling a query. Depending on the circumstances defined below the label on this button and its associated action will change to one of the following: (1) <b>Run Query</b> or (2) <b>Cancel Query</b>.
<p>Once you start running a query, the label will change to <b>Cancel Query</b>. Clicking on the button when it says <b>Cancel Query</b> will cancel the query and free up the Query Tool / Web client so that you can continue to do other things.
</p>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
Clicking on Cancel Query in the Query Tool will only cancel the web client piece of the process. The server side will continue to run.
<p>The <b>Clear button</b> will reset the view to the default; this includes deleting the concepts listed in the panel and removing any constraint that have been defined.
<h3><a name="qtStatusView" id="qtStatusView"></a>Query Status View</h3>
<p>The <b>Query Status view</b> is located below the <i>Query Tool view</i> and contains information regarding the status of a query that is either running or has just finished as well as the results of a previous query.
<p>Once the query has finished, the number of patients meeting the search criteria will appear in this view. You will also see the length of time it took to retrieve the requested information. This is a display only view.
<p>Users can define how long to wait before a query will time out. This setting is defined in the <i>Query Tool Options</i>, which can be accessed by clicking on the <b>Show Options button</b> <span style="color:#CCCCCC">(<img src="images/options.png" alt="options" />)</span>.
<p>The default setting is 180 seconds, which means the web client will wait for a response from the server for 180 seconds. Once it reaches that time it will display a message saying the query has timed out and will continue to run in the background.
</p>
<p> </p>
<p> </p>
<p> </p>
<h2><a name="qtCreateQuery" id="qtCreateQuery"></a>Creating a Query</h2>
<p>This section describes the process of adding items to the query tool, "AND" / "OR" operators and setting constraints.
<p>In order to create your query, you will need to define what information will be retrieved from the databases. Selected items from other i2b2 Web Client views can be dragged and dropped (copied) into the <b>Query Tool view</b>.
</p>
<p> </p>
<ol>
<li>Concepts</li>
<p><b>Concepts</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> can be defined as terms, results, providers, etc. They can be added as a group (folder <span style="color:#CCCCCC">(<img src="images/folder.png" alt="folder" />)</span>) or individually by dragging the item(s) from <b>Navigate Terms</b>, <b>Find Terms</b>, and <b>Workplace views</b>.
</p>
<p> </p>
<p> </p>
<li>Modifiers</li>
<p><b>Modifiers</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="leaf" />)</span> are associated with a concept or group of concepts. They can be added as a group ( modifier folder <span style="color:#CCCCCC">(<img src="images/modifierFolder.png" alt="folder" />)</span>) or individually by dragging the item(s) from <b>Navigate Terms</b>, <b>Find Terms</b>, and <b>Workplace views</b>.
</p>
<p> </p>
<p> </p>
<li>Previous Query</li>
<p>A new query can be created from one that has already been run by dragging the <b>previous query </b><span style="color:#CCCCCC">(<img src="images/prevQuery.jpg" alt="prevQuery" />)</span> from <b>Previous Query</b> and <b>Workplace</b> views.
</p>
<p> </p>
<p> </p>
<li>Patient Set</li>
<p>A <b>patient set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="leaf" />)</span> can be can be used in a query by dragging the patient set from <b>Previous Query</b> and <b>Workplace</b> views . When you run the query it will use the patient set to query against<b></b>.
</p>
<p> </p>
<p> </p>
<li>Encounter Set</li>
<p> An <b>encounter set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="leaf" />)</span> can be used in a query by dragging the patient set from <b>Previous Query</b><b></b> and <b>Workplace views</b>. When you run the query it will use the encounter set to query against.
<p>There are two operators, known as <b>SQL Logical Operators</b>, which are necessary when running a query that has more than one item. These operators provide a way to specify exactly what you want to retrieve. The operators are the '<b>AND</b>' and '<b>OR</b>' operators.
</p>
<p> </p>
<p> </p>
<table id=important>
<tr>
<td>
<p class=ImportantHeading>IMPORTANT: </p>
<p class=ImportantParagraph>
The query tool knows which operator to use based on the panels used when defining the query. It is important to verify you are setting up your query correctly as each operator will return different results.
<p>The <b>AND operator</b> returns a record if both the first condition <i>and</i> the second conditions are true.
</p>
<p> </p>
<p>The query tool uses the AND operator when concepts are listed in different panels.</p>
<p> </p>
<p><i>Example:</i></p>
<p> </p>
<p><b>WHAT:</b> Return only those patients who have Acute Myocardial Infarction <b>AND</b> Angina Pectoris.
</p>
<p> </p>
<p><b>HOW:</b> In the query tool add the concept Acute Myocardial Infarction to <i><b>Group 1</b></i> and then add the concept Angina Pectoris to <i><b>Group 2</b></i>.
</p>
<p> </p>
<p><b>RESULT:</b> The population is limited by requiring the patients fulfill both requirements.</p>
<h5><a name="qtAddConceptFromNt" id="qtAddConceptFromNt"></a>Add Concept From Navigate Terms View</h5>
<p> </p>
<ol>
<li>In the <b>Navigate Terms view</b>, expand the folder(s) that contains the concept or grouping of concepts you want to add.
</li>
<li>Highlight the <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> or <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="Folder" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
For detailed information on how to search for terms, please see the i2b2 Find Terms help.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h5><a name="qtAddConceptFromFt" id="qtAddConceptFromFt"></a>Add Concept From Find Terms View</h5>
<p> </p>
<ol>
<li>In the <b>Find Terms view</b>, search for the item(s) you want to add.</li>
<li>Highlight the <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> or <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="Folder" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<p>Information in the <b>workplace</b> is related to the most common concepts, modifiers, and queries that an individual uses and in essence becomes their personal workplace.
<h5><a name="qtAddConceptFromWp" id="qtAddConceptFromWp"></a>Add Concept From Workplace View</h5>
<p> </p>
<ol>
<li>In the <b>Workplace view</b>, expand the folder(s) that contains the concept or grouping of concepts you want to add.
</li>
<li>Highlight the <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> or <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="Folder" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<h5><a name="qtAddModFromNt" id="qtAddModFromNt"></a>Add Modifier From Navigate Terms View</h5>
<p> </p>
<ol>
<li>In the <b>Navigate Terms view</b>, expand the folder(s) that contains the modifier or grouping of grouping of modifiers you want to add.
</li>
<li>Highlight the <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" />)</span> or <b>modifier folder</b> <span style="color:#CCCCCC">(<img src="images/modifierFolder.png" alt="Folder" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
For detailed information on how to search for terms and modifiers, please see the i2b2 Find Terms help.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h5><a name="qtAddModFromFt" id="qtAddModFromFt"></a>Add Modifier From Find Terms View</h5>
<p> </p>
<ol>
<li>In the <b>Find Terms view</b>, search for the term(s) and modifier you want to add.</li>
<li>Highlight the <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" />)</span> or <b>modifier folder</b> <span style="color:#CCCCCC">(<img src="images/modifierFolder.png" alt="Folder" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<p>Information in the <b>workplace</b> is related to the most common concepts, modifiers, and queries that an individual uses and in essence becomes their personal workplace.
<h5><a name="qtAddModFromWp" id="qtAddModFromWp"></a>Add Modifier From Workplace View</h5>
<p> </p>
<ol>
<li>In the <b>Workplace view</b>, expand the folder(s) that contains the modifier or grouping of modifiers you want to add.
</li>
<li>Highlight the <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" />)</span> or <b>modifier folder</b> <span style="color:#CCCCCC">(<img src="images/modifierFolder.png" alt="Folder" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<p>A <b>previous query</b> 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 <i>Query Tool view</i> simply drag the query name from one of the following views.
</p>
<p> </p>
<ul>
<li> Previous Query view</li>
<li> Workplace view</li>
</ul>
<p> </p>
<p>Within the Query Tool view, the previous query can be added to one of the following two locations.</p>
<td>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.
</td>
</tr>
<tr>
<td><b>Panel (Group)</b></td>
<td>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.
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p>How to add a previous query from each of the views listed above is explained in the next few sections.
<h5><a name="qtAddPqFromPq" id="qtAddPqFromPq"></a>Add Previous Query From Previous Query View (New Query)</h5>
<ol>
<li>In the <b>Previous Query view</b> highlight the <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.jpg" alt="prevQuery" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the previous query into the<strong> </strong><b>Query Name</b>.</li>
<li>The item(s) associated with the previous query will display in the appropriate group(s), the name of the query will appear at <b>Query Name</b>, and any constraints that were defined when the original query was run will now default with the new query.
When you run the query it will receive a new name. This is to distinguish the first previous query from the second.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h5><a name="qtAddPqFromPqPanel" id="qtAddPqFromPqPanel"></a>Add Previous Query From Previous Query View (Query-in-Query)</h5>
<ol>
<li>In the <b>Previous Query view</b> highlight the <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.jpg" alt="prevQuery" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the previous query into the<strong> </strong><b>panel</b> labeled <b>Group 1</b>.</li>
<p>Information in the workplace is related to the most common concepts, modifiers, and queries that an individual uses and in essence becomes their personal workplace.
<h5><a name="qtAddPqFromWp" id="qtAddPqFromWp"></a>Add Previous Query From Workplace View (New Query)</h5>
<p> </p>
<ol>
<li>In the <b>Workplace view</b>, expand the folder(s) that contains the previous query you want to add.
</li>
<li>Highlight the <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.jpg" alt="prevQuery" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the previous query into the <b>Query Name</b>.</li>
<li>The item(s) associated with the previous query will display in the appropriate group(s), the name of the query will appear at <b>Query Name</b>, and any constraints that were defined when the original query was run will now default with the new query.
When you run the query it will receive a new name. This is to distinguish the first previous query from the second.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h5><a name="qtAddPqFromPqPanel" id="qtAddPqFromPqPanel"></a>Add Previous Query From Workplace View (Query-in-Query)</h5>
<ol>
<li>In the <b>Workplace view</b>, expand the folder(s) that contains the previous query you want to add.
</li>
<li>Highlight the <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.jpg" alt="prevQuery" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the previous query into the<strong> </strong><b>panel</b> labeled <b>Group 1</b>.</li>
<h5><a name="qtAddPtListFromPq" id="qtAddPtListFromPq"></a>Add Patient Set From Previous Query View</h5>
<ol>
<li>In the <b>Previous Query view</b> click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the name of the previous query that contains the patient set.
</li>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the results folder.
</li>
<li>Highlight the <b>Patient set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the item into the<strong> </strong><b>panel</b> labeled <b>Group 1</b>.</li>
<p>Information in the workplace is related to the most common concepts, modifiers, and queries that an individual uses and in essence becomes their personal workplace.
<h5><a name="qtAddEncFromPq" id="qtAddEncFromPq"></a>Add Encounter Set From Previous Query View</h5>
<ol>
<li>In the <b>Previous Query view</b> click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the name of the previous query that contains the patient set.
</li>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the results folder.
</li>
<li>Highlight the <b>Encounter set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the item into the<strong> </strong><b>panel</b> labeled <b>Group 1</b>.</li>
<p>Information in the workplace is related to the most common concepts, modifiers, and queries that an individual uses and in essence becomes their personal workplace.
<p>On the toolbar at the bottom of the view, there are additional navigational buttons that will become active when more than three panels are being used.
<p>There are three options for removing a concept from the <b>Query Tool view</b>. Users can (1) reset all the groups, (2) clear all items in a panel, or (3) delete an individual item from the group.
<li>All the groups will be reset, the temporal constraint will return to the default setting, and the query name will be removed (if one exists).
</li>
</ol>
<p> </p>
<p> </p>
<table id=warning>
<tr>
<td>
<p class=WarningHeading>WARNING: </p>
<p class=WarningParagraph>
Once you click on the clear button, all items in every group; and the constraints will be removed, therefore you need to make sure you want to delete ALL items.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h4><a name="qtClearPanel" id="qtClearPanel"></a>Clear Items in a Panel / Group</h4>
<p> </p>
<ol>
<li>Click on the <b>Delete button <span style="color:#CCCCCC">(<img src="images/buttonDelete.png" alt="delete" />)</span> </b> located in the top right corner of the panel (next to the Group name)<i></i>.
</li>
<li>The group will be reset.</li>
</ol>
<p> </p>
<p> </p>
<table id=warning>
<tr>
<td>
<p class=WarningHeading>WARNING: </p>
<p class=WarningParagraph>
Once you click on the delete button, all items in every group; and the constraints will be removed, therefore you need to make sure you want to delete ALL items.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h4><a name="qtDeleteItem" id="qtDeleteItem"></a>Delete Single Item</h4>
<p> </p>
<ol>
<li>Using the <i>right mouse button</i>, click on the name of the item to be removed.</li>
<p><b>Constraints</b> are used to narrow down the search criteria to a particular time frame, number of occurrences or a specific value or range of values. In i2b2, there are several types of constraints that can be defined in the Query Tool view.
<td>Constraint is defined on the query level and utilizes the patient encounters and / or instance number when determining eligibility.
</td>
</tr>
<tr>
<td>Panel Timing</td>
<td>Constraint is defined on the panel level and utilizes the patient encounters and / or instance number when determining eligibility.
</td>
</tr>
<tr>
<td>Date</td>
<td>Constraint uses a date range when determining eligibility.</td>
</tr>
<tr>
<td>Occurrence</td>
<td>Constraint is by the number of occurrences an item is documented.</td>
</tr>
<tr>
<td>Exclusion</td>
<td>Constraint will not include patients with the concepts listed in the panel.</td>
</tr>
<tr>
<td>Value</td>
<td>Constraint is by the value associated to a concept or modifier. Not all items have values.</td>
</tr>
</table>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
In the client, the value constraints are currently the only ones that directly correspond to a single concept. All others are defined on the query or panel level.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h4><a name="qtTempPanelConstraints" id="qtTempPanelConstraints"></a>Temporal and Panel Timing Constraints</h4>
<p>Both temporal and panel constraints are very similar in that both utilize the visit / encounter information along with the concepts defined to determine if a patient meets the search criteria.
</p>
<p> </p>
<p>The main difference between a <b>temporal</b> and a <b>panel timing constraint</b> is that temporal constraints are defined at the <i>query level</i> and panel timing constraints are defined at the <i>panel level</i>.
<p>Users can select one of three available options:</p>
<p> </p>
<ol>
<li>Treat all groups independently</li>
<ul>
<li>The items (facts) can occur at <b>any time</b> in the patient's history.</li>
</ul>
<p> </p>
<p> </p>
<li>Selected items occur in the same financial encounter</li>
<ul>
<li>The items (facts) occur during the <b>same visit</b> (financial encounter).</li>
</ul>
<p> </p>
<p> </p>
<li>Items instance will be the same</li>
<ul>
<li>The items (facts) occur during the <b>same visit</b> (financial encounter) <i>AND</i> the <b>same instance</b>.
</li>
<li>Can only be selected if a modifier is listed in a panel.</li>
</ul>
</ol>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
In order to be considered the same instance, the facts have to have the same patient number, encounter number, concept, provider, start date, and instance number.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h6><a name="qtTempConstraintAnyVisit" id="qtTempConstraintAnyVisit"></a>Treat All Groups Independently</h6>
<p> </p>
<ul>
<li><i>Panel timing constraint</i> will default to <b>Treat Independently</b></li>
<li><i>Panel timing constraint</i> can not be changed</li>
<li>Items defined in the panels can occur at <b>any time</b> in the patients history</li>
<p>Patient has a medication with a dose greater than 500 mg <i><b>and</b></i> a medication that is taken once a day documented at <i><b>any time</b></i> in their history.
<p><b>RESULTS:</b> there are 47 patients who have had a medication with a dose of 500 mg and a frequency of once a day entered as a fact in the observation_fact table, where medication dose and frequency have the <i><u>same</u></i> <b>patient_num</b>.
<p>Patient has a medication with a dose greater than 500 mg <i><b>and</b></i> a medication that is taken once a day documented during the <i><b>same visit</b></i>.
<p><b>RESULTS:</b> there are 41 patients who have had a medication with a dose of 500 mg and a frequency of once a day entered as a fact in the observation_fact table, where the medication dose and frequency have the <i><u>same</u></i> <b>encounter_num</b>.
<p>Patient has a medication with a dose greater than 500 mg <i><b>and</b></i> a medication that is taken once a day documented during the <i><b>same instance</b></i>.
<p><b>RESULTS:</b> there are 36 patients who have had a medication with a dose of 500 mg and a frequency of once a day entered as a fact in the observation_fact table, where the medication dose and frequency have the <i><u>same</u></i> <b>encounter_num</b> , <b>concept_cd</b>, <b>provider_id</b>, <b>start_date</b>, <i>AND</i> <b>instance_num</b>.
<p>As stated in the previous section the <b>Panel Timing Constraint</b> is defined at the <i>panel level</i> and can only be changed when the <i>temporal constraint</i> is defined as <b>Selected groups occur in the same financial encounter</b> or <b>Items instance will be the same</b>.
</p>
<p> </p>
<p> </p>
<p>Users can select one of three available options:</p>
<p> </p>
<ol>
<li>Treat all groups independently</li>
<ul>
<li>The items (facts) can occur at <b>any time</b> in the patient's history.</li>
</ul>
<p> </p>
<p> </p>
<li>Selected items occur in the same financial encounter</li>
<ul>
<li>The items (facts) occur during the <b>same visit</b> (financial encounter).</li>
<li>Temporal constraint has to be set to Same financial encounter in order to be available for selection.
</li>
</ul>
<p> </p>
<p> </p>
<li>Items instance will be the same</li>
<ul>
<li>The items (facts) occur during the <b>same visit</b> (financial encounter) <i>AND</i> the <b>same instance</b>.
</li>
<li>Temporal constraint has to be set to Items instance will be the same in order to be available for selection.
</li>
</ul>
</ol>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
In order to be considered the same instance, the facts have to have the same patient number, encounter number, concept, provider, start date, and instance number.
<p>In the example shown below, the items (facts) listed in the panel for Group 1 can occur at <i>any time</i> in the patient's history while the items in Group 2 and 3 have to occur during the <i>same visit</i>.
</p>
<p> </p>
<p><b>Example:</b></p>
<p>Patient has a diagnosis of Acute MI documented at <b><i>any time</i></b> in their history and they have a medication with a dose greater than 500 mg <b><i>and</i></b> a medication that is taken once a day documented during the <b><i>same visit</i></b>.
<p><b>RESULTS:</b> there are 4 patients who have had a medication with a dose greater than 500 mg and a frequency of once a day entered as a fact in the observation_fact table, where the medication dose and frequency have the <i><u>same</u></i> <b>encounter_num</b> <i>AND</i> the diagnosis of acute MI, the medication dose and frequency all have the <i><u>same</u></i> <b>patient_num</b>
<p>In the example shown below, the items (facts) listed in the panel for Group 1 can occur at <i>any time</i> in the patient's history while the items in Group 2 and 3 have to occur during the <i>same instance</i>.
</p>
<p> </p>
<p><b>Example:</b></p>
<p>Patient has a diagnosis of Acute MI documented at <b><i>any time</i></b> in their history and they have a medication with a dose greater than 500 mg <b><i>and</i></b> a medication that is taken once a day documented during the <b><i>same instance</i></b>.
<p><b>RESULTS:</b> there are 3 patients who have had a medication with a dose of 500 mg and a frequency of once a day entered as a fact in the observation_fact table, where the medication dose and frequency have the <i><u>same</u></i> <b>encounter_num</b> , <b>concept_cd</b>, <b>provider_id</b>, <b>start_date</b>, <i>AND</i> <b>instance_num</b> <i>AND</i> the diagnosis of acute MI, the medication dose and frequency all have the <i><u>same</u></i> <b>patient_num</b>
<p>In this example, if a patient has a diagnosis of Acute Myocardial Infarction (MI) entered on their record from 01/01/2001 to 12/31/2005 then their data will be included. If the patient does have an MI diagnosis but it was entered prior to 01/01/2001 or after 12/31/2005 then their information will not be included.
</p>
<p> </p>
<p> </p>
<p> </p>
<h6><a name="qtDateConstraintSetFromTo" id="qtDateConstraintSetFromTo"></a>Setting the Date Constraint (FROM / TO Date Range)</h6>
<p> </p>
<ol>
<li>Click on the <b>Dates button</b> located in the selection criteria section of the panel.</li>
<li>Click the <b>check box</b> next to the date in the <b>From box</b>.</li>
<li>At this point there are two methods of entering your <i>starting</i> date.</li>
<ol type="a">
<li>Manually type it in the text box.</li>
<li>Click on the <b>drop-down arrow</b> <span style="color:#CCCCCC">(<img src="images/dropDownArrow.png" alt="dropDownArrow" />)</span> to open the calendar view and click on the desired date.
<p>In this example, if a patient has a diagnosis of Acute Myocardial Infarction (MI) entered on their record any time on or after 01/01/2001 then their data will be included. If the diagnosis was entered prior to 01/01/2001 then it will not be included.
</p>
<p> </p>
<p></p>
<h6><a name="qtDateConstraintSetFrom" id="qtDateConstraintSetFrom"></a>Setting the Date Constraint (FROM Date only)</h6>
<p> </p>
<ol>
<li>Click on the <b>Dates button</b> located in the selection criteria section of the panel.</li>
<li>Click the <b>check box</b> next to the date in the <b>From box</b>.</li>
<li>At this point there are two methods of entering your <i>starting</i> date.</li>
<ol type="a">
<li>Manually type it in the text box.</li>
<li>Click on the <b>drop-down arrow</b> <span style="color:#CCCCCC">(<img src="images/dropDownArrow.png" alt="dropDownArrow" />)</span> to open the calendar view and click on the desired date.
<p>In this example, if a patient has a diagnosis of Acute Myocardial Infarction (MI) entered on their record prior to and including 12/31/2005 then their data will be included. If the diagnosis was entered after 12/31/2005 then it will not be included.
</p>
<p> </p>
<p> </p>
<p> </p>
<h6><a name="qtDateConstraintSetTo" id="qtDateConstraintSetTo"></a>Setting the Date Constraint (TO Date only)</h6>
<p> </p>
<ol>
<li>Click on the <b>Dates button</b> located in the selection criteria section of the panel.</li>
<li>Click the <b>check box</b> next to the date in the <b>To box</b>.</li>
<li>At this point there are two methods of entering your <i>ending</i> date.</li>
<ol type="a">
<li>Manually type it in the text box.</li>
<li>Click on the <b>drop-down arrow</b> <span style="color:#CCCCCC">(<img src="images/dropDownArrow.png" alt="dropDownArrow" />)</span> to open the calendar view and click on the desired date.
<p>Value constraints can be associated with concept and modifiers but not all of them will have values. For instance, the diagnosis of Acute Myocardial Infarction does not have a value but the tests used to make the diagnosis do have values (high, low, numeric, etc.).
</p>
<p> </p>
<p>For those items that do have values there are different types of values that may be associated with it.
</p>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
The different types of constraints and how they work are the same regardless of whether or not it is associated with a concept or a modifier.
<p><b>Flags</b> are defined in the source system when the value is entered. The following are some examples that can be found in the i2b2 Demo database.
</p>
<p> </p>
<ul>
<li>High</li>
<li>Low</li>
<li>Abnormal</li>
</ul>
<p> </p>
<p> </p>
<p> </p>
<h6><a name="qtFlagValueConstraintSetConcept" id="qtFlagValueConstraintSetConcept"></a>Setting the Value Constraint (Flag) for a Concept</h6>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
The value constraint window will open automatically when you drop a concept into a panel in the Query Tool view. This will only happen if the concept is set up in the database with XML metadata. The first three steps can be used if you did not add a value constraint when you added the item or if you wish to edit an existing item.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<ol>
<li>Using the <i>right mouse button</i>, click on the item listed in the panel.</li>
<h6><a name="qtFlagValueConstraintSetModifier" id="qtFlagValueConstraintSetModifier"></a>Setting the Value Constraint (Flag) for a Modifier</h6>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
The modifier value constraint window will open automatically when you drop a modifier into a panel in the Query Tool view. This will only happen if the modifier is set up in the database with XML metadata. The first three steps can be used if you did not add a value constraint when you added the item or if you wish to edit an existing item.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<ol>
<li>Using the <i>right mouse button</i>, click on the item listed in the panel.</li>
<p>The<b> text value</b> is defined in the source system when the value is entered. The following are some examples that can be found in the i2b2 Demo database.
</p>
<p> </p>
<ul>
<li>Test Not Performed</li>
<li>Borderline</li>
<li>Positive</li>
</ul>
<p> </p>
<p> </p>
<p> </p>
<h6><a name="qtTextValueConstraintSetConcept" id="qtTextValueConstraintSetConcept"></a>Setting the Value Constraint (Text) for a Concept</h6>
<p> </p>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
The value constraint window will open automatically when you drop a concept into a panel in the Query Tool view. This will only happen if the concept is set up in the database with XML metadata. The first three steps can be used if you did not add a value constraint when you added the item or if you wish to edit an existing item.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<ol>
<li>Using the <i>right mouse button</i>, click on the item listed in the panel.</li>
To select more than one you can hold down the <Ctrl> key while clicking on each name. On the Macintosh you can hold down the command key instead of the <Ctrl> key.
<h6><a name="qtTextValueConstraintSetModifier" id="qtTextValueConstraintSetModifier"></a>Setting the Value Constraint (Text) for a Modifier</h6>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
The modifier value constraint window will open automatically when you drop a modifier into a panel in the Query Tool view. This will only happen if the modifier is set up in the database with XML metadata. The first three steps can be used if you did not add a value constraint when you added the item or if you wish to edit an existing item.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<ol>
<li>Using the <i>right mouse button</i>, click on the item listed in the panel.</li>
<li>A pop-up menu will open.</li>
<li>Select <b>Set Modifier Value</b> from the list.</li>
To select more than one you can hold down the <Ctrl> key while clicking on each name. On the Macintosh you can hold down the command key instead of the <Ctrl> key.
<p>The <b>numeric value</b> is defined in the source system when the result is entered. The following are some example formats that can be found in the i2b2 Demo database.
</p>
<p> </p>
<ul>
<li>200</li>
<li>1.3</li>
</ul>
<p> </p>
<p> </p>
<p>Unlike flag and text values, numeric values use operators, such as greater than or less than when setting the constraints. The following is a listing of operators currently in use.
<td>Any value less than or equal to the number entered (inclusive).</td>
</tr>
<tr>
<td>Equal To (=)</td>
<td>An exact match to the number entered.</td>
</tr>
<tr>
<td>Between</td>
<td>Any value in the range of numbers entered.</td>
</tr>
<tr>
<td>Greater Than (>)</td>
<td>Any value greater than the number entered.</td>
</tr>
<tr>
<td>Greater Than or Equal To (>=)</td>
<td>Any value greater than or equal to the number entered (inclusive).</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h6><a name="qtNumValueConstraintSetConcept" id="qtNumValueConstraintSetConcept"></a>Setting the Value Constraint (Numeric) for a Concept</h6>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
The value constraint window will open automatically when you drop a concept into a panel in the Query Tool view. This will only happen if the concept is set up in the database with XML metadata. The first three steps can be used if you did not add a value constraint when you added the item or if you wish to edit an existing item.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<p></p>
<ol>
<li>Using the <i>right mouse button</i>, click on the item listed in the panel.</li>
<h6><a name="qtNumValueConstraintSetModifier" id="qtNumValueConstraintSetModifier"></a>Setting the Value Constraint (Numeric) for a Modifier</h6>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
The modifier value constraint window will open automatically when you drop a modifier into a panel in the Query Tool view. This will only happen if the modifier is set up in the database with XML metadata. The first three steps can be used if you did not add a value constraint when you added the item or if you wish to edit an existing item.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<p></p>
<ol>
<li>Using the <i>right mouse button</i>, click on the item listed in the panel.</li>
<li>A pop-up menu will open.</li>
<li>Select <b>Set Modifier Value</b> from the list.</li>
<h5><a name="qtNumValueConstraintUnits" id="qtNumValueConstraintUnits"></a>Using Units In Value Constraints</h5>
<p>Units in regards to i2b2 are the standard units of measurement associated with a value. For instance, a medication may have "mg" listed as the unit for the dose, while a HGB lab test may have "gm/dL".
</p>
<p> </p>
<p>The units are defined in the source system and although it is recommended that all numerical facts are stored in normalized units it is recognized that this is not always feasible. Therefore, the Web Client has the ability to convert the units when running a query.
</p>
<p> </p>
<p>In order for this feature to work a parameter called CRC_ENABLE_UNITCD_CONVERSION must be defined for the project. If this is not defined you need to contact your system administrator.
</p>
<p> </p>
<p> </p>
<p> </p>
<h6><a name="qtNumValueConstraintUnitsSet" id="qtNumValueConstraintUnitsSet"></a>Defining the Units When Running a Query</h6>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
The modifier value constraint window will open automatically when you drop a modifier into a panel in the Query Tool view. This will only happen if the modifier is set up in the database with XML metadata. The first three steps can be used if you did not add a value constraint when you added the item or if you wish to edit an existing item.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<ol>
<li>Using the <i>right mouse button</i>, click on the item listed in the panel.</li>
<li>A pop-up menu will open.</li>
<li>Select <b>Set Modifier Value</b> from the list.</li>
<p>In the above scenario, the normal units are "mg". When setting up the value constraint the units were changed to "gm" and the numerical value was set to 5. Upon saving the value constraint, the Web Client converted 5 gm to 5000 mg. When the query is run it will look at those facts that have both 5 gm and 5000 mg defined in the observation_fact table.
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
The unit conversion information is specific to the term and is defined in the i2b2 metadata table.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h2><a name="qtRunningQuery" id="qtRunningQuery"></a>Running a Query</h2>
<p> </p>
<p>This section describes the process of running a query and the output.</p>
<p>When you run a query you need to select what type of result the server will return. There are several <b>result types</b> available, each of which will yield a different output.
<p>This option will return a set of encounters for those patients who meet the defined criteria and will display the appropriate information in the following views.
</p>
<p> </p>
<ol>
<li><b>Query Status View</b></li>
<p> </p>
<ul>
<li>The encounter set information will appear as soon as the query has finished running.</li>
<li>It will also appear in this view when you drag a previous query to the <i>Query Name field</i> in the <b>Query Tool view</b>.
<h4><a name="qtResultTypePtCount" id="qtResultTypePtCount"></a>Number of Patients</h4>
<p> </p>
<p>This option will return a total count for those patients who meet the defined criteria and will display the appropriate information in the following views.
</p>
<p> </p>
<ol>
<li><b>Query Status View</b></li>
<p> </p>
<ul>
<li>The patient count information will appear as soon as the query has finished running.</li>
<li>It will also appear in this view when you drag a previous query to the <i>Query Name field</i> in the <b>Query Tool view</b>.
<p>This option will return a breakdown by gender for those patients who meet the defined criteria and will display the appropriate information in the following views.
</p>
<p> </p>
<ol>
<li><b>Query Status View</b></li>
<p> </p>
<ul>
<li>The information for the gender patient breakdown will appear as soon as the query has finished running.
</li>
<li>It will also appear in this view when you drag a previous query to the <i>Query Name field</i> in the <b>Query Tool view</b>.
<h4><a name="qtResultTypeVitalStatus" id="qtResultTypeVitalStatus"></a>Vital Status Patient Breakdown</h4>
<p> </p>
<p>This option will return a breakdown by vital status for those patients who meet the defined criteria and will display the appropriate information in the following views.
</p>
<p> </p>
<ol>
<li><b>Query Status View</b></li>
<p> </p>
<ul>
<li>The information for the vital status patient breakdown will appear as soon as the query has finished running.
</li>
<li>It will also appear in this view when you drag a previous query to the <i>Query Name field</i> in the <b>Query Tool view</b>.
<p>This option will return a breakdown by race for those patients who meet the defined criteria and will display the appropriate information in the following views.
</p>
<p> </p>
<ol>
<li><b>Query Status View</b></li>
<p> </p>
<ul>
<li>The information for the race patient breakdown will appear as soon as the query has finished running.
</li>
<li>It will also appear in this view when you drag a previous query to the <i>Query Name field</i> in the <b>Query Tool view</b>.
<p>This option will return a breakdown by age for those patients who meet the defined criteria and will display the appropriate information in the following views.
</p>
<p> </p>
<ol>
<li><b>Query Status View</b></li>
<p> </p>
<ul>
<li>The information for the age patient breakdown will appear as soon as the query has finished running.
</li>
<li>It will also appear in this view when you drag a previous query to the <i>Query Name field</i> in the <b>Query Tool view</b>.
<p>Once the query criterion has been defined, the final steps are to click on the <b>Run Query button</b>, select the result type(s), and click on the <b>OK button</b> to run the query.
</p>
<p> </p>
<ol>
<li>Once you have defined the search criteria click on the <b>Run Query button</b> located on the toolbar at the bottom of the <i>Query Tool view</i>.
<li>A name for the query will default at the query name field.</li>
<li>Either change the name of the query or accept the default.</li>
<li>In the query result type section, click on the <b>checkboxes</b> for those <b>result types</b> you want to include when the query is run.
</li>
<li>Click on the <b>OK button</b>.</li>
<li>The Run Query window will close and the querying process will begin.</li>
</ol>
<p> </p>
<p> </p>
<p>Once you begin the process of running the query the <i>Query Status view</i> will display "<b>Running Query</b>", the name of the query, and the time that has elapsed.
<p>A <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.jpg" alt="previousQuery" />)</span> is created automatically when a query is run from the <i>Query Tool</i>. The query is stored in the database and displayed in the <i>Previous Query view</i>.
</p>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>
Previous queries can also be seen in Workplace view if the user copied it to their workplace or shared folder in workplace view.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<ol>
<li>Run a query.</li>
<li>Go to the <b>Previous Query view</b>.</li>
<li>The query you just ran will now appear in the list of previous queries.</li>
If the previous query does not appear in the list automatically you can refresh the view to update the list. This is done by using the right mouse button and clicking anywhere in the Previous Query view.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h2><a name="qtPrintQuery" id="qtPrintQuery"></a>Printing a Query</h2>
<p> </p>
<p>Users are able to print out the query information if they wish to have a hard copy of the search criteria defined for a query.
</p>
<p> </p>
<p>When printing a query you can either print the information for a current query or you can drag a previous query to the query tool view and print the information associated with that query.
</p>
<p> </p>
<p>The following steps outline the process of printing a query once you have the appropriate query in the Query Tool.
</p>
<p> </p>
<p> </p>
<ol>
<li>Click on the <b>Print Query button</b> located on the toolbar at the bottom of the <i>Query Tool view</i>
<p>Information in the <b>Workplace view</b> 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:
</p>
<p> </p>
<ul>
<li>Save and organize user specific items.</li>
<li>Share information with other project users.</li>
<li>Project managers can view the workplace for individual team members.</li>
</ul>
<p> </p>
<p>The items stored in the Workplace view can be used in many of the i2b2 views and plug-ins, such as the <i>Query Tool view</i> <i>plug-in</i>.
<p>This section describes the layout and contents of this view.</p>
<p> </p>
<h3><a name="wpLayout" id="wpLayout"></a>Layout of the Workplace View</h3>
<p>As stated above the <b>Workplace view</b> 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 <i>SHARED</i> folder.
<p>The highest level is the individual user folder <span style="color:#CCCCCC">(<img src="images/container.png" alt="container" />)</span>. 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.
</p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>This also includes the shared folder.
<p>A <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folderWP.png" alt="folder" />)</span> in the workplace view contains other folders and / or items added by the user. It can be expanded and collapsed by clicking on the <i>plus sign</i> <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> or <i>negative sign</i> <span style="color:#CCCCCC">(<img src="images/minusSign.png" alt="minusSign" />)</span> next to it. A user defined folder can not be dragged to other i2b2 views. It can be moved around within the Workplace view.
</p>
<p> </p>
<h4><a name="wpItems" id="wpItems"></a>Items</h4>
<p>Items are the lowest level of the hierarchy. They can not be expanded further. Some examples of items are listed below.
<h3><a name="wpExpCollFolder" id="wpExpCollFolder"></a>Expand / Collapse a Folder</h3>
<p>Users can expand or collapse a folder by clicking on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> or negative sign <span style="color:#CCCCCC">(<img src="images/minusSign.png" alt="minusSign" />)</span> next to the folder icon.
</p>
<p> </p>
<h4><a name="wpExpFolder" id="wpExpFolder"></a>Expand (Open) a Folder</h4>
<ol>
<li>Click on the <b>plus sign</b> <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the folder in the <i>Workplace view.</i>
</li>
<li>The folder will open and all the items in the folder will display.</li>
</ol>
<p> </p>
<p> </p>
<h4><a name="wpCollFolder" id="wpCollFolder"></a>Collapse (Close) a Folder</h4>
<ol>
<li>Click on the <b>negative sign</b> <span style="color:#CCCCCC">(<img src="images/minusSign.png" alt="minusSign" />)</span> next to the folder in the <i> Workplace view.</i>
</li>
<li>The folder will close and all the items in the folder will display.</li>
</ol>
<p></p>
<p></p>
<p> </p>
<p> </p>
<h3><a name="wpAddWpFolder" id="wpAddWpFolder"></a>Add a Workplace Folder</h3>
<p> </p>
<ol>
<li>Using the <i>right mouse button</i>, click on your user folder in the <b> Workplace view</b>.</li>
<li>In the text box enter the text you want to appear when the tooltip is displayed.</li>
<li>Click on the <b>OK button</b>.</li>
<li>Using the <i>mouse</i>, hover over the folder you just annotated.</li>
<li>The text you entered will display as a tool tip.</li>
</ol>
<p> </p>
<p> </p>
<h3><a name="wpDeleteFolder" id="wpDeleteFolder"></a>Delete a Folder</h3>
<p>Users can remove a folder from the Workplace view.</p>
<p> </p>
<table id=warning>
<tr>
<td>
<p class=WarningHeading>WARNING: </p>
<p class=WarningParagraph>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.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<ol>
<li>Using the <i>right mouse button</i>, click on the folder you want to delete.</li>
<li>The item will no longer appear in the Workplace view.</li>
</ol>
<p></p>
<p> </p>
<p> </p>
<h2><a name="wpAddToWp" id="wpAddToWp"></a>Adding Items to Workplace View</h2>
<p>This section describes how to add items to the Workplace view.</p>
<p> </p>
<h3><a name="wpDragItemsToWp" id="wpDragItemsToWp"></a>Items Draggable to Workplace</h3>
<p>Items can be dragged and dropped (copied) into the Workplace view from other views in the i2b2 Web Client.
</p>
<p> </p>
<ol>
<li>Folder</li>
<p>A <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="folder" />)</span> and all its concepts (children) can be added to <b>Workplace</b> by dragging the folder name from one of the following views.
</p>
<p> </p>
<ul>
<li><b>Find Terms view</b></li>
<li><b>Navigate Terms view</b></li>
</ul>
<p> </p>
<p> </p>
<li>Modifier Folder</li>
<p>A <b>modifier folder</b> <span style="color:#CCCCCC">(<img src="images/modifierFolder.png" alt="modifierFolder" />)</span> and all its modifiers (children) can be added to <b>Workplace</b> by dragging the folder name from one of the following views.
</p>
<p> </p>
<ul>
<li><b>Find Terms view</b></li>
<li><b>Navigate Terms view</b></li>
</ul>
<p> </p>
<p> </p>
<li>Concept</li>
<p> A <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> can be added to <b>Workplace</b> by dragging the name of the concept from one of the following views.
</p>
<p> </p>
<ul>
<li><b>Find Terms view</b>.</li>
<li><b>Navigate Terms view</b></li>
</ul>
<p> </p>
<p> </p>
<li>Modifier</li>
<p> A <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" />)</span> can be added to <b>Workplace</b> by dragging the name of the modifier from one of the following views.
</p>
<p> </p>
<ul>
<li><b>Find Terms view</b>.</li>
<li><b>Navigate Terms view</b></li>
</ul>
<p> </p>
<p> </p>
<li>Patient Set </li>
<p>A <b>Patient set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> can be added to <b>Workplace</b> by dragging the name of the patient set from the following view.
</p>
<p> </p>
<ul>
<li><b>Previous Query view</b>.</li>
</ul>
<p> </p>
<p> </p>
<li>Encounter Set </li>
<p>An <b>Encounter set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> can be added to <b>Workplace</b> by dragging the name of the encounter set from the following view.
</p>
<p> </p>
<ul>
<li><b>Previous Query view</b>.</li>
</ul>
<p> </p>
<p> </p>
<li>Previous Query</li>
<p>A <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.png" alt="previousQuery" />)</span> can be added to <b>Workplace</b> by dragging the name of the previous query from the following view.
</p>
<p> </p>
<ul>
<li><b>Previous Query view</b>.</li>
</ul>
</ol>
<p> </p>
<p> </p>
<h3><a name="wpAddFolder" id="wpAddFolder"></a>Add Folders and Concept to Workplace View</h3>
<p class=NoteParagraph>For detailed information on how to search for terms, please see the i2b2 Find Terms help.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p></p>
<h4><a name="wpAddFolderFromFt" id="wpAddFolderFromFt"></a>Add Folder / Concept From Find Terms View</h4>
<p> </p>
<ol>
<li>In the <b>Find Terms view</b>, search for the item(s) you want to add.</li>
<li>Highlight the <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="folder" />)</span> or <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Workplace view</b>.</li>
<li>Drop the item into either your workplace folder or the shared folder.</li>
<p class=NoteParagraph>How the items are grouped and displayed is dependent on how the database is setup.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<h4><a name="wpAddFolderFromNt" id="wpAddFolderFromNt"></a>Add Folder / Concept From Navigate Terms View</h4>
<p> </p>
<ol>
<li>In the <b>Navigate Terms view</b>, expand the folder(s) that contains the concept or grouping of concepts you want to add.
</li>
<li>Highlight the <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="folder" />)</span> or <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Workplace view</b>.</li>
<li>Drop the item into either your workplace folder or the shared folder.</li>
<li>In the <b>Find Terms view</b>, search for the item(s) you want to add.</li>
<li>Highlight the <b>modifier folder</b> <span style="color:#CCCCCC">(<img src="images/modifierFolder.png" alt="modiferFolder" />)</span> or <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Workplace view</b>.</li>
<li>Drop the item into either your workplace folder or the shared folder.</li>
<li>In the <b>Navigate Terms view</b>, expand the folder(s) that contains the modifiers or grouping of modifiers you want to add.
</li>
<li>Highlight the <b>modifier folder</b> <span style="color:#CCCCCC">(<img src="images/modifierFolder.png" alt="modifierFolder" />)</span> or <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Workplace view</b>.</li>
<li>Drop the item into either your workplace folder or the shared folder.</li>
<p>The <b>Previous Query view</b> 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
<h5><a name="wpAddPqFromPq" id="wpAddPqFromPq"></a>Add Previous Query From Previous Query View</h5>
<p> </p>
<ol>
<li>Highlight the <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.png" alt="prevQuery" />)</span> by clicking on the name of the query.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item to the <b>Workplace view</b>.</li>
<li>Drop the previous query into either your workplace folder or the shared folder.</li>
<h5><a name="wpAddPtSetFromPq" id="wpAddPtSetFromPq"></a>Add Patient Set From Previous Query View</h5>
<p> </p>
<ol>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the name of the previous query that contains the patient set.
</li>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the results folder.
</li>
<li>Highlight the <b>Patient set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the <b>Patient Set</b> to the <b>Workplace view</b>.
</li>
<li>Drop the patient set into either your workplace folder or the shared folder.</li>
<h5><a name="wpAddPtSetFromPq" id="wpAddPtSetFromPq2"></a>Add Encounter Set From Previous Query View</h5>
<p> </p>
<ol>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the name of the previous query that contains the encounter set.
</li>
<li>Click on the plus sign <span style="color:#CCCCCC">(<img src="images/plusSign.png" alt="plusSign" />)</span> next to the results folder.
</li>
<li>Highlight the <b>Encounter set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the <b>Encounter Set</b> to the <b>Workplace view</b>.
</li>
<li>Drop the encounter set into either your workplace folder or the shared folder.</li>
<h2><a name="wpUseItems" id="wpUseItems"></a>Using Items in Workplace View</h2>
<p>This section describes how to use items in the Workplace view.</p>
<p> </p>
<h3><a name="wpDragItemsFromWp" id="wpDragItemsFromWp"></a>Items Draggable from Workplace</h3>
<p>Items can be dragged and dropped (copied) from the Workplace view to other views in the i2b2 Web client.
</p>
<p> </p>
<ol>
<li>Ontology Folder</li>
<p>An <b>ontology folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="folder" />)</span> and all its concepts (children) can be added to other views by dragging the folder name from <b>Workplace</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i>.</li>
</ul>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>User folders can not be dragged from the Workplace view.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<li>Modifier Folder</li>
<p>A <b>modifier folder</b> <span style="color:#CCCCCC">(<img src="images/modifierFolder.png" alt="modifierFolder" />)</span> and all its modifiers (children) can be added to other views by dragging the modifier folder name from <b>Workplace</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool view</b>; drop in the <i>panel</i>.</li>
</ul>
<p> </p>
<p> </p>
<li>Concept</li>
<p> A <b>concept</b> <span style="color:#CCCCCC">(<img src="images/leaf.png" alt="leaf" />)</span> can be added to other views by dragging the name of the concept from <b>Workplace</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i>.</li>
</ul>
<p> </p>
<p> </p>
<li>Modifier</li>
<p> A <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" />)</span> can be added to other views by dragging the name of the modifier from <b>Workplace</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i>.</li>
</ul>
<p> </p>
<p> </p>
<li>Previous Query</li>
<p>A <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.png" alt="prevQuery" />)</span> can be added to other views by dragging the previous query name from <b>Workplace</b> to one of the following views.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i> or <i>Query Name</i>.</li>
</ul>
<p> </p>
<p> </p>
<li>Patient Set </li>
<p>A specific set of patients can be added to other views by dragging the <b>Patient set </b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> from <b>Workplace</b> to one of the following view.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i>.</li>
</ul>
<p> </p>
<p> </p>
<li>Encounter Set </li>
<p>A specific set of encounters (visit list) can be added to the other views by dragging the <b>Encounter set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> from <b>Workplace</b> to one of the following view.
</p>
<p> </p>
<ul>
<li><b>Query Tool view;</b> drop in the <i>panel</i>.</li>
</ul>
</ol>
<p> </p>
<p> </p>
<p> </p>
<h3><a name="wpUseConceptFolder" id="wpUseConceptFolder"></a>Using Concepts and Folders</h3>
<p> </p>
<p>A folder or individual concept can be added to the query tool view by simply dragging the item from <b>Workplace view</b> and dropping it into one of the panels in the <b>Query Tool view</b>.
</p>
<p> </p>
<h4><a name="wpAddFolderToQt" id="wpAddFolderToQt"></a>Add Folder to Query Tool View</h4>
<p> </p>
<ol>
<li>Highlight the <b>folder</b> <span style="color:#CCCCCC">(<img src="images/folder.png" alt="folder" />)</span> by clicking on the name of the folder.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b>.</li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<h3><a name="wpUsePq" id="wpUsePq2"></a>Using Modifiers and Modifier Folders</h3>
<p>A modifier folder or individual modifier can be added to the query tool view by simply dragging the item from the <b>Workplace view</b> and dropping it into one of the panel in the <b>Query Tool view</b>.
</p>
<p> </p>
<p> </p>
<h4><a name="wpAddModToQt" id="wpAddModToQt"></a>Add Modifier to Query Tool View</h4>
<ol>
<li>Highlight the <b>modifier</b> <span style="color:#CCCCCC">(<img src="images/modifier.png" alt="modifier" />)</span> by clicking on the name of the modifier.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b>.</li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<p>A <b>previous query</b> 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 <b>Query Tool view</b> simply drag the query name from the <b>Workplace view</b>.
</p>
<p> </p>
<p>Within the Query Tool view, the previous query can be added to one of the following two locations.</p>
<td>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.
</td>
</tr>
<tr>
<td><b>Panel (Group)</b></td>
<td>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.
</td>
</tr>
</table>
<p> </p>
<p> </p>
<table id=note>
<tr>
<td>
<p class=NoteHeading>NOTE: </p>
<p class=NoteParagraph>The process of adding a previous query to the Query Tool view is the same for both standard i2b2 queries <span style="color:#CCCCCC">(<img src="images/prevQuery.png" alt="prevQuery" />)</span> and temporal queries <span style="color:#CCCCCC">(<img src="images/iconTemporalQry.png" />)</span>.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p> </p>
<h4><a name="wpAddPqToQt" id="wpAddPqToQt"></a>Add Previous Query to Query Name (New Query)</h4>
<p> </p>
<ol>
<li>Highlight the <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.png" alt="prevQuery" /> / <img src="images/iconTemporalQry.png" />)</span> by clicking on the name of the query.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item to the <b>Query Tool view</b>.</li>
<li>Drop the item into the <b>Query Name field</b>.</li>
<li>The item(s) associated with the previous query will display in the appropriate group(s), the name of the query will appear at <b>Query Name</b>, and any constraints that were defined when the original query was run will now default with the new query.
<p class=NoteParagraph>When you run the query it will receive a new name. This is to distinguish the first previous query from the second.
</p>
</td>
</tr>
</table>
<p> </p>
<p> </p>
<p></p>
<p> </p>
<h4><a name="wpAddPqToQtPanel" id="wpAddPqToQtPanel"></a>Add Previous Query to Query Name (Query-in-Query)</h4>
<p> </p>
<ol>
<li>Highlight the <b>previous query</b> <span style="color:#CCCCCC">(<img src="images/prevQuery.png" alt="prevQuery" /> / <img src="images/iconTemporalQry.png" />)</span> by clicking on the name of the query.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item to the <b>Query Tool view</b>.</li>
<li>Drop the item into the <b>panel</b> labeled <b>Group 1</b>.</li>
<p>A <b>Patient set</b> can be used as an item within a query. To add a patient set to the <b>Query Tool view</b> simply drag the name of the patient set from the <b>Workplace view</b>.
</p>
<p> </p>
<p> </p>
<h4><a name="qtAddPtListFromPq" id="qtAddPtListFromPq"></a>Add Patient Set From Workplace View</h4>
<ol>
<li>In the <b>Workplace view</b>, expand the folder(s) that contains the list of patients you want to add.
</li>
<li>Highlight the <b>Patient set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the item into the<strong> </strong><b>panel</b> labeled <b>Group 1</b>.</li>
<p>An <b>Encounter set</b> can be used as an item within a query. To add an encounter set to the <b>Query Tool view</b> simply drag the name of the encounter set from the <b>Workplace view</b>.
</p>
<p> </p>
<p> </p>
<h4><a name="qtAddEncSetFromPq" id="qtAddEncSetFromPq"></a>Add Encounter Set From Workplace View</h4>
<ol>
<li>In the <b>Workplace view</b>, expand the folder(s) that contains the list of patients you want to add.
</li>
<li>Highlight the <b>Encounter set</b> <span style="color:#CCCCCC">(<img src="images/ptSet.png" alt="ptSet" />)</span> by clicking on its name.
</li>
<li>While holding the <i>left mouse button</i> down, drag the item over to the <b>Query Tool view</b></li>
<li>Drop the item into the<strong> </strong><b>panel</b> labeled <b>Group 1</b>.</li>