DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). 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-param-type.xml

Raw XML (canonical form)

Definition for Value SetSearchParamType

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="search-param-type"/>
  <meta>
    <lastUpdated value="2015-10-24T07:41:03.495+11: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>SearchParamType</h2>
      <p>Data types allowed to be used for search parameters.</p>
      <p>This value set has an inline code system http://hl7.org/fhir/search-param-type, 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>number
            <a name="number"> </a>
          </td>
          <td>Number</td>
          <td>Search parameter SHALL be a number (a whole number, or a decimal).</td>
        </tr>
        <tr>
          <td>date
            <a name="date"> </a>
          </td>
          <td>Date/DateTime</td>
          <td>Search parameter is on a date/time. The date format is the standard XML format, though
             other formats may be supported.</td>
        </tr>
        <tr>
          <td>string
            <a name="string"> </a>
          </td>
          <td>String</td>
          <td>Search parameter is a simple string, like a name part. Search is case-insensitive and
             accent-insensitive. May match just the start of a string. String parameters may contain
             spaces.</td>
        </tr>
        <tr>
          <td>token
            <a name="token"> </a>
          </td>
          <td>Token</td>
          <td>Search parameter on a coded element or identifier. May be used to search through the text,
             displayname, code and code/codesystem (for codes) and label, system and key (for identifier).
             Its value is either a string or a pair of namespace and value, separated by a &quot;|&quot;,
             depending on the modifier used.</td>
        </tr>
        <tr>
          <td>reference
            <a name="reference"> </a>
          </td>
          <td>Reference</td>
          <td>A reference to another resource.</td>
        </tr>
        <tr>
          <td>composite
            <a name="composite"> </a>
          </td>
          <td>Composite</td>
          <td>A composite search parameter that combines a search on two values together.</td>
        </tr>
        <tr>
          <td>quantity
            <a name="quantity"> </a>
          </td>
          <td>Quantity</td>
          <td>A search parameter that searches on a quantity.</td>
        </tr>
        <tr>
          <td>uri
            <a name="uri"> </a>
          </td>
          <td>URI</td>
          <td>A search parameter that searches on a URI (RFC 3986).</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.6"/>
  </extension>
  <url value="http://hl7.org/fhir/ValueSet/search-param-type"/>
  <version value="1.0.2"/>
  <name value="SearchParamType"/>
  <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-10-24T07:41:03+11:00"/>
  <description value="Data types allowed to be used for search parameters."/>
  <codeSystem>
    <extension url="http://hl7.org/fhir/StructureDefinition/valueset-oid">
      <valueUri value="urn:oid:2.16.840.1.113883.4.642.1.6"/>
    </extension>
    <system value="http://hl7.org/fhir/search-param-type"/>
    <version value="1.0.2"/>
    <caseSensitive value="true"/>
    <concept>
      <code value="number"/>
      <display value="Number"/>
      <definition value="Search parameter SHALL be a number (a whole number, or a decimal)."/>
    </concept>
    <concept>
      <code value="date"/>
      <display value="Date/DateTime"/>
      <definition value="Search parameter is on a date/time. The date format is the standard XML format, though
       other formats may be supported."/>
    </concept>
    <concept>
      <code value="string"/>
      <display value="String"/>
      <definition value="Search parameter is a simple string, like a name part. Search is case-insensitive and
       accent-insensitive. May match just the start of a string. String parameters may contain
       spaces."/>
    </concept>
    <concept>
      <code value="token"/>
      <display value="Token"/>
      <definition value="Search parameter on a coded element or identifier. May be used to search through the text,
       displayname, code and code/codesystem (for codes) and label, system and key (for identifier).
       Its value is either a string or a pair of namespace and value, separated by a &quot;|&quot;,
       depending on the modifier used."/>
    </concept>
    <concept>
      <code value="reference"/>
      <display value="Reference"/>
      <definition value="A reference to another resource."/>
    </concept>
    <concept>
      <code value="composite"/>
      <display value="Composite"/>
      <definition value="A composite search parameter that combines a search on two values together."/>
    </concept>
    <concept>
      <code value="quantity"/>
      <display value="Quantity"/>
      <definition value="A search parameter that searches on a quantity."/>
    </concept>
    <concept>
      <code value="uri"/>
      <display value="URI"/>
      <definition value="A search parameter that searches on a URI (RFC 3986)."/>
    </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.