US Core Implementation Guide
4.1.0 - CI Build

US Core Implementation Guide, published by HL7 International - US Realm Steering Committee. This is not an authorized publication; it is the continuous build for version 4.1.0). This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

US Core Client CapabilityStatement

This Section describes the expected capabilities of the US Core Client which is responsible for creating and initiating the queries for information about an individual patient. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined in the Conformance Requirements for Server. US Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.

US Core Server CapabilityStatement

This Section describes the expected capabilities of the US Core Server actor which is responsible for providing responses to the queries submitted by the US Core Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined. Systems implementing this capability statement should meet the ONC 2015 Common Clinical Data Set (CCDS) access requirement for Patient Selection 170.315(g)(7) and Application Access - Data Category Request 170.315(g)(8) and and the ONC U.S. Core Data for Interoperability (USCDI). US Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide

US Core Fetch DocumentReference

This operation is used to return all the references to documents related to a patient.

The operation requires a patient id and takes the optional input parameters:

  • start date
  • end date
  • document type

and returns a Bundle of type “searchset” containing DocumentReference resources for the patient. The DocumentReference resources SHOULD conform to the US Core DocumentReference Profiles. If the server has or can create documents that are related to the patient, and that are available for the given user, the server returns the DocumentReference resources needed to support the records. The principle intended use for this operation is to provide a provider or patient with access to their available document information.

This operation is different from a search by patient and type and date range because:

  1. It is used to request a server generate a document based on the specified parameters.

  2. If no parameters are specified, the server SHALL return a DocumentReference to the patient’s most current CCD

  3. If the server cannot generate a document based on the specified parameters, the operation will return an empty search bundle.

This operation is the same as a FHIR RESTful search by patient,type and date range because:

  1. References for existing documents that meet the requirements of the request SHOULD also be returned unless the client indicates they are only interested in ‘on-demand’ documents using the on-demand parameter.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

USCoreAllergyIntoleranceClinicalStatus

active | inactive | resolved
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreAllergyIntolerancePatient

Who the sensitivity is for
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreCarePlanCategory

Type of plan
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreCarePlanDate

Time period plan covers
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreCarePlanPatient

Who the care plan is for
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreCarePlanStatus

draft | active | on-hold | revoked | completed | entered-in-error | unknown
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreCareTeamPatient

Who care team is for
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreCareTeamStatus

proposed | active | suspended | inactive | entered-in-error
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreConditionCategory

The category of the condition
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreConditionClinicalStatus

The clinical status of the condition
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreConditionCode

Code for the condition
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreConditionOnsetDate

Date related onsets (dateTime and Period)
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreConditionPatient

Who has the condition?
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDevicePatient

Patient information, if the resource is affixed to a person
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDeviceType

The type of the device
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDiagnosticReportCategory

Which diagnostic discipline/department created the report
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDiagnosticReportCode

The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDiagnosticReportDate

The clinically relevant time of the report
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDiagnosticReportPatient

The subject of the report if a patient
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDiagnosticReportStatus

The status of the report
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDocumentReferenceCategory

Categorization of document
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDocumentReferenceDate

When this document reference was created
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDocumentReferenceId

Logical id of this artifact
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDocumentReferencePatient

Who/what is the subject of the document
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDocumentReferencePeriod

Time of service that is being documented
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDocumentReferenceStatus

current | superseded | entered-in-error
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreDocumentReferenceType

Kind of document (LOINC if possible)
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreEncounterClass

Classification of patient encounter
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreEncounterDate

A date within the period the Encounter lasted
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreEncounterId

Logical id of this artifact
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreEncounterIdentifier

Identifier(s) by which this encounter is known
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreEncounterPatient

The patient or group present at the encounter
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreEncounterStatus

planned | arrived | triaged | in-progress | onleave | finished | cancelled +
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreEncounterType

Specific type of encounter
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreEthnicity

Returns patients with an ethnicity extension matching the specified code.

USCoreGoalLifecycleStatus

proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreGoalPatient

Who this goal is intended for
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreGoalTargetDate

Reach goal on or before
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreImmunizationDate

Vaccination (non)-Administration Date
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreImmunizationPatient

The patient for the vaccination record
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreImmunizationStatus

Immunization event status
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreLocationAddressCity

A city specified in an address
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreLocationAddressPostalcode

A postal code specified in an address
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreLocationAddressState

A state specified in an address
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreLocationAddress

A (part of the) address of the location
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreLocationName

A portion of the location’s name or alias
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreMedicationRequestAuthoredon

Return prescriptions written on this date
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreMedicationRequestEncounter

Return prescriptions with this encounter identifier
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreMedicationRequestIntent

Returns prescriptions with different intents
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreMedicationRequestPatient

Returns prescriptions for a specific patient
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreMedicationRequestStatus

Status of the prescription
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreObservationCategory

The classification of the type of observation
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreObservationCode

The code of the observation type
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreObservationDate

Obtained date/time. If the obtained element is a period, a date that falls in the period
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreObservationPatient

The subject that the observation is about (if patient)
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreObservationStatus

The status of the observation
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreOrganizationAddress

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreOrganizationName

A portion of the organization’s name or alias
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCorePatientBirthdate

The patient’s date of birth
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCorePatientFamily

A portion of the family name of the patient
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCorePatientGender

Gender of the patient
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCorePatientGiven

A portion of the given name of the patient
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCorePatientId

Logical id of this artifact
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCorePatientIdentifier

A patient identifier
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCorePatientName

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCorePractitionerIdentifier

A practitioner’s Identifier
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCorePractitionerName

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCorePractitionerRolePractitioner

Practitioner that is able to provide the defined services for the organization
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCorePractitionerRoleSpecialty

The practitioner has this specialty at an organization
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreProcedureCode

A code to identify a procedure
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreProcedureDate

When the procedure was performed
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreProcedurePatient

Search by subject - a patient
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreProcedureStatus

preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreRace

Returns patients with a race extension matching the specified code.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide

US Core Pediatric Head Occipital-frontal Circumference Percentile Profile

Defines constraints on the Observation resource to represent head occipital-frontal circumference percentile for patients from birth to 36 months of age in FHIR using a standard LOINC code and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

US Core AllergyIntolerance Profile

Defines constraints and extensions on the AllergyIntolerance resource for the minimal set of data to query and retrieve allergy information.

US Core Blood Pressure Profile

Defines constraints on Observation to represent diastolic and systolic blood pressure observations with standard LOINC codes and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

US Core BMI Profile

Defines constraints on Observation to represent Body Mass Index (BMI) observations with a standard LOINC code and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

US Core Body Height Profile

Defines constraints on Observation to represent body height observations with a standard LOINC code and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

US Core Body Temperature Profile

Defines constraints on Observation to represent body temperature observations with a standard LOINC code and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

US Core Body Weight Profile

Defines constraints on Observation to represent body weight observations with a standard LOINC code and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

US Core CarePlan Profile

Defines constraints and extensions on the CarePlan resource for the minimal set of data to query and retrieve a patient’s Care Plan.

US Core CareTeam Profile

Defines constraints and extensions on the CareTeam resource for the minimal set of data to query and retrieve a patient’s Care Team.

US Core Condition Profile

Defines constraints and extensions on the Condition resource for the minimal set of data to query and retrieve problems and health concerns information.

US Core DiagnosticReport Profile for Laboratory Results Reporting

Defines constraints and extensions on the DiagnosticReport resource for the minimal set of data to query and retrieve diagnostic reports associated with laboratory results for a patient

US Core DiagnosticReport Profile for Report and Note exchange

Defines constraints and extensions on the DiagnosticReport resource for the minimal set of data to query and retrieve diagnostic reports associated with clinical notes for a patient

US Core DocumentReference Profile

The document reference profile used in US Core.

US Core Encounter Profile

The Encounter referenced in the US Core profiles.

US Core Goal Profile

Defines constraints and extensions on the Goal resource for the minimal set of data to query and retrieve a patient’s goal(s).

US Core Head Circumference Profile

Defines constraints on Observation to represent head circumference observations with a standard LOINC code and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

US Core Heart Rate Profile

Defines constraints on Observation to represent heart rate observations with a standard LOINC code and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

US Core Immunization Profile

Defines constraints and extensions on the Immunization resource for the minimal set of data to query and retrieve patient’s immunization information.

US Core Implantable Device Profile

Defines constraints and extensions on the Device resource for the minimal set of data to query and retrieve a patient’s implantable device(s).

US Core Location Profile

Defines basic constraints and extensions on the Location resource for use with other US Core resources

US Core Medication Profile

Defines constraints and extensions on the Medication resource for the minimal set of data to query and retrieve patient retrieving patient’s medication information.

US Core MedicationRequest Profile

Defines constraints and extensions on the MedicationRequest resource for the minimal set of data to query and retrieve prescription information.

US Core Laboratory Result Observation Profile

Defines constraints and extensions on the Observation resource for the minimal set of data to query and retrieve laboratory test results

US Core Organization Profile

Defines basic constraints and extensions on the Organization resource for use with other US Core resources

US Core Pediatric BMI for Age Observation Profile

Defines constraints on Observation to represent to represent BMI percentile per age and sex for youth 2-20 observations in FHIR using a standard LOINC code and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

US Core Pediatric Weight for Height Observation Profile

Defines constraints on the Observation resource to represent pediatric Weight-for-length per age and gender observations in FHIR with a standard LOINC code and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

US Core Practitioner Profile

The practitioner(s) referenced in US Core profiles.

US Core PractitionerRole Profile

The practitioner roles referenced in the US Core profiles.

US Core Procedure Profile

Defines constraints and extensions on the Procedure resource for the minimal set of data to query and retrieve patient’s procedure information.

US Core Provenance Profile

Draft set of requirements to satisfy Basic Provenance Requirements.

US Core Pulse Oximetry Profile

Defines constraints on the Observation resource to represent inspired O2 by pulse oximetry and inspired oxygen concentration observations with a standard LOINC codes and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

US Core Respiratory Rate Profile

Defines constraints on Observation to represent respiratory rate observations with a standard LOINC code and UCUM units of measure. This profile is derived from the US Core Vital Signs Profile.

US Core Smoking Status Observation Profile

Defines constraints and extensions on the Observation resource for the minimal set of data to query and retrieve patient’s Smoking Status information.

US Core Vital Signs Profile

Defines constraints on the Observation resource to represent vital signs observations. This profile is used as the base definition for the other US Core Vital Signs Profiles and based on the FHIR VitalSigns Profile.

US Core Patient Profile

Defines constraints and extensions on the patient resource for the minimal set of data to query and retrieve patient demographic information.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide

US Core Birth Sex Extension

A code classifying the person’s sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9).

US Core Direct email Extension

This email address is associated with a direct service. This extension can only be used on contact points where the system = ‘email’

US Core Ethnicity Extension

Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the CDC ethnicity and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.

US Core Race Extension

Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:

  • American Indian or Alaska Native
  • Asian
  • Black or African American
  • Native Hawaiian or Other Pacific Islander
  • White.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

Detailed ethnicity

The 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes.

Detailed Race

The 900+ CDC Race codes that are grouped under one of the 5 OMB race category codes.

OMB Ethnicity Categories

The codes for the ethnicity categories - ‘Hispanic or Latino’ and ‘Non Hispanic or Latino’ - as defined by the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.

OMB Race Categories

The codes for the concepts ‘Unknown’ and ‘Asked but no answer’ and the the codes for the five race categories - ‘American Indian’ or ‘Alaska Native’, ‘Asian’, ‘Black or African American’, ‘Native Hawaiian or Other Pacific Islander’, and ‘White’ - as defined by the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997 .

Language codes with language and optionally a region modifier

This value set includes codes from BCP-47. This value set matches the ONC 2015 Edition LanguageCommunication data element value set within C-CDA to use a 2 character language code if one exists, and a 3 character code if a 2 character code does not exist. It points back to RFC 5646, however only the language codes are required, all other elements are optional.

Birth Sex

Codes for assigning sex at birth as specified by the Office of the National Coordinator for Health IT (ONC)

US Core Clinical Note Type

The US Core Clinical Note Type Value Set is a ‘starter set’ of types supported for fetching and storing clinical notes.

US Core Condition Category Codes

The US Core Condition Category Codes support the separate concepts of problems and health concerns in Condition.category in order for API consumers to be able to separate health concerns and problems. However this is not mandatory for 2015 certification

US Core Condition Code

This describes the problem. Diagnosis/Problem List is broadly defined as a series of brief statements that catalog a patient’s medical, nursing, dental, social, preventative and psychiatric events and issues that are relevant to that patient’s healthcare (e.g., signs, symptoms, and defined conditions). ICD-10 is appropriate for Diagnosis information, and ICD-9 for historical information.

US Core DiagnosticReport Category

The US Core Diagnostic Report Category Value Set is a ‘starter set’ of categories supported for fetching and Diagnostic Reports and notes.

US Core Diagnostic Report Laboratory Codes

The Document Type value set includes all LOINC values whose CLASSTYPE is LABORATORY in the LOINC database

US Core DiagnosticReport Report And Note Codes

This value set currently contains all of LOINC. The codes selected should represent discrete and narrative diagnostic observations and reports

US Core DocumentReference Category

The US Core DocumentReferences Category Value Set is a ‘starter set’ of categories supported for fetching and storing clinical notes.

US Core DocumentReference Type

The US Core DocumentReference Type Value Set includes all LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept ‘unknown’

US Core Encounter Type

The type of encounter: a specific code indicating type of service provided. This value set includes codes from SNOMED CT decending from the concept 308335008 (Patient encounter procedure (procedure)) and codes from the Current Procedure and Terminology (CPT) found in the following CPT sections:

  • 99201-99499 E/M

  • 99500-99600 home health (mainly nonphysician, such as newborn care in home)

  • 99605-99607 medication management

  • 98966-98968 non physician telephone services

(subscription to AMA Required)

US Core Narrative Status

The US Core Narrative Status Value Set limits the text status for the resource narrative.

US Core Smoking Status Max-Binding

Representing a patient’s smoking behavior using concepts from SNOMED CT.

US Core Status for Smoking Status Observation

Codes providing the status of an observation for smoking status. Constrained to finaland entered-in-error.

US Core Observation Value Codes (SNOMED-CT)

Snomed-CT concept codes for coded results

US Core Procedure Codes

Concepts from CPT, SNOMED CT, HCPCS Level II Alphanumeric Codes, ICD-10-PCS,CDT and LOINC code systems that can be used to indicate the type of procedure performed.

US Core Provenance Participant Type Codes

The type of participation a provenance agent played for a given target.

US Core Provider Role (NUCC)

Provider roles codes which are composed of the NUCC Health Care Provider Taxonomy Code Set classification codes for providers. Only concepts with a classification and no specialization are included.

US Core Smoking Status Observation Codes

The US Core Smoking Status Observation Codes Value Set is a ‘starter set’ of concepts to capture smoking status.

USPS Two Letter Alphabetic Codes

This value set defines two letter USPS alphabetic codes.

US Core Vital Signs ValueSet

The vital sign codes from the base FHIR and US Core Vital Signs.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide

US Core CarePlan Category Extension Codes

Set of codes that are needed for implementation of the US-Core CarePlan Profile. These codes are used as extensions to the FHIR ValueSet.

Race & Ethnicity - CDC

The U.S. Centers for Disease Control and Prevention (CDC) has prepared a code set for use in codingrace and ethnicity data. This code set is based on current federal standards for classifying data onrace and ethnicity, specifically the minimum race and ethnicity categories defined by the U.S. Office ofManagement and Budget (OMB) and a more detailed set of race and ethnicity categories maintainedby the U.S. Bureau of the Census (BC). The main purpose of the code set is to facilitate use of federalstandards for classifying data on race and ethnicity when these data are exchanged, stored, retrieved,or analyzed in electronic form. At the same time, the code set can be applied to paper-based recordsystems to the extent that these systems are used to collect, maintain, and report data on race andethnicity in accordance with current federal standards. Source: Race and Ethnicity Code Set Version 1.0.

US Core Condition Category Extension Codes

Set of codes that are needed for implementation of the US-Core Condition Profile. These codes are used as extensions to the FHIR and US Core value sets.

US Core DocumentReferences Category Codes

The US Core DocumentReferences Type Code System is a ‘starter set’ of categories supported for fetching and storing DocumentReference Resources.

US Core Provenance Participant Type Extension Codes

Set of codes that are needed for implementation of the US-Core Provenance Profile. These codes are used as extensions to the FHIR value sets.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like

Device Defib Example

This is a Device defib example for the US Core Implantable Device Profile.

Device Knee Example

This is a Device knee example for the US Core Implantable Device Profile.

DiagnosticReport Cardiology Report Example

This is a DiagnosticReport cardiology report example for the US Core DiagnosticReport Note Profile.

DiagnosticReport Chest Xray Report Example

This is a DiagnosticReport chest xray report example for the US Core DiagnosticReport Note Profile.

PractitionerRole_Practitioner_Endpoint_Bundle_Example Example

This is a PractitionerRole_Practitioner_Endpoint_Bundle_Example example for the Bundle Profile.

Procedure R4 Defib Implant Example

This is a Procedure R4 defib implant example for the US Core Procedure Profile.

Acme Lab Example

This is a acme lab example for the US Core Organization Profile.

AllergyIntolerance Example

This is a allergyintolerance example for the US Core AllergyIntolerance Profile.

AllergyIntolerance Provenance Example

This is a allergyintolerance provenance example for the Bundle Profile.

Blood Glucose Example

This is a blood glucose example for the US Core Observation Lab Profile.

Blood Pressure Example

This is a blood pressure example for the Vitalsigns Profile.

BMI Example

This is a BMI example for the Vitalsigns Profile.

BP Data Absent Example

This is a bp data absent example for the Vitalsigns Profile showing how to reprsesent blood pressure with a missing diastolic measurement.

BUN Example

This is a BUN example for the US Core Observation Lab Profile.

CareTeam Example

This is a careteam example for the US Core CareTeam Profile.

CBC Example

This is a CBC example for the US Core DiagnosticReport Lab Profile.

Colonoscopy Example

This is a colonoscopy example for the US Core CarePlan Profile.

Condition Example

This is a condition example for the US Core Condition Profile.

Encounter 1036 Example

This is a encounter 1036 example for the Encounter Profile.

Encounter 1 Example

This is a encounter 1 example for the US Core Encounter Profile.

Episode Summary Example

This is a episode summary example for the US Core DocumentReference Profile.

Erythrocytes Example

This is a erythrocytes example for the US Core Observation Lab Profile.

Organization 2 Example

This is a organization 2 example for the US Core Organization Profile.

Goal 1 Example

This is a goal 1 example for the US Core Goal Profile.

HC1 Example

This is a hc1 example for the US Core Condition Profile.

Head Circumference Example

This is a head circumference example for the US Core Head Circumference Profile.

Heart Rate Example

This is a heart rate example for the Vitalsigns Profile.

Height Example

This is a height example for the Vitalsigns Profile.

Hemoglobin Example

This is a hemoglobin example for the US Core Observation Lab Profile.

HL7East Example

This is a HL7East example for the US Core Location Profile.

Imm 1 Example

This is a imm 1 example for the US Core Immunization Profile.

Length Example

This is a length example for the Vitalsigns Profile which shows how body length (typically used for infants) is represented using 8306-3 -Body height - lying as an additional observation code.

MCHC Example

This is a MCHC example for the US Core Observation Lab Profile.

Metabolic Panel Example

This is a metabolic panel example for the US Core DiagnosticReport Lab Profile.

Neutrophils Example

This is a neutrophils example for the US Core Observation Lab Profile.

Observation SatO2 FiO2 Example

This is a observation satO2 fiO2 example for the US Core Pulse Oximetry Profile representing a spO2 value with a for a patient on 6 l/min of O2 suppplemental oxygen.

OFC Percentile Example

This is a OFC percentile example for the Head Occipital Frontal Circumference Percentile Profile.

Oxygen Saturation Example

This is a typical oxygen saturation example for the US Core Pulse Oximetry Profile on room air where no oxygen concentration is recorded.

Patient Child Example

This is a patient child example for the US Core Patient Profile.

Patient Example

This is a patient example for the US Core Patient Profile.

Patient Infant Example

This is a patient infant example for the US Core Patient Profile.

Pediatric BMI Example

This is a pediatric BMI example for the Pediatric BMI For Age Profile.

Pediatric Wt Example

This is a pediatric wt example for the Pediatric Weight For Height Profile.

Practitioner 1 Example

This is a practitioner 1 example for the US Core Practitioner Profile.

Practitioner 2 Example

This is a practitioner 2 example for the US Core Practitioner Profile.

Rehab Example

This is a rehab example for the US Core Procedure Profile.

Respiratory Rate Example

This is a respiratory rate example for the Vitalsigns Profile.

Saint Luke W Endpoint Example

This is a saint luke w endpoint example for the US Core Organization Profile.

Self Tylenol Example

This is a self tylenol example for the MedicationRequest Profile.

Serum Calcium Example

This is a serum calcium example for the US Core Observation Lab Profile.

Serum Chloride Example

This is a serum chloride example for the US Core Observation Lab Profile.

Serum CO2 Example

This is a serum CO2 example for the US Core Observation Lab Profile.

Serum Creatinine Example

This is a serum creatinine example for the US Core Observation Lab Profile.

Serum Potassium Example

This is a serum potassium example for the US Core Observation Lab Profile.

Serum Sodium Example

This is a serum sodium example for the US Core Observation Lab Profile.

Serum Total Bilirubin Example

This is a serum total bilirubin example for the US Core Observation Lab Profile.

Some Day Smoker Example

This is a some day smoker example for the US Core Smokingstatus Profile.

Temperature Example

This is a temperature example for the Vitalsigns Profile.

UDI 1 Example

This is a UDI 1 example for the US Core Implantable Device Profile.

Urinalysis Example

This is a urinalysis example for the US Core DiagnosticReport Lab Profile.

Urine Bacteria Example

This is a urine bacteria example for the US Core Observation Lab Profile.

Urine Bilirubin Example

This is a urine bilirubin example for the US Core Observation Lab Profile.

Urine Cells Example

This is a urine cells example for the US Core Observation Lab Profile.

Urine Clarity Example

This is a urine clarity example for the US Core Observation Lab Profile.

Urine Color Example

This is a urine color example for the US Core Observation Lab Profile.

Urine Epi Cells Example

This is a urine epi cells example for the US Core Observation Lab Profile.

Urine Glucose Example

This is a urine glucose example for the US Core Observation Lab Profile.

Urine Hemoglobin Example

This is a urine hemoglobin example for the US Core Observation Lab Profile.

Urine Ketone Example

This is a urine ketone example for the US Core Observation Lab Profile.

Urine Leukocyte Esterase Example

This is a urine leukocyte esterase example for the US Core Observation Lab Profile.

Urine Nitrite Example

This is a urine nitrite example for the US Core Observation Lab Profile.

Urine pH Example

This is a urine pH example for the US Core Observation Lab Profile.

Urine Protein Example

This is a urine protein example for the US Core Observation Lab Profile.

Urine RBCsExample

This is a urine RBCsexample for the US Core Observation Lab Profile.

Urine Sediment Example

This is a urine sediment example for the US Core Observation Lab Profile.

Urine WBCsExample

This is a urine WBCsexample for the US Core Observation Lab Profile.

Urobilinogen Example

This is a urobilinogen example for the US Core Observation Lab Profile.

Uscore Med1 Example

This is a uscore med1 example for the US Core Medication Profile.

Uscore Med2 Example

This is a uscore med2 example for the US Core Medication Profile.

Uscore MO1 Example

This is a uscore mo1 example for the US Core MedicationRequest Profile.

Uscore MO2 Example

This is a uscore MO2 example for the US Core MedicationRequest Profile.

Uscore MO3 Example

This is a uscore mo3 example for the Bundle Profile.

USG Example

This is a USG example for the US Core Observation Lab Profile.

Weight Example

This is a weight example for the Vitalsigns Profile.