Release 5 Preview #3

Codesystem-subscription-search-modifier.xml

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

Definition for Code System SubscriptionSearchModifier

<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="subscription-search-modifier"/> 
  <meta> 
    <lastUpdated value="2020-09-22T18:47:55.896+00:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This code system http://terminology.hl7.org/CodeSystem/subscription-search-modifier defines
         the following codes:</p> 
      <table class="codes">
        <tr> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">=
            <a name="subscription-search-modifier-.61"> </a> 
          </td> 
          <td> =</td> 
          <td> Used to match a value according to FHIR Search rules (e.g., Patient/123, Encounter/2002).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">eq
            <a name="subscription-search-modifier-eq"> </a> 
          </td> 
          <td> Equal</td> 
          <td> The value for the parameter in the resource is equal to the provided value.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">ne
            <a name="subscription-search-modifier-ne"> </a> 
          </td> 
          <td> Not Equal</td> 
          <td> The value for the parameter in the resource is not equal to the provided value.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">gt
            <a name="subscription-search-modifier-gt"> </a> 
          </td> 
          <td> Greater Than</td> 
          <td> The value for the parameter in the resource is greater than the provided value.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">lt
            <a name="subscription-search-modifier-lt"> </a> 
          </td> 
          <td> Less Than</td> 
          <td> The value for the parameter in the resource is less than the provided value.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">ge
            <a name="subscription-search-modifier-ge"> </a> 
          </td> 
          <td> Greater Than or Equal</td> 
          <td> The value for the parameter in the resource is greater or equal to the provided value.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">le
            <a name="subscription-search-modifier-le"> </a> 
          </td> 
          <td> Less Than or Equal</td> 
          <td> The value for the parameter in the resource is less or equal to the provided value.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">sa
            <a name="subscription-search-modifier-sa"> </a> 
          </td> 
          <td> Starts After</td> 
          <td> The value for the parameter in the resource starts after the provided value.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">eb
            <a name="subscription-search-modifier-eb"> </a> 
          </td> 
          <td> Ends Before</td> 
          <td> The value for the parameter in the resource ends before the provided value.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">ap
            <a name="subscription-search-modifier-ap"> </a> 
          </td> 
          <td> Approximately</td> 
          <td> The value for the parameter in the resource is approximately the same to the provided
             value. Note that the recommended value for the approximation is 10% of the stated value
             (or for a date, 10% of the gap between now and the date), but systems may choose other
             values where appropriate.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">above
            <a name="subscription-search-modifier-above"> </a> 
          </td> 
          <td> Above</td> 
          <td> The search parameter is a concept with the form [system]|[code], and the search parameter
             tests whether the coding in a resource subsumes the specified search code.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">below
            <a name="subscription-search-modifier-below"> </a> 
          </td> 
          <td> Below</td> 
          <td> The search parameter is a concept with the form [system]|[code], and the search parameter
             tests whether the coding in a resource is subsumed by the specified search code.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">in
            <a name="subscription-search-modifier-in"> </a> 
          </td> 
          <td> In</td> 
          <td> The search parameter is a member of a Group or List, or the search parameter is a URI
             (relative or absolute) that identifies a value set, and the search parameter tests whether
             the value is present in the specified Group, List, or Value Set.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">not-in
            <a name="subscription-search-modifier-not-in"> </a> 
          </td> 
          <td> Not In</td> 
          <td> The search parameter is a member of a Group or List, or the search parameter is a URI
             (relative or absolute) that identifies a value set, and the search parameter tests whether
             the value is NOT present in the specified Group, List, or Value Set.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">of-type
            <a name="subscription-search-modifier-of-type"> </a> 
          </td> 
          <td> Of Type</td> 
          <td> The search parameter has the format system|code|value, where the system and code refer
             to a Identifier.type.coding.system and .code, and match if any of the type codes match.
             All 3 parts must be present.</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="0"/> 
  </extension> 
  <url value="http://terminology.hl7.org/CodeSystem/subscription-search-modifier"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.1.1526"/> 
  </identifier> 
  <version value="4.5.0"/> 
  <name value="SubscriptionSearchModifier"/> 
  <title value="Subscription Search Modifier"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="FHIR search modifiers allowed for use in Subscriptions and SubscriptionTopics."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/subscription-search-modifier"/> 
  <content value="complete"/> 
  <concept> 
    <code value="="/> 
    <display value="="/> 
    <definition value="Used to match a value according to FHIR Search rules (e.g., Patient/123, Encounter/2002)."/> 
  </concept> 
  <concept> 
    <code value="eq"/> 
    <display value="Equal"/> 
    <definition value="The value for the parameter in the resource is equal to the provided value."/> 
  </concept> 
  <concept> 
    <code value="ne"/> 
    <display value="Not Equal"/> 
    <definition value="The value for the parameter in the resource is not equal to the provided value."/> 
  </concept> 
  <concept> 
    <code value="gt"/> 
    <display value="Greater Than"/> 
    <definition value="The value for the parameter in the resource is greater than the provided value."/> 
  </concept> 
  <concept> 
    <code value="lt"/> 
    <display value="Less Than"/> 
    <definition value="The value for the parameter in the resource is less than the provided value."/> 
  </concept> 
  <concept> 
    <code value="ge"/> 
    <display value="Greater Than or Equal"/> 
    <definition value="The value for the parameter in the resource is greater or equal to the provided value."/> 
  </concept> 
  <concept> 
    <code value="le"/> 
    <display value="Less Than or Equal"/> 
    <definition value="The value for the parameter in the resource is less or equal to the provided value."/> 
  </concept> 
  <concept> 
    <code value="sa"/> 
    <display value="Starts After"/> 
    <definition value="The value for the parameter in the resource starts after the provided value."/> 
  </concept> 
  <concept> 
    <code value="eb"/> 
    <display value="Ends Before"/> 
    <definition value="The value for the parameter in the resource ends before the provided value."/> 
  </concept> 
  <concept> 
    <code value="ap"/> 
    <display value="Approximately"/> 
    <definition value="The value for the parameter in the resource is approximately the same to the provided
     value. Note that the recommended value for the approximation is 10% of the stated value
     (or for a date, 10% of the gap between now and the date), but systems may choose other
     values where appropriate."/> 
  </concept> 
  <concept> 
    <code value="above"/> 
    <display value="Above"/> 
    <definition value="The search parameter is a concept with the form [system]|[code], and the search parameter
     tests whether the coding in a resource subsumes the specified search code."/> 
  </concept> 
  <concept> 
    <code value="below"/> 
    <display value="Below"/> 
    <definition value="The search parameter is a concept with the form [system]|[code], and the search parameter
     tests whether the coding in a resource is subsumed by the specified search code."/> 
  </concept> 
  <concept> 
    <code value="in"/> 
    <display value="In"/> 
    <definition value="The search parameter is a member of a Group or List, or the search parameter is a URI
     (relative or absolute) that identifies a value set, and the search parameter tests whether
     the value is present in the specified Group, List, or Value Set."/> 
  </concept> 
  <concept> 
    <code value="not-in"/> 
    <display value="Not In"/> 
    <definition value="The search parameter is a member of a Group or List, or the search parameter is a URI
     (relative or absolute) that identifies a value set, and the search parameter tests whether
     the value is NOT present in the specified Group, List, or Value Set."/> 
  </concept> 
  <concept> 
    <code value="of-type"/> 
    <display value="Of Type"/> 
    <definition value="The search parameter has the format system|code|value, where the system and code refer
     to a Identifier.type.coding.system and .code, and match if any of the type codes match.
     All 3 parts must be present."/> 
  </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.