This page is part of the FHIR Specification (v3.3.0: R4 Ballot 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
FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative |
Definition for Code System SearchParamType
<CodeSystem xmlns="http://hl7.org/fhir"> <id value="search-param-type"/> <meta> <lastUpdated value="2018-04-03T12:05:46.262+10:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <h2> SearchParamType</h2> <div> <p> Data types allowed to be used for search parameters.</p> </div> <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 "|", 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> </table> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="fhir"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status"> <valueString value="Normative"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="4"/> </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="3.3.0"/> <name value="SearchParamType"/> <status value="draft"/> <experimental value="false"/> <date value="2018-04-03T12:05:46+10: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 "|", 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> </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.