US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This is not an authorized publication; it is the continuous build for version 7.0.0-ballot). This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions
Page standards status: Informative |
This page lists all the ValueSets, CodeSystems, and ConceptMaps defined as part of the US Core Implementation Guide. For more information on using codes in US Core, see the FHIR Terminology section in the FHIR specification and the Coded Elements section in this guide.
These value sets have been defined for this implementation guide.
The value set URI for all the the US Core Profiles are listed below. These include value sets from the FHIR Specification, HL7 Terminology (THO) and the Value Set Authority Center (VSAC). See the following section for a list of all the codesystems used US Core.
[http://hl7.org/fhir/ValueSet/address-use | 4.0.1](http://hl7.org/fhir/ValueSet/address-use | 4.0.1) |
[http://hl7.org/fhir/ValueSet/contact-point-system | 4.0.1](http://hl7.org/fhir/ValueSet/contact-point-system | 4.0.1) |
[http://hl7.org/fhir/ValueSet/encounter-status | 4.0.1](http://hl7.org/fhir/ValueSet/encounter-status | 4.0.1) |
[http://hl7.org/fhir/ValueSet/fm-status | 4.0.1](http://hl7.org/fhir/ValueSet/fm-status | 4.0.1) |
[http://hl7.org/fhir/ValueSet/location-status | 4.0.1](http://hl7.org/fhir/ValueSet/location-status | 4.0.1) |
[http://hl7.org/fhir/ValueSet/medicationdispense-status | 4.0.1](http://hl7.org/fhir/ValueSet/medicationdispense-status | 4.0.1) |
[http://hl7.org/fhir/ValueSet/mimetypes | 4.0.1](http://hl7.org/fhir/ValueSet/mimetypes | 4.0.1) |
[http://hl7.org/fhir/ValueSet/name-use | 4.0.1](http://hl7.org/fhir/ValueSet/name-use | 4.0.1) |
[http://hl7.org/fhir/ValueSet/observation-status | 4.0.1](http://hl7.org/fhir/ValueSet/observation-status | 4.0.1) |
[http://hl7.org/fhir/ValueSet/questionnaire-answers-status | 4.0.1](http://hl7.org/fhir/ValueSet/questionnaire-answers-status | 4.0.1) |
[http://hl7.org/fhir/ValueSet/request-intent | 4.0.1](http://hl7.org/fhir/ValueSet/request-intent | 4.0.1) |
[http://hl7.org/fhir/ValueSet/request-status | 4.0.1](http://hl7.org/fhir/ValueSet/request-status | 4.0.1) |
[http://hl7.org/fhir/ValueSet/ucum-vitals-common | 4.0.1](http://hl7.org/fhir/ValueSet/ucum-vitals-common | 4.0.1) |
See the FHIR terminology section for a complete discussion on code systems and a list of code system names used in FHIR. Most code systems used in this guide are defined in the base FHIR specification. However, the following code systems are unique to this guide and not listed in the base FHIR specification. If a URI is listed here, it SHALL be used in the US Core profiles to identify the code system in preference to any other code system URI.
URI | Source | Comment | OID (for non-FHIR systems) |
---|---|---|---|
https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets |
CMS | Healthcare Common Procedure Coding System (HCPCS) level II alphanumeric codes | 2.16.840.1.113883.6.285 |
http://www.cms.gov/Medicare/Coding/ICD10 |
CMS | International Classification of Diseases, 10th Revision, Procedure Coding System (ICD-10-PCS) - See ICD-10 PCS Codes for online access to codes for general information purposes. | 2.16.840.1.113883.6.4 |
http://www.ada.org/cdt |
ADA | Code on Dental Procedures and Nomenclature | 2.16.840.1.113883.6.13 |
https://www.usps.com |
USPS | United States Postal Service Two–Letter State and Possession Abbreviations | 2.16.840.1.113883.6.92 |
The value set used in the US Core Profiles includes codes from following Code Systems URIs:
http://hl7.org/fhir/sid/cvx
http://hl7.org/fhir/sid/icd-10-cm
http://hl7.org/fhir/sid/icd-9-cm
urn:ietf:bcp:13
urn:ietf:bcp:47
urn:oid:2.16.840.1.113883.6.238
This guide links terminology directly to the FHIR® Terminology Service for VSAC Resources (Value Set Authority Center (VSAC) where applicable using a RESTful API service for accessing the VSAC value sets and supported code systems. The following valuesets used in US core are defined by VSAC:
To view the value set expansion in the VSAC user interface, use:
GET https://vsac.nlm.nih.gov/ValueSet/[VSAC OID]/expansion
An example of this is shown in the screenshots below.
To fetch the FHIR ValueSet resource (in other words, the value set definition), use:
GET https://cts.nlm.nih.gov/fhir/ValueSet/[VSAC OID]
To fetch the FHIR ValueSet resource expansion use the FHIR $expand
operation:
GET https://cts.nlm.nih.gov/fhir/ValueSet/[VSAC OID]/$expand
For more information, refer to the FHIR Terminology Service for VSAC Resources
For example, the US Core Smoking Status Observation Profile valueCodeableConcept
element has a preferred binding to the Smoking Status value set. To access it in VSAC, click on the link to https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.38/expansion
:
The reader is redirected to the VSAC login page to enter an API Key (only one login is required per session):
After successfully entering the API Key, the value set can be inspected, downloaded, etc., using the VSAC User interface, as shown in the figure below. This FHIR ValueSet resource can also be fetched using the URL https://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.38
, and the FHIR ValueSet expansion using the URL https://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.38/$expand
.