Release 5 Draft Ballot

Codesystem-search-param-type.xml

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

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

Definition for Code System SearchParamType

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

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="search-param-type"/> 
  <meta> 
    <lastUpdated value="2021-05-06T18:01:32.124+00:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This code system http://hl7.org/fhir/search-param-type 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">number
            <a name="search-param-type-number"> </a> 
          </td> 
          <td> Number</td> 
          <td> Search parameter SHALL be a number (a whole number, or a decimal).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">date
            <a name="search-param-type-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 style="white-space:nowrap">string
            <a name="search-param-type-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 style="white-space:nowrap">token
            <a name="search-param-type-token"> </a> 
          </td> 
          <td> Token</td> 
          <td> Search parameter on a coded element or identifier. May be used to search through the text,
             display, 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 style="white-space:nowrap">reference
            <a name="search-param-type-reference"> </a> 
          </td> 
          <td> Reference</td> 
          <td> A reference to another resource (Reference or canonical).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">composite
            <a name="search-param-type-composite"> </a> 
          </td> 
          <td> Composite</td> 
          <td> A composite search parameter that combines a search on two values together.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">quantity
            <a name="search-param-type-quantity"> </a> 
          </td> 
          <td> Quantity</td> 
          <td> A search parameter that searches on a quantity.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">uri
            <a name="search-param-type-uri"> </a> 
          </td> 
          <td> URI</td> 
          <td> A search parameter that searches on a URI (RFC 3986).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">special
            <a name="search-param-type-special"> </a> 
          </td> 
          <td> Special</td> 
          <td> Special logic applies to this parameter per the description of the search parameter.</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="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
    <valueCode value="4.0.0"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/> 
  </extension> 
  <url value="http://hl7.org/fhir/search-param-type"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.1.12"/> 
  </identifier> 
  <version value="4.6.0"/> 
  <name value="SearchParamType"/> 
  <title value="SearchParamType"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2021-05-06T18:01:32+00:00"/> 
  <description value="Data types allowed to be used for search parameters."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/search-param-type"/> 
  <content value="complete"/> 
  <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,
     display, 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 (Reference or canonical)."/> 
  </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> 
  <concept> 
    <code value="special"/> 
    <display value="Special"/> 
    <definition value="Special logic applies to this parameter per the description of the search parameter."/> 
  </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.