STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4 R3

V3-QueryParameterValue.cs.xml

Raw XML (canonical form)

The domain of coded values used as parameters within QueryByParameter queries.

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="v3-QueryParameterValue"/>
  <meta>
    <lastUpdated value="2016-11-11T00:00:00.000+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>Release Date: 2016-11-11</p>

      <table class="grid">
 
        <tr>
          <td>
            <b>Level</b>
          </td>
          <td>
            <b>Code</b>
          </td>
          <td>
            <b>Display</b>
          </td>
          <td>
            <b>Definition</b>
          </td>
        </tr>
 
        <tr>
          <td>1</td>
          <td>
            <span style="color: grey">
              <i>(_DispenseQueryFilterCode)</i>
            </span> 
            <b>
              <i>Abstract</i>
            </b>
          </td>
          <td>
            <a name="_DispenseQueryFilterCode"> </a>
          </td>
          <td>
                        
                           Description:Filter codes used to manage volume of dispenses
               returned by  a parameter-based queries.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  ALLDISP
            <a name="ALLDISP"> </a>
          </td>
          <td>all dispenses</td>
          <td>
                        
                           Description:Returns all dispenses to date for a prescription.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  LASTDISP
            <a name="LASTDISP"> </a>
          </td>
          <td>last dispense</td>
          <td>
                        
                           Description:Returns the most recent dispense for a prescription.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  NODISP
            <a name="NODISP"> </a>
          </td>
          <td>no dispense</td>
          <td>
                        
                           Description:Returns no dispense for a prescription.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>1</td>
          <td>
            <span style="color: grey">
              <i>(_OrderFilterCode)</i>
            </span> 
            <b>
              <i>Abstract</i>
            </b>
          </td>
          <td>
            <a name="_OrderFilterCode"> </a>
          </td>
          <td>
                        Filter codes used to manage types of orders being returned by
               a parameter-based query.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  AO
            <a name="AO"> </a>
          </td>
          <td>all orders</td>
          <td>
                        Return all orders.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  ONR
            <a name="ONR"> </a>
          </td>
          <td>orders without results</td>
          <td>
                        Return only those orders that do not have results.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  OWR
            <a name="OWR"> </a>
          </td>
          <td>orders with results</td>
          <td>
                        Return only those orders that have results.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>1</td>
          <td>
            <span style="color: grey">
              <i>(_PrescriptionDispenseFilterCode)</i>
            </span> 
            <b>
              <i>Abstract</i>
            </b>
          </td>
          <td>
            <a name="_PrescriptionDispenseFilterCode"> </a>
          </td>
          <td>
                        A &quot;helper&quot; vocabulary used to construct complex query
               filters based on how and whether a prescription has been dispensed.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  C
            <a name="C"> </a>
          </td>
          <td>Completely dispensed</td>
          <td>
                        Filter to only include SubstanceAdministration orders which have
               no remaining quantity authorized to be dispensed.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  N
            <a name="N"> </a>
          </td>
          <td>Never Dispensed</td>
          <td>
                        Filter to only include SubstanceAdministration orders which have
               no fulfilling supply events performed.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  R
            <a name="R"> </a>
          </td>
          <td>Dispensed with remaining fills</td>
          <td>
                        Filter to only include SubstanceAdministration orders which have
               had at least one fulfilling supply event, but which still have outstanding quantity remaining
               to be authorized.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>1</td>
          <td>
            <span style="color: grey">
              <i>(_QueryParameterValue)</i>
            </span> 
            <b>
              <i>Abstract</i>
            </b>
          </td>
          <td>
            <a name="_QueryParameterValue"> </a>
          </td>
          <td>
                        
                           Description:Indicates how result sets should be filtered based
               on whether they have associated issues.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  ISSFA
            <a name="ISSFA"> </a>
          </td>
          <td>all</td>
          <td>
                        
                           Description:Result set should not be filtered based on the
               presence of issues.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  ISSFI
            <a name="ISSFI"> </a>
          </td>
          <td>with issues</td>
          <td>
                        
                           Description:Result set should be filtered to only include records
               with associated issues.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  ISSFU
            <a name="ISSFU"> </a>
          </td>
          <td>with unmanaged issues</td>
          <td>
                        
                           Description:Result set should be filtered to only include records
               with associated unmanaged issues.
            <br/>

                     
          </td>
        </tr>

      </table>

    </div>
  </text>
  <url value="http://hl7.org/fhir/v3/QueryParameterValue"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.5.1096"/>
  </identifier>
  <version value="2016-11-11"/>
  <name value="v3 Code System QueryParameterValue"/>
  <status value="active"/>
  <experimental value="false"/>
  <publisher value="HL7, Inc"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org"/>
    </telecom>
  </contact>
  <date value="2016-11-11T00:00:00+11:00"/>
  <description value=" The domain of coded values used as parameters within QueryByParameter queries."/>
  <caseSensitive value="true"/>
  <valueSet value="http://hl7.org/fhir/ValueSet/v3-QueryParameterValue"/>
  <hierarchyMeaning value="is-a"/>
  <content value="complete"/>
  <property>
    <code value="notSelectable"/>
    <uri value="http://hl7.org/fhir/concept-properties#notSelectable"/>
    <description value="Indicates that the code is abstract - only intended to be used as a selector for other
       concepts"/>
    <type value="boolean"/>
  </property>
  <concept>
    <code value="_DispenseQueryFilterCode"/>
    <display value="dispense query filter code"/>
    <definition value="Description:Filter codes used to manage volume of dispenses returned by  a parameter-based
       queries."/>
    <property>
      <code value="notSelectable"/>
      <valueBoolean value="true"/>
    </property>
    <concept>
      <code value="ALLDISP"/>
      <display value="all dispenses"/>
      <definition value="Description:Returns all dispenses to date for a prescription."/>
    </concept>
    <concept>
      <code value="LASTDISP"/>
      <display value="last dispense"/>
      <definition value="Description:Returns the most recent dispense for a prescription."/>
    </concept>
    <concept>
      <code value="NODISP"/>
      <display value="no dispense"/>
      <definition value="Description:Returns no dispense for a prescription."/>
    </concept>
  </concept>
  <concept>
    <code value="_OrderFilterCode"/>
    <display value="_OrderFilterCode"/>
    <definition value="Filter codes used to manage types of orders being returned by a parameter-based query."/>
    <property>
      <code value="notSelectable"/>
      <valueBoolean value="true"/>
    </property>
    <concept>
      <code value="AO"/>
      <display value="all orders"/>
      <definition value="Return all orders."/>
    </concept>
    <concept>
      <code value="ONR"/>
      <display value="orders without results"/>
      <definition value="Return only those orders that do not have results."/>
    </concept>
    <concept>
      <code value="OWR"/>
      <display value="orders with results"/>
      <definition value="Return only those orders that have results."/>
    </concept>
  </concept>
  <concept>
    <code value="_PrescriptionDispenseFilterCode"/>
    <display value="Prescription Dispense Filter Code"/>
    <definition value="A &quot;helper&quot; vocabulary used to construct complex query filters based on how and
       whether a prescription has been dispensed."/>
    <property>
      <code value="notSelectable"/>
      <valueBoolean value="true"/>
    </property>
    <concept>
      <code value="C"/>
      <display value="Completely dispensed"/>
      <definition value="Filter to only include SubstanceAdministration orders which have no remaining quantity
         authorized to be dispensed."/>
    </concept>
    <concept>
      <code value="N"/>
      <display value="Never Dispensed"/>
      <definition value="Filter to only include SubstanceAdministration orders which have no fulfilling supply
         events performed."/>
    </concept>
    <concept>
      <code value="R"/>
      <display value="Dispensed with remaining fills"/>
      <definition value="Filter to only include SubstanceAdministration orders which have had at least one fulfilling
         supply event, but which still have outstanding quantity remaining to be authorized."/>
    </concept>
  </concept>
  <concept>
    <code value="_QueryParameterValue"/>
    <display value="QueryParameterValue"/>
    <definition value="Description:Indicates how result sets should be filtered based on whether they have associated
       issues."/>
    <property>
      <code value="notSelectable"/>
      <valueBoolean value="true"/>
    </property>
    <concept>
      <code value="ISSFA"/>
      <display value="all"/>
      <definition value="Description:Result set should not be filtered based on the presence of issues."/>
    </concept>
    <concept>
      <code value="ISSFI"/>
      <display value="with issues"/>
      <definition value="Description:Result set should be filtered to only include records with associated issues."/>
    </concept>
    <concept>
      <code value="ISSFU"/>
      <display value="with unmanaged issues"/>
      <definition value="Description:Result set should be filtered to only include records with associated unmanaged
         issues."/>
    </concept>
  </concept>
</CodeSystem>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.