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
Data types allowed to be used for search parameters
Formal value Set definition (identifier http://hl7.org/fhir/vs/search-param-type): XML or JSON.
This value set defines its own codes:
Data types allowed to be used for search parameters
This value set defines it's own terms in the system http://hl7.org/fhir/search-param-type
| Code | Display | Definition |
| integer | Search parameter must be a simple whole number. | |
| string | 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. "van Zanten". | |
| text | 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. | |
| date | 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. | |
| token | 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 "/", depending on the modifier used. | |
| reference | A pair of resource type and resource id, separated by "/". 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. | |
| composite | A composite search parameter that combines other search parameters together. |
These codes are used in the following places:
See the full registry of codes defined as part of FHIR.
The OID for the value set is 2.16.840.1.113883.4.642.2.9 (and the OID for the implicit code system is 2.16.840.1.113883.4.642.1.9) (OIDs are not used in FHIR, but may be used in v3, or OID based terminology systems).
Explanation of the columns that may appear on this page:
| Id | The internal identifier for the concept (when the value set defines its own codes) |
| Level | A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies |
| Source | The source of the definition of the code (when the value set draws in codes defined elsewhere) |
| Code | The code (used as the code in the resource instance) |
| Display | The display (used in the display element of a Coding) |
| Definition | An explanation of the meaning of the concept |
| Comments | Additional notes about how to use the code |