Formal value Set definition (identifier ): XML or JSON.
See the full registry of codes defined as part of FHIR.
The OID for the value set is (OIDs are not used in FHIR, but may be used in HL7 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) |
Lvl | A few code lists that FHIR defines are hierarchical - each code is assigned a level. See Code System for further information. |
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). If the code is in italics, this indicates that the code is not selectable ('Abstract') |
Display | The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application |
Definition | An explanation of the meaning of the concept |
Comments | Additional notes about how to use the code |
This template should not be used any more
Summary
Code System URL: | |
Value Set URL: | |
Definition: |
Formal value Set definition : XML or JSON.
OIDs
Code System OID: | |
Value Set OID: | |
Note: these OIDs are not used in FHIR, but may be used in HL7 v3, or OID based terminology systems |
See the full registry of value sets defined as part of FHIR.
Explanation of the columns that may appear on this page:
Lvl | A few code lists that FHIR defines are hierarchical - each code is assigned a level. See Code System for further information. |
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). If the code is in italics, this indicates that the code is not selectable ('Abstract') |
Display | The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application |
Definition | An explanation of the meaning of the concept |
Comments | Additional notes about how to use the code |
In addition, this page will include mappings to HL7 v2 or HL7 v3 code where these have been defined.
Maturity Level: N/A | Standards Status: Informative |
R3 : R4 Conversion maps for.
Functional status for this map: (see documentation)
This is a value set defined by the FHIR projec
Detailed Descriptions: XML or JSON.
The OID for the value set is (OIDs are not used in FHIR, but may be used in v3, or OID based terminology systems).
See the full registry of value sets defined as part of FHIR.
This is a value set define
Summary
Defining URL: | |
Version: | |
Name: | |
Title: | |
Definition: | |
Committee: | |
OID: | |
Source Resource | XML / JSON |
See the full registry of value sets defined as part of FHIR.
Explanation of the columns that may appear on this page:
Lvl | A few code lists that FHIR defines are hierarchical - each code is assigned a level. For value sets, levels are mostly used to organize codes for user convenience, but may follow code system hierarchy - see Code System for further information |
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). If the code is in italics, this indicates that the code is not selectable ('Abstract') |
Display | The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application |
Definition | An explanation of the meaning of the concept |
Comments | Additional notes about how to use the code |
Maturity Level: 0 | Standards Status:Trial Use |
For example, we have a Condition.code and the applicable profile binds the code to the value set http://hl7.org/fhir/ValueSet/condition-code with an Extensible binding:
{ "path": "Condition.code", "definition" : "Identification of the condition, problem or diagnosis." "binding": { "strength": "extensible", "valueSetCanonical": "http://hl7.org/fhir/ValueSet/condition-code" } }
This value set includes all SNOMED CT concepts that are clinical findings.
{ "resourceType": "Condition", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "39065001", "display": "Burn of ear" } ], "text": "Burnt Ear" }, "subject": { "reference": "Patient/example" } }
This concept (code = 39065001) is included in the value set so the instance is valid.
{ "resourceType": "Condition", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "312824007", "display": "Family history of cancer of colon" } ] }, "subject": { "reference": "Patient/example" } }
This SNOMED CT concept is not a clinical finding. So is it valid? With the extensible binding 2 questions must be answered:
So this example is most likely valid (based on human review).
{ "resourceType": "Condition", "code": { "coding": [ { "system": "http://my-local-organization.com", "code": "XYZ123", "display": "Severe pneumococcal pneumonia" } ] }, "subject": { "reference": "Patient/example" } }
This Condition instance contains a local code. Is it a valid instance? With the extensible binding, the same questions as before have to be answered:
What if we would like to send our local code for ‘Severe pneumococcal pneumonia’ in the instance along with the SNOMED CT code 233607000 for ‘Pneumococcal pneumonia’? Because the data type for Condition.code is CodeableConcept, we can do that using an additional Coding (as a translation):
{ "resourceType": "Condition", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "233607000", "display": "Pneumococcal pneumonia" }, { "system": "http://my-local-organization.com", "code": "XYZ123", "display": "Severe pneumococcal pneumonia" } ] }, "subject": { "reference": "Patient/example" } }
So this is a valid Condition instance which contains both the applicable SNOMED CT code from the extensibly bound condition-code value set for ‘Pneumococcal pneumonia’ as well as my organization's local code for ‘Severe pneumococcal pneumonia’.
The choice of code with a Preferred binding is considerably simpler than for an Extensional binding, because the Preferred binding is a suggestion from the developers of the resource or profile about which codes they believe would be best to use to represent this data, but in a particular instance you are free to choose to follow that suggestion or not depending on your particular desires and needs and there are no specific conformance expectations regarding that choice.
So in this case we have a Condition.code and the applicable profile binds the code to the value set http://hl7.org/fhir/ValueSet/condition-code with a Preferred binding:
{ "path": "Condition.code", "definition" : "Identification of the condition, problem or diagnosis." "binding": { "strength": "preferred", "valueSetCanonical": "http://hl7.org/fhir/ValueSet/condition-code" } }
With the Preferred binding all of the following instances (and many other possibilities) are valid instances of the Condition resource:
{ "resourceType": "Condition", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "39065001", "display": "Burn of ear" } ], "text": "Burnt Ear" }, "subject": { "reference": "Patient/example" } }
{ "resourceType": "Condition", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "312824007", "display": "Family history of cancer of colon" } ] }, "subject": { "reference": "Patient/example" } }
{ "resourceType": "Condition", "code": { "coding": [ { "system": "http://my-local-organization.com", "code": "XYZ123", "display": "Severe pneumococcal pneumonia" } ] }, "subject": { "reference": "Patient/example" } }
{ "resourceType": "Condition", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "233607000", "display": "Pneumococcal pneumonia" }, { "system": "http://my-local-organization.com", "code": "XYZ123", "display": "Severe pneumococcal pneumonia" } ] }, "subject": { "reference": "Patient/example" } }
This table contains a list of all the terminology bindings in FHIR.
Maturity Level: N/A | Standards Status:Informative |
This table contains a list of all the mappings between value sets that are defined as part of the FHIR specification.