DSTU2 QA Preview

This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). 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: R5 R4B R4 R3 R2

Valueset-search-modifier-code.xml

Raw XML (canonical form)

Definition for Value SetSearchModifierCode

Raw XML

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="search-modifier-code"/>
  <meta>
    <lastUpdated value="2015-09-01T14:38:48.206+10:00"/>
    <profile value="http://hl7.org/fhir/StructureDefinition/valueset-shareable-definition"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>SearchModifierCode</h2>
      <p>A supported modifier for a search parameter</p>
      <p>This value set has an inline code system http://hl7.org/fhir/search-modifier-code, which
         defines the following codes:</p>
      <table class="codes">
        <tr>
          <td>
            <b>Code</b>
          </td>
          <td>
            <b>Display</b>
          </td>
          <td>
            <b>Definition</b>
          </td>
        </tr>
        <tr>
          <td>missing
            <a name="missing"> </a>
          </td>
          <td>Missing</td>
          <td>The search parameter returns resources that have a value or not</td>
        </tr>
        <tr>
          <td>exact
            <a name="exact"> </a>
          </td>
          <td>Exact</td>
          <td>The search parameter returns resources that have a value that exactly matches the supplied
             parameter (the whole string, including casing and accents)</td>
        </tr>
        <tr>
          <td>contains
            <a name="contains"> </a>
          </td>
          <td>Contains</td>
          <td>The search parameter returns resources that include the supplied parameter value anywhere
             within the field being searched</td>
        </tr>
        <tr>
          <td>not
            <a name="not"> </a>
          </td>
          <td>Not</td>
          <td>The search parameter returns resources that do not contain a match</td>
        </tr>
        <tr>
          <td>text
            <a name="text"> </a>
          </td>
          <td>Text</td>
          <td>The search parameter is processed as a string that searches text associated with the code/value
             - either CodeableConcept.text, Coding.display, or Identifier.type.text</td>
        </tr>
        <tr>
          <td>in
            <a name="in"> </a>
          </td>
          <td>In</td>
          <td>The search parameter is a URI (relative or absolute) that identifies a value set, and
             the search parameter tests whether the coding is in the specified value set.</td>
        </tr>
        <tr>
          <td>not-in
            <a name="not-in"> </a>
          </td>
          <td>Not In</td>
          <td>The search parameter is a URI (relative or absolute) that identifies a value set, and
             the search parameter tests whether the coding is not in the specified value set</td>
        </tr>
        <tr>
          <td>below
            <a name="below"> </a>
          </td>
          <td>Below</td>
          <td>The search parameter tests whether the value in a resource is subsumed by the specified
             value (is-a, or heirarchical relationships)</td>
        </tr>
        <tr>
          <td>above
            <a name="above"> </a>
          </td>
          <td>Above</td>
          <td>The search parameter tests whether the value in a resource subsumes the specified value
             (is-a, or heirarchical relationships)</td>
        </tr>
        <tr>
          <td>type
            <a name="type"> </a>
          </td>
          <td>Type</td>
          <td>The search parameter only applies to the Resource Type specified as a modifier (e.g. the
             modifier is not actually :type, but :Patient etc)</td>
        </tr>
      </table>
    </div>
  </text>
  <extension url="http://hl7.org/fhir/StructureDefinition/valueset-oid">
    <valueUri value="urn:oid:2.16.840.1.113883.4.642.2.92"/>
  </extension>
  <url value="http://hl7.org/fhir/ValueSet/search-modifier-code"/>
  <version value="1.0.0"/>
  <name value="SearchModifierCode"/>
  <status value="draft"/>
  <experimental value="false"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <date value="2015-09-01T14:38:48+10:00"/>
  <description value="A supported modifier for a search parameter"/>
  <codeSystem>
    <extension url="http://hl7.org/fhir/StructureDefinition/valueset-oid">
      <valueUri value="urn:oid:2.16.840.1.113883.4.642.1.92"/>
    </extension>
    <system value="http://hl7.org/fhir/search-modifier-code"/>
    <version value="1.0.0"/>
    <caseSensitive value="true"/>
    <concept>
      <code value="missing"/>
      <display value="Missing"/>
      <definition value="The search parameter returns resources that have a value or not"/>
    </concept>
    <concept>
      <code value="exact"/>
      <display value="Exact"/>
      <definition value="The search parameter returns resources that have a value that exactly matches the supplied
       parameter (the whole string, including casing and accents)"/>
    </concept>
    <concept>
      <code value="contains"/>
      <display value="Contains"/>
      <definition value="The search parameter returns resources that include the supplied parameter value anywhere
       within the field being searched"/>
    </concept>
    <concept>
      <code value="not"/>
      <display value="Not"/>
      <definition value="The search parameter returns resources that do not contain a match"/>
    </concept>
    <concept>
      <code value="text"/>
      <display value="Text"/>
      <definition value="The search parameter is processed as a string that searches text associated with the code/value
       - either CodeableConcept.text, Coding.display, or Identifier.type.text"/>
    </concept>
    <concept>
      <code value="in"/>
      <display value="In"/>
      <definition value="The search parameter is a URI (relative or absolute) that identifies a value set, and
       the search parameter tests whether the coding is in the specified value set."/>
    </concept>
    <concept>
      <code value="not-in"/>
      <display value="Not In"/>
      <definition value="The search parameter is a URI (relative or absolute) that identifies a value set, and
       the search parameter tests whether the coding is not in the specified value set"/>
    </concept>
    <concept>
      <code value="below"/>
      <display value="Below"/>
      <definition value="The search parameter tests whether the value in a resource is subsumed by the specified
       value (is-a, or heirarchical relationships)"/>
    </concept>
    <concept>
      <code value="above"/>
      <display value="Above"/>
      <definition value="The search parameter tests whether the value in a resource subsumes the specified value
       (is-a, or heirarchical relationships)"/>
    </concept>
    <concept>
      <code value="type"/>
      <display value="Type"/>
      <definition value="The search parameter only applies to the Resource Type specified as a modifier (e.g. the
       modifier is not actually :type, but :Patient etc)"/>
    </concept>
  </codeSystem>
</ValueSet>

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.