. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.06: DSTU 1 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 R2
Many elements in the FHIR resources are assigned a type of code, Coding or CodeableConcept. These elements contain codes that have defined meanings and come from sets of codes of varying sophistication and size. In many simple cases, the set of codes is a short list defined specifically for the element. In other cases, the list of codes is taken from a large and complex terminology or ontology such as SNOMED-CT or OBO.
All these elements of type code, Coding or CodeableConcept are given a "binding name" that defines the set of possible codes that can be used in the element in question. In Resource Profiles, the elements can be assigned a new binding name that defines a new set of possible codes. The set of codes defined by a profile must be a subset of the set of codes defined in the base resource and those defined by any imported profiles. Binding Names can identify sets of codes in the following ways:
| value set | The binding name has an associated URL which is a reference to a Value Set Resource that provides a formal definition of the set of possible codes |
| code list | The binding name is associated with a simple list of codes and definitions from some identified code system (by SID, URI, OID or UUID). In resource definitions, the system reference may be omitted and a list of custom codes with definitions supplied (this is for status and workflow fields that applications need to know). In formal terms, this is merely a locally-defined value set. |
| reference | The binding name has an associated URL which refers to some external standard or specification that defines the possible codes |
| special | The binding points to a list of concepts defined as part of FHIR itself (see below for possible values) |
Value set and code list bindings also have two properties that govern their use - extensibility and conformance:
| complete | No additional codes are to be used beyond the list provided |
| extensible | Some concepts won't be covered by the provided value set, so supplemental codes or plain text may be needed |
| required |
Only codes in the specified set are allowed. Profiles can only specify a subset of the
defined codes. If the strength is 'extensible', other codes may be used for concepts not covered by the value set but cannot be used for concepts covered by the bound code list, even if a profile constrains out some of those codes). Specifications may render this as "SHALL" |
| preferred |
For greater interoperability, implementers are strongly encouraged to use the bound set of
codes, however alternate codes may be used in profiles if necessary without being considered
non-conformant. Specifications may render this as "SHOULD" |
| example |
The codes in the set are an example to illustrate the meaning of the field.
There is no particular preference for its use. Specifications may render this as "MAY" |
See the Bindings List for a full list of the binding names defined for all FHIR resources.
This specification defines the following names (URIs) as fixed names that may be used in the system element of the Identifier Coding or CodeableConcept data types. If a URI is defined here, it must be used in preference to other identifying mechanisms such as OIDs found in the HL7 OID registry.
| URI | Source | Comment |
|---|---|---|
| Code Systems | ||
| http://snomed.info | SNOMED-CT: (IHTSDO) | The version, module, etc. may be appended to this uri following the IHTSDO specifications OID=2.16.840.1.113883.6.96 |
| http://loinc.org | LOINC (LOINC.org) |
The version of LOINC may be appended to this uri like so: http://loinc.org?v=2.36 |
| http://unitsofmeasure.org | UCUM: (UnitsOfMeasure.org) | Generally used in the Quantity Data Type OID=2.16.840.1.113883.6.8 |
| http://hl7.org/fhir/sid/icd-10 | ICD-10 International (WHO) | OID=2.16.840.1.113883.6.3 |
| http://hl7.org/fhir/sid/icd-9 | ICD-9 USA (CDC) | OID=2.16.840.1.113883.6.42 |
| http://hl7.org/fhir/sid/v2-[X] | Version 2 table code | [X] is the 4 digit identifier for a table. e.g. http://hl7.org/fhir/sid/v2-0203 OID=2.16.840.1.113883.12.[X] |
| http://hl7.org/fhir/sid/atc | Anatomical Therapeutic Chemical Classification System (WHO) | OID=2.16.840.1.113883.6.73 |
| Identifier Systems | ||
| urn:ietf:rfc:3986 | URIs (W3C) | As defined by RFC 3986 (with many schemes defined in many RFCs).
OIDs and UUIDs are represented in their URN form (urn:oid: and urn:uuid:
- plain oid: and uuid: are not used). Note that UUIDs are always lowercase in a IRI No OID |
| http://hl7.org/fhir/sid/us-ssn | SSN (W3C) | SSN for USA. Represented with dashes removed OID=2.16.840.1.113883.4.1 |
todo: add http://tools.ietf.org/html/rfc5141
Important Note: The set of sids listed above is incomplete and subject to change. Some values may be dropped and others will likely be added in the coming months as HL7 institutes a formal process for determining what code systems and identifier types should be handled in this manner rather than as OIDs or other identifiers.
In addition to this, a number of code systems are defined informally through the specification. This table enumerates them and assigns sid and OID values for them, though these are not generally used directly in this specification:
| Special Values | http://hl7.org/fhir/special-values | 2.16.840.1.113883.6.305 |
| Resource Types | http://hl7.org/fhir/resource-types | 2.16.840.1.113883.6.306 |
| Logical Interactions (RESTful framework) | http://hl7.org/fhir/rest-operations | 2.16.840.1.113883.6.308 |
| Message Events (Messaging framework) | http://hl7.org/fhir/message-events | 2.16.840.1.113883.6.307 |
Note that all the codes in these code systems are case sensitive and must be used in lowercase. All the codes in these code systems have their own uri of the format http://hl7.org/fhir/sid/[system]/[code]. E.g. The resource type "Person" has the full uri http://hl7.org/fhir/sid/resource-types/person.
Internally defined codes useful throughout the specification where Coding or CodeableConcept is used. These are defined by the code system "http://hl7.org/fhir/special-values" which has OID 2.16.840.1.113883.6.305.
| code | Display / Print Name | Comment |
|---|---|---|
| true | Boolean true | |
| false | Boolean false | |
| trace | The content is greater than zero, but too small to be quantified | used in formulations |
| sufficient | The specific quantity is not known, but is known to be non-zero and is not specified because it makes up the bulk of the material. | (e.g. 'Add 10mg of ingredient X, 50mg of ingredient Y, and sufficient quantity of water to 100mL.' This code would be used to express the quantity of water. ) |
| withdrawn | The value is no longer available | |
| nil known | The are no known applicable values in this context | e.g. No known allergies / No known Medical History / No known medications |
In several places, the resource types themselves are used as either codes or identifiers. Where necessary, these are identified by the uri "http://hl7.org/fhir/resource-types". This is a formal list of the resource type codes:
| Agent | A person who represents an organization, and is authorized to perform actions on its behalf |
| Animal | An animal (non-human) that has relevance to the care process |
| Conformance | A conformance statement about how an application or implementation supports FHIR or the set of requirements for a desired implementation |
| Coverage | Financial instrument by which payment information for health care |
| Device | This resource identifies a manufactured entity that is used in the provision of healthcare. The device may be a machine, an insert, a computer, an application, etc |
| Document | A documentation of healthcare-related information that is assembled together into a single statement of meaning that establishes its own context. A document is composed of a set of resources that include both human and computer readable portions. A human may attest to the accuracy of the human readable portion, and may authenticate and/or sign the entire whole. A document may be kept as a set of logically linked resources, or they may be bundled together in an atom feed |
| Group | Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization |
| IssueReport | Error, warning or information messages that result from a system action |
| LabReport | The findings and interpretation of pathology tests performed on tissues and body fluids. This is typically done in a laboratory but may be done in other environments such as at the point of care |
| List | A set of information summarized from a list of other resources |
| MedicationAdministration | Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care provider |
| Message | A transmission requesting action on a bundle of one or more resources or a response to such a request |
| Observation | Simple assertions and measurements made about a patient, device or other subject |
| Organization | For any company/corporation/institution/government department that has relevance to the care process |
| Patient | A patient is a person or animal that is receiving care |
| Person | A person who is involved in the healthcare process |
| Prescription | Directions provided by a prescribing practitioner for a specific medication to be administered (and possibly) supplied to an individual |
| Problem | Use to record detailed information about problems or diagnoses recognised by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a Problem List or a Summary Statement, such as a Discharge Summary |
| Profile | A Resource Profile - a statement of use of FHIR. It may include constraints on Resources, Data Types, Terminology Binding Statements and Extension Definitions |
| Provenance | Provenance information associated with another resource that can be used to help determine its reliability or trace where the information in it came from. The focus of the provenance resource is record keeping, audit and traceability, not clinical meaning |
| SecurityEvent | A record of an event |
| Test | [Template] Master Definition |
| ValueSet | Value Set - a set of defined codes from one or more code systems that may be bound to a context |
| XdsEntry | An entry in an XDS registry |
| XdsEntry2 | An entry in an XDS registry |
| XdsFolder | An organised collection of documents that belong to a patient. The documents are collected by their clinical function |
| Admission | Yet to be defined |
| AnatomicalLocation | Yet to be defined |
| Food | Yet to be defined |
| InterestOfCare | Yet to be defined |
| Location | Yet to be defined |
| Medication | Yet to be defined |
| Procedure | Yet to be defined |
| Specimen | Yet to be defined |
| Substance | Yet to be defined |
A resource type or a data type. Where necessary, these are identified by the uri "http://hl7.org/fhir/resource-types" and "http://hl7.org/fhir/data-types". This is a formal list of the data type codes:
| Address | There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for addresses all around the world |
| Attachment | For referring to data content defined in other formats. |
| Choice | A code taken from a short list of codes that are not defined in a formal code system |
| CodeableConcept | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text |
| Coding | A reference to a code defined by a terminology system |
| Contact | All kinds of technology mediated contact details for a person or organisation, including telephone, email, etc. |
| Extension | Optional Extensions Element - found in all resources |
| HumanId | An identifier that humans use. This is different from a system identifier because identifiers that humans use are regularly changed or retired due to human intervention and error. Note that a human identifier may be a system identifier on some master system but becomes a human identifier elsewhere due to how it is exchanged between humans. Driver's license numbers are a good example of this. Also, because human mediated identifiers are often invoked as implicit links to external business processes, such identifiers are often associated with multiple different resources. |
| HumanName | A human's name with the ability to identify parts and usage |
| Identifier | A technical identifier - identifies some entity uniquely and unambiguously |
| Narrative | A human readable formatted text, including images |
| Period | A time period defined by a start and end time. |
| Quantity | A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies |
| Range | A set of ordered Quantities defined by a low and high limit. |
| Ratio | A ratio of two Quantity values - a numerator and a denominator. |
| ResourceReference | A reference from one resource to another |
| Schedule | A schedule that specifies an event that may occur multiple times. Schedules are not used for recording when things did happen, but when they are expected or requested to occur. |
This is an old version of FHIR retained for archive purposes. Do not use for anything else
Implementers are welcome to experiment with the content defined here, but should note that the contents are subject to change without prior notice.
© HL7.org 2011 - 2012. FHIR v0.06 generated on Tue, Dec 4, 2012 00:04+1100. License