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: R5 R4B R4 R3

Codesystem-filter-operator.xml

Raw XML (canonical form)

Definition for Code System FilterOperator

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="filter-operator"/>
  <meta>
    <lastUpdated value="2016-12-06T12:22:34.981+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>FilterOperator</h2>
      <div>
        <p>The kind of operation to perform as a part of a property based filter.</p>

      </div>
      <p>This code system http://hl7.org/fhir/filter-operator 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>=
            <a name="filter-operator-.61"> </a>
          </td>
          <td>Equals</td>
          <td>The specified property of the code equals the provided value.</td>
        </tr>
        <tr>
          <td>is-a
            <a name="filter-operator-is-a"> </a>
          </td>
          <td>Is A (by subsumption)</td>
          <td>Includes all concept ids that have a transitive is-a relationship with the concept Id
             provided as the value, including the provided concept itself (i.e. include child codes)</td>
        </tr>
        <tr>
          <td>descendent-of
            <a name="filter-operator-descendent-of"> </a>
          </td>
          <td>Descendent Of (by subsumption)</td>
          <td>Includes all concept ids that have a transitive is-a relationship with the concept Id
             provided as the value, excluding the provided concept itself (i.e. include child codes)</td>
        </tr>
        <tr>
          <td>is-not-a
            <a name="filter-operator-is-not-a"> </a>
          </td>
          <td>Not (Is A) (by subsumption)</td>
          <td>The specified property of the code does not have an is-a relationship with the provided
             value.</td>
        </tr>
        <tr>
          <td>regex
            <a name="filter-operator-regex"> </a>
          </td>
          <td>Regular Expression</td>
          <td>The specified property of the code  matches the regex specified in the provided value.</td>
        </tr>
        <tr>
          <td>in
            <a name="filter-operator-in"> </a>
          </td>
          <td>In Set</td>
          <td>The specified property of the code is in the set of codes or concepts specified in the
             provided value (comma separated list).</td>
        </tr>
        <tr>
          <td>not-in
            <a name="filter-operator-not-in"> </a>
          </td>
          <td>Not in Set</td>
          <td>The specified property of the code is not in the set of codes or concepts specified in
             the provided value (comma separated list).</td>
        </tr>
        <tr>
          <td>generalizes
            <a name="filter-operator-generalizes"> </a>
          </td>
          <td>Generalizes (by Subsumption)</td>
          <td>Includes all concept ids that have a transitive is-a relationship from the concept Id
             provided as the value, including the provided concept itself (e.g. include parent codes)</td>
        </tr>
        <tr>
          <td>exists
            <a name="filter-operator-exists"> </a>
          </td>
          <td>Exists</td>
          <td>The specified property of the code has at least one value (if the specified value is true;
             if the specified value is false, then matches when the specified property of the code
             has no values)</td>
        </tr>
      </table>
    </div>
  </text>
  <url value="http://hl7.org/fhir/filter-operator"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.1.280"/>
  </identifier>
  <version value="1.8.0"/>
  <name value="FilterOperator"/>
  <status value="draft"/>
  <experimental value="false"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <date value="2016-12-06T12:22:34+11:00"/>
  <description value="The kind of operation to perform as a part of a property based filter."/>
  <caseSensitive value="true"/>
  <valueSet value="http://hl7.org/fhir/ValueSet/filter-operator"/>
  <content value="complete"/>
  <concept>
    <code value="="/>
    <display value="Equals"/>
    <definition value="The specified property of the code equals the provided value."/>
  </concept>
  <concept>
    <code value="is-a"/>
    <display value="Is A (by subsumption)"/>
    <definition value="Includes all concept ids that have a transitive is-a relationship with the concept Id
     provided as the value, including the provided concept itself (i.e. include child codes)"/>
  </concept>
  <concept>
    <code value="descendent-of"/>
    <display value="Descendent Of (by subsumption)"/>
    <definition value="Includes all concept ids that have a transitive is-a relationship with the concept Id
     provided as the value, excluding the provided concept itself (i.e. include child codes)"/>
  </concept>
  <concept>
    <code value="is-not-a"/>
    <display value="Not (Is A) (by subsumption)"/>
    <definition value="The specified property of the code does not have an is-a relationship with the provided
     value."/>
  </concept>
  <concept>
    <code value="regex"/>
    <display value="Regular Expression"/>
    <definition value="The specified property of the code  matches the regex specified in the provided value."/>
  </concept>
  <concept>
    <code value="in"/>
    <display value="In Set"/>
    <definition value="The specified property of the code is in the set of codes or concepts specified in the
     provided value (comma separated list)."/>
  </concept>
  <concept>
    <code value="not-in"/>
    <display value="Not in Set"/>
    <definition value="The specified property of the code is not in the set of codes or concepts specified in
     the provided value (comma separated list)."/>
  </concept>
  <concept>
    <code value="generalizes"/>
    <display value="Generalizes (by Subsumption)"/>
    <definition value="Includes all concept ids that have a transitive is-a relationship from the concept Id
     provided as the value, including the provided concept itself (e.g. include parent codes)"/>
  </concept>
  <concept>
    <code value="exists"/>
    <display value="Exists"/>
    <definition value="The specified property of the code has at least one value (if the specified value is true;
     if the specified value is false, then matches when the specified property of the code
     has no values)"/>
  </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.