Release 5 Draft Ballot

Codesystem-search-param-type.json

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

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

Definition for Code System SearchParamType

{
  "resourceType" : "CodeSystem",
  "id" : "search-param-type",
  "meta" : {
    "lastUpdated" : "2021-05-06T18:01:32.124+00:00"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div>!-- Snipped for Brevity --></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.1.12"
  }],
  "version" : "4.6.0",
  "name" : "SearchParamType",
  "title" : "SearchParamType",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-05-06T18:01:32+00:00",
  "description" : "Data types allowed to be used for search parameters.",
  "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.