TerminologyThis page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. 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 | Standards Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
Definition for Code SystemSearchParamType
{
"resourceType" : "CodeSystem",
"id" : "search-param-type",
"meta" : {
"lastUpdated" : "2023-03-26T15:21:02.749+11:00"
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This code system <code>http://hl7.org/fhir/search-param-type</code> 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><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>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
}],
"url" : "http://hl7.org/fhir/search-param-type",
"identifier" : [{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.4.12"
}],
"version" : "5.0.0",
"name" : "SearchParamType",
"title" : "SearchParamType",
"status" : "active",
"experimental" : false,
"date" : "2023-03-26T15:21:02+11:00",
"description" : "Data types allowed to be used for search parameters.",
"jurisdiction" : [{
"coding" : [{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}]
}],
"caseSensitive" : true,
"valueSet" : "http://hl7.org/fhir/ValueSet/search-param-type",
"content" : "complete",
"concept" : [{
"code" : "number",
"display" : "Number",
"definition" : "Search parameter SHALL be a number (a whole number, or a decimal)."
},
{
"code" : "date",
"display" : "Date/DateTime",
"definition" : "Search parameter is on a date/time. The date format is the standard XML format, though other formats may be supported."
},
{
"code" : "string",
"display" : "String",
"definition" : "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."
},
{
"code" : "token",
"display" : "Token",
"definition" : "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."
},
{
"code" : "reference",
"display" : "Reference",
"definition" : "A reference to another resource (Reference or canonical)."
},
{
"code" : "composite",
"display" : "Composite",
"definition" : "A composite search parameter that combines a search on two values together."
},
{
"code" : "quantity",
"display" : "Quantity",
"definition" : "A search parameter that searches on a quantity."
},
{
"code" : "uri",
"display" : "URI",
"definition" : "A search parameter that searches on a URI (RFC 3986)."
},
{
"code" : "special",
"display" : "Special",
"definition" : "Special logic applies to this parameter per the description of the search parameter."
}]
}
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.
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:22+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change