This page is part of the FHIR Specification (v0.11: DSTU 1 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

 

Definition for Value SetSearchParamType

Raw XML

<ValueSet xmlns="http://hl7.org/fhir">
  <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 defines it's own terms in the system http://hl7.org/fhir/search-param-type</p>
      <table>
        <tr>
          <td>
            <b>Code</b>
          </td>
          <td>
            <b>Display</b>
          </td>
          <td>
            <b>Definition</b>
          </td>
        </tr>
        <tr>
          <td>integer</td>
          <td/>
          <td>Search parameter must be a simple whole number.</td>
        </tr>
        <tr>
          <td>string</td>
          <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 and are delineated by double quotes, e.g. &quot;van Zanten&quot;.</td>
        </tr>
        <tr>
          <td>text</td>
          <td/>
          <td>Search parameter is on a long string. Used for text filter type search: it functions on
             searches within a body of text and may contain spaces to separate words. May match even
             if the separate words are found out of order. Text parameters are delineated by double
             quotes.</td>
        </tr>
        <tr>
          <td>date</td>
          <td/>
          <td>Search parameter is on a date (and should support :before and :after modifiers). The date
             format is the standard XML format, though other formats may be supported.</td>
        </tr>
        <tr>
          <td>token</td>
          <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</td>
          <td/>
          <td>A pair of resource type and resource id, separated by &quot;/&quot;. Matches when the
             resource reference resolves to a resource of the given type and id. The resource type
             may be omitted to search all types if used with the modifier :any.</td>
        </tr>
        <tr>
          <td>composite</td>
          <td/>
          <td>A composite search parameter that combines other search parameters together.</td>
        </tr>
      </table>
    </div>
  </text>
  <identifier value="http://hl7.org/fhir/vs/search-param-type"/>
  <name value="SearchParamType"/>
  <publisher value="HL7 (FHIR Project)"/>
  <telecom>
    <system value="url"/>
    <value value="http://hl7.org/fhir"/>
  </telecom>
  <telecom>
    <system value="email"/>
    <value value="fhir@lists.hl7.org"/>
  </telecom>
  <description value="Data types allowed to be used for search parameters"/>
  <status value="draft"/>
  <date value="2023-05-12T00:10:00"/>
  <define>
    <system value="http://hl7.org/fhir/search-param-type"/>
    <caseSensitive value="true"/>
    <concept>
      <code value="integer"/>
      <definition value="Search parameter must be a simple whole number."/>
    </concept>
    <concept>
      <code 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 and are delineated by double quotes, e.g. &quot;van Zanten&quot;."/>
    </concept>
    <concept>
      <code value="text"/>
      <definition value="Search parameter is on a long string. Used for text filter type search: it functions on
       searches within a body of text and may contain spaces to separate words. May match even
       if the separate words are found out of order. Text parameters are delineated by double
       quotes."/>
    </concept>
    <concept>
      <code value="date"/>
      <definition value="Search parameter is on a date (and should support :before and :after modifiers). The date
       format is the standard XML format, though other formats may be supported."/>
    </concept>
    <concept>
      <code 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"/>
      <definition value="A pair of resource type and resource id, separated by &quot;/&quot;. Matches when the
       resource reference resolves to a resource of the given type and id. The resource type
       may be omitted to search all types if used with the modifier :any."/>
    </concept>
    <concept>
      <code value="composite"/>
      <definition value="A composite search parameter that combines other search parameters together."/>
    </concept>
  </define>
</ValueSet>