US Core Implementation Guide
7.0.0-ballot - STU6 United States of America flag

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

Terminology

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.

Value Sets

These value sets have been defined for this implementation guide.

Value Set URIs Used in US Core

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.

  1. http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4
  2. http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6
  3. http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32
  4. http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30
  5. http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.54
  6. http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1186.8
  7. http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.3
  8. http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.38
  9. http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
  10. http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591
  11. [http://hl7.org/fhir/ValueSet/address-use 4.0.1](http://hl7.org/fhir/ValueSet/address-use 4.0.1)
  12. http://hl7.org/fhir/ValueSet/administrative-gender
  13. http://hl7.org/fhir/ValueSet/allergyintolerance-clinical
  14. http://hl7.org/fhir/ValueSet/allergyintolerance-verification
  15. http://hl7.org/fhir/ValueSet/care-plan-category
  16. http://hl7.org/fhir/ValueSet/care-plan-intent
  17. http://hl7.org/fhir/ValueSet/care-team-status
  18. http://hl7.org/fhir/ValueSet/clinical-findings
  19. http://hl7.org/fhir/ValueSet/condition-category
  20. http://hl7.org/fhir/ValueSet/condition-clinical
  21. http://hl7.org/fhir/ValueSet/condition-ver-status
  22. http://hl7.org/fhir/ValueSet/contact-point-system
  23. [http://hl7.org/fhir/ValueSet/contact-point-system 4.0.1](http://hl7.org/fhir/ValueSet/contact-point-system 4.0.1)
  24. http://hl7.org/fhir/ValueSet/contact-point-use
  25. http://hl7.org/fhir/ValueSet/coverage-class
  26. http://hl7.org/fhir/ValueSet/data-absent-reason
  27. http://hl7.org/fhir/ValueSet/device-kind
  28. http://hl7.org/fhir/ValueSet/diagnostic-report-status
  29. http://hl7.org/fhir/ValueSet/diagnostic-service-sections
  30. http://hl7.org/fhir/ValueSet/document-classcodes
  31. http://hl7.org/fhir/ValueSet/document-reference-status
  32. http://hl7.org/fhir/ValueSet/encounter-participant-type
  33. http://hl7.org/fhir/ValueSet/encounter-reason
  34. [http://hl7.org/fhir/ValueSet/encounter-status 4.0.1](http://hl7.org/fhir/ValueSet/encounter-status 4.0.1)
  35. http://hl7.org/fhir/ValueSet/event-status
  36. [http://hl7.org/fhir/ValueSet/fm-status 4.0.1](http://hl7.org/fhir/ValueSet/fm-status 4.0.1)
  37. http://hl7.org/fhir/ValueSet/formatcodes
  38. http://hl7.org/fhir/ValueSet/goal-start-event
  39. http://hl7.org/fhir/ValueSet/goal-status
  40. http://hl7.org/fhir/ValueSet/identifier-type
  41. http://hl7.org/fhir/ValueSet/immunization-status
  42. http://hl7.org/fhir/ValueSet/immunization-status-reason
  43. [http://hl7.org/fhir/ValueSet/location-status 4.0.1](http://hl7.org/fhir/ValueSet/location-status 4.0.1)
  44. [http://hl7.org/fhir/ValueSet/medicationdispense-status 4.0.1](http://hl7.org/fhir/ValueSet/medicationdispense-status 4.0.1)
  45. http://hl7.org/fhir/ValueSet/medicationrequest-category
  46. http://hl7.org/fhir/ValueSet/medicationrequest-intent
  47. http://hl7.org/fhir/ValueSet/medicationrequest-status
  48. [http://hl7.org/fhir/ValueSet/mimetypes 4.0.1](http://hl7.org/fhir/ValueSet/mimetypes 4.0.1)
  49. [http://hl7.org/fhir/ValueSet/name-use 4.0.1](http://hl7.org/fhir/ValueSet/name-use 4.0.1)
  50. http://hl7.org/fhir/ValueSet/observation-category
  51. http://hl7.org/fhir/ValueSet/observation-codes
  52. http://hl7.org/fhir/ValueSet/observation-status
  53. [http://hl7.org/fhir/ValueSet/observation-status 4.0.1](http://hl7.org/fhir/ValueSet/observation-status 4.0.1)
  54. http://hl7.org/fhir/ValueSet/provenance-agent-type
  55. http://hl7.org/fhir/ValueSet/questionnaire-answers
  56. [http://hl7.org/fhir/ValueSet/questionnaire-answers-status 4.0.1](http://hl7.org/fhir/ValueSet/questionnaire-answers-status 4.0.1)
  57. http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
  58. [http://hl7.org/fhir/ValueSet/request-intent 4.0.1](http://hl7.org/fhir/ValueSet/request-intent 4.0.1)
  59. http://hl7.org/fhir/ValueSet/request-status
  60. [http://hl7.org/fhir/ValueSet/request-status 4.0.1](http://hl7.org/fhir/ValueSet/request-status 4.0.1)
  61. http://hl7.org/fhir/ValueSet/servicerequest-category
  62. http://hl7.org/fhir/ValueSet/subscriber-relationship
  63. http://hl7.org/fhir/ValueSet/ucum-common
  64. [http://hl7.org/fhir/ValueSet/ucum-vitals-common 4.0.1](http://hl7.org/fhir/ValueSet/ucum-vitals-common 4.0.1)
  65. http://hl7.org/fhir/us/core/ValueSet/birthsex
  66. http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
  67. http://hl7.org/fhir/us/core/ValueSet/detailed-race
  68. http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category
  69. http://hl7.org/fhir/us/core/ValueSet/omb-race-category
  70. http://hl7.org/fhir/us/core/ValueSet/simple-language
  71. http://hl7.org/fhir/us/core/ValueSet/us-core-clinical-result-observation-category
  72. http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code
  73. http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category
  74. http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-report-and-note-codes
  75. http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition
  76. http://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category
  77. http://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type
  78. http://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type
  79. http://hl7.org/fhir/us/core/ValueSet/us-core-goal-description
  80. http://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes
  81. http://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status
  82. http://hl7.org/fhir/us/core/ValueSet/us-core-observation-smoking-status-status
  83. http://hl7.org/fhir/us/core/ValueSet/us-core-problem-or-health-concern
  84. http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code
  85. http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
  86. http://hl7.org/fhir/us/core/ValueSet/us-core-screening-assessment-condition-category
  87. http://hl7.org/fhir/us/core/ValueSet/us-core-screening-assessment-observation-category
  88. http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
  89. http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category
  90. http://hl7.org/fhir/us/core/ValueSet/us-core-smoking-status-observation-codes
  91. http://hl7.org/fhir/us/core/ValueSet/us-core-survey-codes
  92. http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
  93. http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs
  94. http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
  95. http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
  96. http://terminology.hl7.org/ValueSet/v3-TribalEntityUS

Code Systems

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.

Code systems published in this IG*- Includes US Core defined code systems and externally defined code systems


Externally Published code systems

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

Code System URIs Used in US Core

The value set used in the US Core Profiles includes codes from following Code Systems URIs:

  1. http://hl7.org/fhir/CodeSystem/medicationrequest-intent
  2. http://terminology.hl7.org/CodeSystem/medicationdispense-status
  3. http://hl7.org/fhir/CodeSystem/medicationrequest-status
  4. http://hl7.org/fhir/address-use
  5. http://hl7.org/fhir/administrative-gender
  6. http://hl7.org/fhir/care-team-status
  7. http://hl7.org/fhir/contact-point-system
  8. http://hl7.org/fhir/contact-point-use
  9. http://hl7.org/fhir/diagnostic-report-status
  10. http://hl7.org/fhir/document-reference-status
  11. http://hl7.org/fhir/encounter-status
  12. http://hl7.org/fhir/event-status
  13. http://hl7.org/fhir/fm-status
  14. http://hl7.org/fhir/goal-status
  15. http://hl7.org/fhir/location-status
  16. http://hl7.org/fhir/name-use
  17. http://hl7.org/fhir/narrative-status
  18. http://hl7.org/fhir/observation-status
  19. http://hl7.org/fhir/questionnaire-answers-status
  20. http://hl7.org/fhir/request-intent
  21. http://hl7.org/fhir/request-status
  22. http://hl7.org/fhir/sid/cvx
  23. http://hl7.org/fhir/sid/icd-10-cm
  24. http://hl7.org/fhir/sid/icd-9-cm
  25. http://hl7.org/fhir/us/core/CodeSystem/condition-category
  26. http://hl7.org/fhir/us/core/CodeSystem/us-core-category
  27. http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category
  28. http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
  29. http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem
  30. http://loinc.org
  31. http://nucc.org/provider-taxonomy
  32. http://snomed.info/sct
  33. http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
  34. http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
  35. http://terminology.hl7.org/CodeSystem/condition-category
  36. http://terminology.hl7.org/CodeSystem/condition-clinical
  37. http://terminology.hl7.org/CodeSystem/condition-ver-status
  38. http://terminology.hl7.org/CodeSystem/coverage-class
  39. http://terminology.hl7.org/CodeSystem/data-absent-reason
  40. http://terminology.hl7.org/CodeSystem/medicationrequest-category
  41. http://terminology.hl7.org/CodeSystem/observation-category
  42. http://terminology.hl7.org/CodeSystem/participant-type
  43. http://terminology.hl7.org/CodeSystem/provenance-participant-type
  44. http://terminology.hl7.org/CodeSystem/subscriber-relationship
  45. http://terminology.hl7.org/CodeSystem/v2-0074
  46. http://terminology.hl7.org/CodeSystem/v2-0131
  47. http://terminology.hl7.org/CodeSystem/v2-0203
  48. http://terminology.hl7.org/CodeSystem/v3-ActCode
  49. http://terminology.hl7.org/CodeSystem/v3-ActReason
  50. http://terminology.hl7.org/CodeSystem/v3-AdministrativeGender
  51. http://terminology.hl7.org/CodeSystem/v3-NullFlavor
  52. http://terminology.hl7.org/CodeSystem/v3-ParticipationFunction
  53. http://terminology.hl7.org/CodeSystem/v3-ParticipationType
  54. http://terminology.hl7.org/CodeSystem/v3-RoleCode
  55. http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS
  56. http://unitsofmeasure.org
  57. http://www.ada.org/cdt
  58. http://www.ama-assn.org/go/cpt
  59. http://www.cms.gov/Medicare/Coding/ICD10
  60. http://www.nlm.nih.gov/research/umls/rxnorm
  61. http://www.nubc.org/patient-discharge
  62. https://nahdo.org/sopt
  63. https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets
  64. https://www.usps.com/
  65. urn:ietf:bcp:13
  66. urn:ietf:bcp:47
  67. urn:oid:2.16.840.1.113883.6.238

The Value Set Authority Center (VSAC)

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:

How to Aceess Value Setas in VSAC

  • VSAC requires login using your own UMLS API Key to view the value sets. VSAC UMLS Licensing information. (See the screenshots below)
  • The value sets in VSAC are specified using a VSAC value set OID.
  • 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:

Figure 1: VSAC link
vsac-1.png

The reader is redirected to the VSAC login page to enter an API Key (only one login is required per session):

Figure 2: VSAC API-Key Login
vsac-2.png

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.

Figure 3: VSAC Smoking Status ValueSet
vsac-3.png