This publication includes IP covered under the following statements.
"Material on this site is the copyrighted property of the United States Postal Service® (Postal Service™). All rights reserved. The information and images presented here may not under any circumstances be reproduced or used without prior written permission. Users may view and download material from this site only for the following purposes: (a) for personal, non-commercial home use; (b) where the materials clearly state that these materials may be copied and reproduced according to the terms stated in those particular pages; or (c) with the express written permission of the Postal Service. In all other cases, you will need written permission from the Postal Service to reproduce, republish, upload, post, transmit, distribute or publicly display material from this Web site. Users agree not to use the site for sale, trade or other commercial purposes. Users may not use language that is threatening, abusive, vulgar, discourteous or criminal. Users also may not post or transmit information or materials that would violate rights of any third party or which contains a virus or other harmful component. The Postal Service reserves the right to remove or edit any messages or material submitted by users."For more information, see https://about.usps.com/who/legal/terms-of-use.htm
.
IEEE maintains copyright on all content from IEEE 11073 standards. All rights reserved. Implementers should obtain official copies of all applicable standards documents directly from IEEE. The inclusion of IEEE 11073 terminology codes and definitions in HL7 messages and related implementation guides is permitted under existing agreements. For permission regarding any other usage, please contact IEEE at copyrights@ieee.org.
Licensing information can be found here
These codes are listed within the UB-04 Data Specifications Manual. The Official UB-04 Data Specifications Manual, copyrighted by the American Hospital Association, is the only official source of UB-04 billing information adopted by the National Uniform Billing Committee. No other publication—governmental or private/commercial—can be considered authoritative. The AHA wants to make you aware that the use of codes, descriptions, or any other content contained in the manual to be used in a software application, publication, or any other derivative work must be properly licensed by the AHA. If your organization uses or intends to use any of the codes or other related content from the manual in this manner, please contact the AHA’s licensing manager, Tim Carlson, at 312.893.6816 or tcarlson@aha.org
Most of the information on the CDC and ATSDR websites is not subject to copyright, is in the public domain, and may be freely used or reproduced without obtaining copyright permission. For information and exceptions regarding use of CDC material please see https://www.cdc.gov/other/agencymaterials.html
Most of the information on the CDC and ATSDR websites is not subject to copyright, is in the public domain, and may be freely used or reproduced without obtaining copyright permission.For information and exceptions regarding use of CDC material please see https://www.cdc.gov/other/agencymaterials.html
.
The UCUM codes, UCUM table (regardless of format), and UCUM Specification are copyright 1999-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. https://ucum.org/trac/wiki/TermsOfUse
This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed
or info@snomed.org
.
Using RxNorm codes of type SAB=RXNORM as this specification describes does not require a UMLS license. Access to the full set of RxNorm definitions, and/or additional use of other RxNorm structures and information requires a UMLS license. The use of RxNorm in this specification is pursuant to HL7's status as a licensee of the NLM UMLS. HL7's license does not convey the right to use RxNorm to any users of this specification; implementers must acquire a license to use RxNorm in their own right.
"Material on this site is the copyrighted property of the United States Postal Service® (Postal Service™). All rights reserved. The information and images presented here may not under any circumstances be reproduced or used without prior written permission. Users may view and download material from this site only for the following purposes: (a) for personal, non-commercial home use; (b) where the materials clearly state that these materials may be copied and reproduced according to the terms stated in those particular pages; or (c) with the express written permission of the Postal Service. In all other cases, you will need written permission from the Postal Service to reproduce, republish, upload, post, transmit, distribute or publicly display material from this Web site. Users agree not to use the site for sale, trade or other commercial purposes. Users may not use language that is threatening, abusive, vulgar, discourteous or criminal. Users also may not post or transmit information or materials that would violate rights of any third party or which contains a virus or other harmful component. The Postal Service reserves the right to remove or edit any messages or material submitted by users."For more information, see https://about.usps.com/who/legal/terms-of-use.htm
. Show Usage
* USPS State Codes: Practitioner/practitioner-1, USCoreJurisdictionExtension... Show 4 more, USCoreLocationProfile, USCoreOrganizationProfile, USCorePatientProfile and USCorePractitionerProfile
( src
)
Code of Federal Regulation 21CFR§1271.290(c) ( src
)
Continued efforts to link terminology directly to the FHIR® Terminology Service for VSAC Resources (Value Set Authority Center (VSAC) - NIH) where applicable and as a result align terminology between US Core and HL7 C-CDA. ( src
)
For Diagnostic Imaging Reports systems SHOULD support using the subset of LOINC codes listed Table 4: LOINC® Document Type Codes in HL7 Standard for CDA® Release 2: Imaging Integration; Basic Imaging Reports in CDA and DICOM, Release 1 ( src
)
For Diagnostic Imaging Reports systems SHOULD support using the subset of LOINC codes listed Table 4: LOINC® Document Type Codes in HL7 Standard for CDA® Release 2: Imaging Integration; Basic Imaging Reports in CDA and DICOM, Release 1§ ( src
)
HL7 Standard for CDA® Release 2: Imaging Integration; Basic Imaging Reports in CDA and DICOM, Release 1 ( src
)
Linking terminology directly to the FHIR® Terminology Service for VSAC Resources (Value Set Authority Center (VSAC) - NIH) where applicable ( src
)
Linking terminology directly to the FHIR® Terminology Service for VSAC Resources (Value Set Authority Center (VSAC) - NIH) where applicable:
US Core Value Set, VSAC Value Set, VSAC OID, extensional? 1. Detailed ethnicity, Detailed Ethnicity, 2.16.840.1.114222.4.11.877, No 1. OMB Ethnicity Categories, Ethnicity, 2.16.840.1.114222.4.11.837, Yes 1. US Core CareTeam Provider Roles, Care Team Member Function, 2.16.840.1.113762.1.4.1099.30, Yes 1. US Core Medication Codes (RxNorm), Medication Clinical Drug, 2.16.840.1.113762.1.4.1010.4, Yes 1. US Core Provider Specialty (NUCC), Healthcare Provider Taxonomy, 2.16.840.1.114222.4.11.1066, No 1. US Core Smoking Status, Smoking Status, 2.16.840.1.113883.11.20.9.38, Yes 1. US Core Vaccine Administered Value Set (CVX), CVX Vaccines Administered Vaccine Set, 2.16.840.1.113762.1.4.1010.6, Yes 1. US Core Common substances for allergy and intolerance documentation including refutations, Common substances for allergy and intolerance documentation including refutations, 2.16.840.1.113762.1.4.1186.8, No ( src
)
NOTE that the Code System value used in FHIR® Terminology Service for VSAC Resources for Race and Ethnicity (CDCREC) concepts does not align with historical and current usage of OIDs in C-CDA and US Core. This issue has not been resolved in time for publication of the ballot version of this guide. As a result validation errors may occur when validating against this version of the US Core Patient Profile. Feedback on which code system value to use is welcome. ( src
)
The ADA is the exclusive copyright owner of CDT, the Code on Dental Procedures and Nomenclature (the Code), and the ADA Dental Claim Form. Except as permitted by law, all use, copying or distribution of CDT, or any portion thereof (including the Code on Dental Procedures and Nomenclature) in any product or services (including works prepared for clients by consultants and other professionals), whether in printed, electronic or other format, requires a valid commercial user license from the ADA. CDT ® is a registered trademark of the American Dental Association. All Rights Reserved. ( src
)
There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed. ( src
)
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 to access the VSAC value sets and supported code systems. See the table above for a list of value sets used in US Core that VSAC defines. ( src
)
This resource includes content from SNOMED Clinical Terms® (SNOMED CT®) which is copyright of the International Health Terminology Standards Development Organisation (IHTSDO). Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact http://www.snomed.org/snomed-ct/get-snomed-ct or info@snomed.org ( src
)
US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 9.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions ( src
)
We continue our efforts to align terminology between US Core and HL7 C-CDA and link terminology directly to the FHIR® Terminology Service for VSAC Resources (Value Set Authority Center (VSAC)) or HL7 Terminology (THO) where applicable. The following ValueSets has been moved: ( src
)
We continue our efforts to link terminology directly to the FHIR® Terminology Service for VSAC Resources (Value Set Authority Center (VSAC) - NIH) where applicable and, as a result, align terminology between US Core and HL7 C-CDA. ( src
)
We continue our efforts to link terminology directly to the FHIR® Terminology Service for VSAC Resources (Value Set Authority Center (VSAC) where applicable and, as a result, align terminology between US Core and HL7 C-CDA. ( src
)
We continue our efforts to link terminology directly to the FHIR® Terminology Service for VSAC Resources (Value Set Authority Center (VSAC) where applicable and, as a result, align terminology between US Core and HL7 C-CDA. The following value sets have been moved: ( src
)
We continue our efforts to link terminology directly to the FHIR® Terminology Service for VSAC Resources (Value Set Authority Center (VSAC)) where applicable and, as a result, align terminology between US Core and HL7 C-CDA. In this version, the following value sets have been added or moved to VSAC: ( src
)
Part of health record where healthcare professionals record details to document a patient's clinical status or achievements during the course of a hospitalization or over the course of outpatient care ( Wikipedia
)
[When using SNOMED codes in US Core Profiles I]mplementers MAY
use the default system URI [of SNOMED CT
], which refers to an unspecified edition/version [of SNOMED]
[To enable] terminology Servers to be able to validate US Edition-only codes [of SNOMED CT
], implementers SHOULD
provide the accompanying system URI to describe the edition [see example 2 on US Core general guidance
]
[If a] US Core Profiles binds the Quantity.code element in the Quantity datatype to the UCUM
code system, [then] systems should also use UCUM for the optional valueRange and valueRatio datatypes (which are complex datatypes with Quantity elements)
[If a] US Core Profiles binds the Quantity.code element in the Quantity datatype to the UCUM
code system, [when] UCUM code [is] provided [it SHOULD
be indicated in the Quantity.unit and Quantity.code elements with Quantity.system = "http://unitsofmeasure.org"]
[If a] US Core Profiles binds the Quantity.code element in the Quantity datatype to the UCUM
code system, [then] if UCUM units are unavailable, represent units in the unit element
Non-certifying systems[, systems that are not participating in the ONC Health IT certification program,] SHOULD
follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0
as the standard style guide for Patient.address.line and Patient.address.city for new and updated records.
[For systems participating in the ONC Health IT certification program,] this requirement [to follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0
for Patient.address.line and Patient.address.city] does not apply to historical records or documents that are exposed through FHIR-based APIs. [Organizations MAY
choose not to use use Project US@ Technical Specification for Patient Addresses Final Version 1.0 when sending historical records]
… this profile uses USPS Two Letter Alphabetic Codes for US states. When encoding addresses outside the US, systems SHOULD
use the ISO 3166 subdivision codes
.
US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 9.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/
and changes regularly. See the Directory of published versions
"Material on this site is the copyrighted property of the United States Postal Service® (Postal Service™). All rights reserved. The information and images presented here may not under any circumstances be reproduced or used without prior written permission. Users may view and download material from this site only for the following purposes: (a) for personal, non-commercial home use; (b) where the materials clearly state that these materials may be copied and reproduced according to the terms stated in those particular pages; or (c) with the express written permission of the Postal Service. In all other cases, you will need written permission from the Postal Service to reproduce, republish, upload, post, transmit, distribute or publicly display material from this Web site. Users agree not to use the site for sale, trade or other commercial purposes. Users may not use language that is threatening, abusive, vulgar, discourteous or criminal. Users also may not post or transmit information or materials that would violate rights of any third party or which contains a virus or other harmful component. The Postal Service reserves the right to remove or edit any messages or material submitted by users."For more information, see https://about.usps.com/who/legal/terms-of-use.htm
.
Licensing information can be found here
These codes are listed within the UB-04 Data Specifications Manual. The Official UB-04 Data Specifications Manual, copyrighted by the American Hospital Association, is the only official source of UB-04 billing information adopted by the National Uniform Billing Committee. No other publication—governmental or private/commercial—can be considered authoritative. The AHA wants to make you aware that the use of codes, descriptions, or any other content contained in the manual to be used in a software application, publication, or any other derivative work must be properly licensed by the AHA. If your organization uses or intends to use any of the codes or other related content from the manual in this manner, please contact the AHA’s licensing manager, Tim Carlson, at 312.893.6816 or tcarlson@aha.org
The UCUM codes, UCUM table (regardless of format), and UCUM Specification are copyright 1999-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. https://ucum.org/trac/wiki/TermsOfUse
This email address is associated with a "Direct Secure Messaging"
service. This extension can only be used on contact points where the system = 'email'
Simple Extension with the type boolean: This email address is associated with a "Direct Secure Messaging"
service. This extension can only be used on contact points where the system = 'email'
2
For Location.address.state
, this profile uses USPS Two Letter Alphabetic Codes for US states. When encoding addresses outside the US, systems SHOULD
use the ISO 3166 subdivision codes
. §
The clinical test or procedure result value. If a numeric value, valueQuantity.code SHALL
be selected from UCUM
. A FHIR UCUM Codes value set
that defines all UCUM codes is in the FHIR specification.
The Laboratory result value. If a coded value, the valueCodeableConcept.code SHOULD
be selected from SNOMED CT
if the concept exists. If a numeric value, valueQuantity.code SHALL
be selected from UCUM
. A FHIR UCUM Codes value set
that defines all UCUM codes is in the FHIR specification.
2
For Organization.address.state
, this profile uses USPS Two Letter Alphabetic Codes for US states. When encoding addresses outside the US, systems SHOULD
use the ISO 3166 subdivision codes
. §
1
For Patient.address.state
, this profile uses USPS Two Letter Alphabetic Codes for US states. When encoding addresses outside the US, systems SHOULD
use the ISO 3166 subdivision codes
. §
3
For Practitioner.address.state
, this profile uses USPS Two Letter Alphabetic Codes for US states. When encoding addresses outside the US, systems SHOULD
use the ISO 3166 subdivision codes
. §
The US Core PractitionerRole Profile inherits from the FHIR PractitionerRole
resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the PractitionerRole Resource to record, search, and fetch the practitioner role information. It specifies which core elements, extensions, vocabularies, and value sets SHALL
be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption. The requirements for the US Core Practitioner were drawn from the Argonaut Provider Directory
, IHE Healthcare Provider Directory
and the ONC Provider Directory Workshop
.
The US Core PractitionerRole Profile inherits from the FHIR PractitionerRole
resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the PractitionerRole Resource to record, search, and fetch the practitioner role information. It specifies which core elements, extensions, vocabularies, and value sets SHALL
be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption. The requirements for the US Core Practitioner were drawn from the Argonaut Provider Directory
, IHE Healthcare Provider Directory
and the ONC Provider Directory Workshop
.
1
For RelatedPerson.address.state
, this profile uses USPS Two Letter Alphabetic Codes for US states. When encoding addresses outside the US, systems SHOULD
use the ISO 3166 subdivision codes
. §
Resolved - change required
:Confusing for commercial vendor. Reads very confusing. ( FHIR-30783
) proposal is to make the differential tab the default view, see publishing plans here
timeline unknown.
The following examples are published in this guide, and all are available as downloadable zip files here
. Another source of examples that conform to this guide is the synthetic patient data generated by SyntheaTM
in the FHIR R4 format.
SNOMED CT
(Systematized Nomenclature of Medicine – Clinical Terms) is a comprehensive clinical terminology widely used in healthcare to support the electronic exchange of clinical health information. US Core uses the US Edition of SNOMED CT, a standalone release that combines the content of the US Extension and the International releases of SNOMED CT. It is used extensively in US CORE for various clinical concepts, including problems, procedures, allergies, and laboratory results. When using SNOMED codes in US Core Profiles, implementers MAY
use the default system URI, which refers to an unspecified edition/version, §
as shown in option one below. However, for terminology Servers to be able to validate US Edition-only codes, implementers SHOULD
provide the accompanying system URI to describe the edition as shown in option two. §
Some US Core Profiles bind the Quantity.code
element in the Quantity datatype to the UCUM
code system. For example, in the US Core Laboratory Result Observation Profile
, Observation.valueQuantity
, Observation.referenceRange.low
, and Observation.referenceRange.high
are bound to UCUM. Systems should also use UCUM for the optional valueRange
and valueRatio
datatypes (which are complex datatypes with Quantity elements). §
A FHIR UCUM Codes ValueSet
that defines all UCUM codes is in the FHIR specification. This guidance specifies how to represent the Quantity datatype when the correct UCUM units are missing or when the units are missing, which will likely occur in the real world.
The HTTP Cache-Control
response header stores a response associated with a request and reuses the stored response for subsequent requests. If a Cache-Control
header is present in the Server response headers, the Clients SHOULD NOT
search the same data within the time stated in the Cache-Control
header. §
Each US Core Profile page includes a "Quick Start" section summarizing each profile's supported search transactions and scopes. Servers MAY
support other scopes in addition to those listed below and in the Quick Start sections. §
US Core Clients should follow the principle of least privilege
and access only the necessary resources. §
In other words, if a Client needs only vital sign observations, it should request access only to Observations with a category of "vital-signs". Note that a granular scope grants access to all resources matching that granular scope regardless of whether other categories
are present.
Screening and Assessments can be structured survey instruments consisting of questions with various responses, including true/false, coded, textual, and multiple choice. Examples include PRAPARE, Apgar score
, and PHQ-9
. US Core defines two ways to represent the questions and responses to these screening and assessment instruments:
Screening and Assessments can be structured survey instruments consisting of questions with various responses, including true/false, coded, textual, and multiple choice. Examples include PRAPARE, Apgar score
, and PHQ-9
. US Core defines two ways to represent the questions and responses to these screening and assessment instruments:
