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

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 7.0.0-ballot 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

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 the ONC U.S. Core Data for Interoperability (USCDI) Version 4 July 2023. 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. It is invoked on a FHIR Server’s DocumentReference endpoint (e.g., [base]/DocumentReference/$docref) and operates across all DocumentReference instances.

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

  • start date
  • end date
  • document type
  • on-demand
  • profile

and returns a searchset Bundle containing DocumentReference resources for the patient. If the server has stored documents or can create documents for the patient and those documents are available for the user, the server returns the DocumentReference resources associated with documents. This operation’s intended use is to provide a way for providers or patients to access their available documents. The document itself can be subsequently retrieved using the link provided in the DocumentReference.content.attachment.url element. The link could be a FHIR endpoint to a Binary Resource or some other document repository.

This operation is different from a FHIR RESTful query on DocumentReference by patient and type and date range because:

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

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

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

Unless the client indicates they are only interested in ‘on-demand’ documents using the on-demand parameter, the server SHOULD return DocumentReference instances for existing documents that meet the request parameters In this regard, this operation is similar to a FHIR RESTful query.

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
USCoreCareTeamRole

Returns CareTeam resources with a participant role matching the specified code.

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
USCoreConditionAbatementDate

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

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreConditionAssertedDate

Returns conditions with an assertedDate extension matching the specified date (dateTime).

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
USCoreConditionEncounter

Encounter created as part of
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
USCoreConditionRecordedDate

Date record was first recorded
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreCoveragePatient

Retrieve coverages for a patient
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
USCoreDeviceStatus

active | inactive | entered-in-error | unknown
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
USCoreEncounterDischargeDisposition

Returns encounters with an discharge-disposition matching the specified code.

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
USCoreEncounterLocation

Location the encounter takes place
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.

USCoreGoalDescription

The code or text describing the goal NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
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
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
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
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
USCoreMedicationdispensePatient

The identity of a patient to list dispenses for
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreMedicationdispenseStatus

Returns dispenses with a specified dispense status
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreMedicationdispenseType

Returns dispenses of a specific type
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
USCorePatientDeathDate

The date of death has been provided and satisfies this search value
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
USCorePatientGenderIdentity

Returns patients with an gender-identity extension matching the specified code.

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
USCorePractitionerId

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
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
USCoreQuestionnaireresponseAuthored

When the questionnaire response was last changed
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreQuestionnaireresponseId

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
USCoreQuestionnaireresponsePatient

The patient that is the subject of the questionnaire response
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreQuestionnaireresponseQuestionnaire

The questionnaire the answers are provided for
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreQuestionnaireresponseStatus

The status of the questionnaire response
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.

USCoreRelatedpersonId

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
USCoreRelatedpersonName

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
USCoreRelatedpersonPatient

The patient this related person is related to
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreServicerequestAuthored

Date request signed
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreServicerequestCategory

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

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreServicerequestCode

What is being requested/ordered
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
USCoreServicerequestId

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
USCoreServicerequestPatient

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
USCoreServicerequestStatus

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
USCoreSpecimenId

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
USCoreSpecimenPatient

The patient the specimen comes from
NOTE: This US Core SearchParameter definition extends the usage context of the Conformance expectation extension

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Structures: Resource Profiles

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

US Core AllergyIntolerance Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the AllergyIntolerance resource to record, search, and fetch allergies/adverse reactions associated with a patient. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Average Blood Pressure Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch average diastolic and systolic blood pressure observations with standard LOINC codes and UCUM units of measure. It is based on the US Core Blood Pressure Profile and identifies which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core BMI Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch Body Mass Index (BMI) observations with a standard LOINC code and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Blood Pressure Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch diastolic and systolic blood pressure observations with standard LOINC codes and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Body Height Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch body height observations with a standard LOINC code and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies the which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Body Temperature Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch body temperature observations with a standard LOINC code and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Body Weight Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch body weight observations with a standard LOINC code and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Care Experience Preference Profile

This profile represents a person’s care preferences during their care and treatment. Examples include, but are not limited to religious preferences, dislikes and fears, and thoughts and feelings to be shared. To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch for a patient’s care experience preferences. This profile identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core CarePlan Profile

This profile sets minimum expectations for the CarePlan resource to record, search, and fetch assessment and plan of treatment data associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core CareTeam Profile

This profile sets minimum expectations for the CareTeam resource for identifying the Care Team members associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Condition Encounter Diagnosis Profile

The US Core Condition Encounter Diagnosis Profile is based upon the core FHIR Condition Resource and meets the U.S. Core Data for Interoperability (USCDI) v2 Encounter Diagnosis requirements. In version 5.0.0, The US Core Condition Profile has been split into the US Core Condition Encounter Diagnosis Profile and US Core Condition Problems and Health Concerns Profile. To promote interoperability and adoption through common implementation, this profile defines constraints and extensions on the Condition resource for the minimal set of data to record, search, and fetch information about an encounter diagnosis. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Condition Problems and Health Concerns Profile

The US Core Condition Problems and Health Concerns Profile is based upon the core FHIR Condition Resource and meets the U.S. Core Data for Interoperability (USCDI) v2 ‘Problems’ and ‘Health Concerns’ requirements and SDOH ‘Problems/Health Concerns’ requirements. In version 5.0.0, The US Core Condition Profile has been split into the US Core Condition Encounter Diagnosis Profile and US Core Condition Problems and Health Concerns Profile. To promote interoperability and adoption through common implementation, this profile defines constraints and extensions on the Condition resource for the minimal set of data to record, search, and fetch information about a condition, diagnosis, or other event, situation, issue, or clinical concept that is documented and categorized as a problem or health concern including information about a Social Determinants of Health-related condition. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource when and constrains the way the elements are used using this profile. It provides the floor for standards development for specific use cases.

US Core Coverage Profile

The US Core Coverage Profile is based upon the core FHIR Coverage Resource and implements the US Core Data for Interoperability (USCDI) v3 Health Insurance Information requirements. To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Coverage resource to record, search, and fetch the “data related to an individual’s insurance coverage for health care”. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core DiagnosticReport Profile for Laboratory Results Reporting

Laboratory results are grouped and summarized using the DiagnosticReport resource which typically reference Observation resource(s). Each Observation resource represents an individual laboratory test and result value or component result values, or a nested panel (such as a microbial susceptibility panel) which references other observations. They can also be presented in report form or as free text. This profile sets minimum expectations for the DiagnosticReport resource to record, search, and fetch laboratory results associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core DiagnosticReport Profile for Report and Note Exchange

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for searching and fetching Diagnostic Reports and Notes using the DiagnosticReport resource. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases. Prior to reviewing this profile, implementers are encouraged to read the Clinical Notes Guidance to understand the overlap of US Core DiagnosticReport Profile for Report and Note exchange and US Core DocumentReference Profile.

US Core DocumentReference Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for searching and fetching patient documents including Clinical Notes using the DocumentReference resource. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases. Prior to reviewing this profile, implementers are encouraged to read the Clinical Notes Guidance to understand the overlap of US Core DocumentReference Profile and US Core DiagnosticReport Profile for Report and Note exchange.

US Core Encounter Profile

This profile sets minimum expectations for the Encounter resource to record, search, and fetch basic encounter information for an individual patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Goal Profile

This profile sets minimum expectations for the Goal resource to record, search, and fetch Goal information associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases

US Core Head Circumference Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch head circumference observations with a standard LOINC code and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Heart Rate Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch heart rate observations with a standard LOINC code and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Immunization Profile

This profile sets minimum expectations for the Immunization resource to record, search, and fetch immunization history associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Implantable Device Profile

The US Core Implantable Device Profile is based upon the core FHIR Device Resource and meets the U.S. Core Data for Interoperability (USCDI) v2 Unique Device Identifier(s) for a Patient’s Implantable Device(s) requirements. To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Device resource to record, search, and fetch UDI information associated with a patient’s implantable device(s). It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Laboratory Result Observation Profile

The US Core Laboratory Result Observation Profile is based upon the US Core Observation Clinical Result Profile and, along with the US Core DiagnosticReport Profile for Laboratory Results Reporting, meets the U.S. Core Data for Interoperability (USCDI) Laboratory requirements. Laboratory results are grouped and summarized using the DiagnosticReport resource, which references Observation resources. Each Observation resource represents an individual laboratory test and result value, a “nested” panel (such as a microbial susceptibility panel) that references other observations, or rarely a laboratory test with component result values. The US Core Laboratory Result Observation Profile sets minimum expectations for the Observation resource to record, search, and fetch laboratory test results associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Location Profile

This profile sets minimum expectations for the Location resource for recording, searching, and fetching a “physical place of available services or resources.” It identifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used when using the profile. It provides the floor for standards development for specific use cases to promote interoperability and adoption through common implementation.

US Core Medication Profile

When referencing a medication, the MedicationRequest resource can either use a code or refer to a Medication resource. This profile sets minimum expectations for the Medication resource to record, search, and fetch medications associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases

US Core MedicationDispense Profile

This profile sets minimum expectations for the MedicationDispense resource to record, search, and fetch the “state of a medication with regards to dispensing or other activity. (e.g., dispensed, partially dispensed, not dispensed)” associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core MedicationRequest Profile

The US Core Medication Request Profile is based upon the core FHIR MedicationRequest Resource and meets the U.S. Core Data for Interoperability (USCDI) v2 Medications requirements. The MedicationRequest resource can be used to record a patient’s medication prescription or order. This profile sets minimum expectations for the MedicationRequest resource to record, search, and fetch a patient’s medication to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Observation Clinical Result Profile

The US Core Observation Clinical Result Profile is based upon the core FHIR Observation Resource and, along with the US Core DiagnosticReport Profile, meets the US Core Data for Interoperability (USCDI) requirements for Diagnostic Imaging and Clinical Tests Data Classes. This profile sets minimum expectations for the Observation resource to record and search non-laboratory clinical test results (e.g., radiology and other clinical observations generated from procedures). An example would be when a gastroenterologist reports the size of a polyp observed during a colonoscopy. This profile is the basis for the US Core Laboratory Result Observation Profile, which defines additional data elements to record and search laboratory test results.

The US Core Observation Clinical Result Profile sets minimum expectations to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Observation Occupation Profile

The US Core Occupation Observation Profile is based upon the core FHIR Observation Resource and implements the US Core Data for Interoperability (USCDI) Occupation and Occupation Industry requirements. This profile promotes interoperability and adoption through common implementation by setting minimum expectations for the Observation resource to record, search, and fetch a patient’s past or present job as occupation and industry, in other words, the type of work and type of business that compensates for work or assigns work to an unpaid worker or volunteer. In the context of this profile, a job is defined as a work situation, or a training or volunteer position held for a specified period. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Observation Pregnancy Intent Profile

The US Core Pregnancy Intent Observation Profile is based upon the core FHIR Observation Resource and implements the US Core Data for Interoperability (USCDI) v3 Pregnancy status requirements. To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch the “patient’s intent to become pregnant” over the next year. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Observation Pregnancy Status Profile

The US Core Pregnancy Status Observation Profile is based upon the core FHIR Observation Resource and implements the US Core Data for Interoperability (USCDI) v3 Pregnancy status requirements. This profile sets minimum expectations for the Observation resource to record, search, and fetch the “state or condition of being pregnant” associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Observation Screening Assessment Profile

The US Core Observation Screening Assessment Profile meets the requirements of the US Core Data for Interoperability (USCDI) Assessments. To promote interoperability and adoption through common implementation, it sets the minimum expectations for the Observation Resource to record, search, and fetch observations representing the questions and responses to surveys and screening and assessment tools. For example, a social history status such as education or food insecurity or an assessment of the patient’s cognitive, functional, or disability status. It can represent a single response, multiple responses, and multi-select “check all that apply” type questions. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Observation Sexual Orientation Profile

The US Core Observation Sexual Orientation Profile meets the U.S. Core Data for Interoperability (USCDI) v2 ‘Sexual Orientation’ requirements. this profile sets minimum expectations for the Observation resource to record, search, and fetch sexual orientation observations associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Organization Profile

This profile sets minimum expectations for the Organization resource to searching for and fetching an Organization associated with a patient or provider to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Patient Profile

The US Core Patient Profile meets the U.S. Core Data for Interoperability (USCDI) v3 ‘Patient Demographics’ requirements. This profile sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource when using this profile to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Pediatric BMI for Age Observation Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch pediatric body mass index (BMI) percentile per age and sex for youth 2-20 observations in FHIR using a standard LOINC code and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Pediatric Head Occipital Frontal Circumference Percentile Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch pediatric head occipital frontal circumference (OFC) percentile observations associated with a patients from birth to 37 Months of age using a standard LOINC code and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Pediatric Weight for Height Observation Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch pediatric weight-for-length per age and gender observations in FHIR with a standard LOINC code and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core Practitioner Profile

This profile sets minimum expectations for the Practitioner resource to record, search, and fetch basic demographics and other administrative information about an individual practitioner to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core PractitionerRole Profile

This profile sets minimum expectations for the PractitionerRole Resource to record, search, and fetch the practitioner role for a practitioner to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases. The requirements for the US Core Practitioner were drawn from the Argonaut Provider Directory, IHE Healthcare Provider Directory and the ONC Provider Directory Workshop.

US Core Procedure Profile

The US Core Procedure Profile is based upon the core FHIR Procedure Resource and meets the U.S. Core Data for Interoperability (USCDI) v2 ‘Procedures’ requirements. This profile sets minimum expectations for the Procedure resource to record, search, and fetch procedures associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Provenance Profile

This profile sets minimum expectations for the Provenance resource to record, search, and fetch Provenance information associated with a record to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. This FHIR Provenance profile here covers the minimal (basic) information to support lineage of information. It provides the floor for standards development for specific use cases. Prior to reviewing this profile, implementers are encouraged to read the Basic Provenance guidance page which documents several key use cases, specifically, what organization was responsible for the most recent action on the resource.

US Core Pulse Oximetry Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch pulse oximetry and inspired oxygen observations with a standard LOINC codes and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core QuestionnaireResponse Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the QuestionnaireResponse resource to record, search, and fetch retrieve captures the responses to form/survey and assessment tools such as the Protocol for Responding to and Assessing Patients’ Assets, Risks, and Experiences (PRAPARE) Survey. This profile is based on the Structured Data Capture (SDC) Questionnaire Response Profile and identifies the additional core elements, extensions, vocabularies and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific uses cases.

US Core RelatedPerson Profile

This profile sets minimum expectations for the RelatedPerson resource to record, search, and fetch basic administrative information about persons with a legal or familial relationship to a patient. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Respiratory Rate Profile

To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch respiratory rate observations with a standard LOINC code and UCUM units of measure. It is based on the US Core Vital Signs Profile and identifies which additional core elements, extensions, vocabularies, and value sets SHALL be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases.

US Core ServiceRequest Profile

This profile sets minimum expectations for recording, searching, and fetching the ServiceRequest resource to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Simple Observation Profile

This profile represents a person’s care preferences during their care and treatment. Examples include, but are not limited to religious preferences, dislikes and fears, and thoughts and feelings to be shared. To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch for a patient’s care experience preferences. This profile identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Smoking Status Observation Profile

The US Core Smoking Status Observation Profile is based upon the core FHIR Observation Resource and implements the U.S. Core Data for Interoperability (USCDI) v2 Smoking status’ requirements. This profile sets minimum expectations for the Observation resource to record, search, and fetch smoking status data associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Specimen Profile

This profile sets minimum expectations for the Specimen resource to record, search, and fetch “substances being sampled or tested. (e.g., nasopharyngeal swab, whole blood, serum, urine, wound swab)” associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Treatment Intervention Preference Profile

This profile represents personal health goals, preferences, and priorities for medical treatments or interventions in the event of a future health scenario where a person is unable to make medical decisions because of a serious illness or injury. To promote interoperability and adoption through common implementation, this profile sets minimum expectations for the Observation resource to record, search, and fetch for a patient’s treatment intervention preferences. This profile identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.

US Core Vital Signs Profile

To promote interoperability and adoption through common implementation, this profile is based on the base FHIR Vital Signs Profile and defines additional constraints on the Observation resource to represent vital signs observations. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases. This US Core profiles that are derived from this profile are listed below.

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). After version 6.0.0, this extension is no longer a USCDI Requirement.

US Core Direct email Extension

This email address is associated with a “Direct Secure Messaging” 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 Extension Questionnaire URI

The location where a non-FHIR questionnaire/survey form can be found. This extension is used when the survey,form, or questionnaire which is being anwered is not a FHIR Questionnaire, otherwise the canonical url for the FHIR Questionnaire is used.

US Core Gender Identity Extension

This extension represents an individual’s sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates SHOULD use the FHIR R5 genderIdentity extension. When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension.

US Core Jurisdiction Extension

An extension to communicate the US state or local jurisdiction for individual and entity identifiers. For example, a practitioner’s state or local jurisdiction for a license.

US Core Medication Adherence Extension

The Medication Adherence Extension is used to report whether a medication has been consumed according to instructions

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.
US Core Sex Extension

The Sex Extension is used to reflect the documentation of a person’s sex. Systems choosing to record sources of information should use the Provenance resource.

USCDI v3 includes a data element for sex, intended to support the exchange of a sex value that is not characterized as sex assigned at birth or birth sex. This Sex extension supports USCDI v3. Sex assigned at birth or birth sex can be recorded using the more specific US Core Birth Sex Extension. Future versions of this extension may be informed by the content of the HL7 Cross Paradigm IG: Gender Harmony - Sex and Gender Representation, which may include additional guidance on its relationship to administrative gender (Patient.gender).

US Core Tribal Affiliation Extension

This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.

US Core USCDI Requirement Extension

This extension is only used in the US Core Implementation Guide’’s Profile StructureDefinition elements. It flags elements that are Additional USCDI Requirements for certified systems. In other words, elements that are not marked as Must Support but are required for ONC Health IT certification testing. See the Conformance page for more information.

Terminology: Value Sets

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

Birth Sex

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

Detailed Race

The codes for the concepts ‘Unknown’, ‘Asked but no answer’, ‘other, and the 900+ CDC Race codes that are grouped under one of the 5 OMB race category codes.

Detailed ethnicity

The codes for the concepts ‘Unknown’, ‘Asked but no answer’, ‘other, and the 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes.

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.

OMB Ethnicity Categories

The codes for the concepts ‘Unknown’, ‘Asked but no answer’, and the ethnicity categories - ‘Hispanic or Latino’ and ‘Not 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’, ‘Asked but Unknown’, ‘Other Race’* and 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

* The use of ‘Other Race’ is discouraged for statistical analysis.

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 Clinical Result Observation Category

Used to classify the context of clinical result observations.

US Core Condition Codes

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 Diagnostic Report Category Codes

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

US Core Discharge Disposition

National Uniform Billing Committee, manual UB-04, UB form locator 17.

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:

  • 99211-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 Goal Codes

Concepts from CPT and LOINC code systems that can be used to indicate the goal.

US Core Laboratory Test Codes

Laboratory LOINC codes: From the introduction to August 2022 LOINC Users’ guide; “The current scope of the existing laboratory portion of the LOINC database includes all observations reported by clinical laboratories, including the specialty areas: chemistry, including therapeutic drug monitoring and toxicology; hematology; serology; blood bank; microbiology; cytology; surgical pathology; and fertility.

US Core Narrative Status

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

US Core Non Laboratory Codes

This value set includes All LOINC codes defined as type “clinical,” therefore excluding laboratory tests, survey instruments, and claims documents. This includes observables such as vital signs, hemodynamics, intake/output, EKG, obstetric ultrasound, and cardiac echo, and includes discrete and narrative diagnostic observations and reports.

US Core Observation Value Codes (SNOMED-CT)

Snomed-CT concept codes for coded results

US Core Pregnancy Intent Codes

This value set includes SNOMED CT codes and the HL7 V3 code for the concept “unknown”.

US Core Pregnancy Status Codes

This value set includes SNOMED CT codes and the HL7 V3 code for the concept “unknown”. These codes have historically been used to communicate the pregnancy status of a patient.

US Core Problem or Health Concern

Code set for category codes for US Core Condition Problems and Health Concerns Profile consisting of the concepts “problem” and “health-concern”.

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 Screening Assessment Condition Category

Category codes used in the US Core Condition Screening Assessment Profile to help identify the type of USCDI Health Status/Assessment data class being reported.

US Core Screening Assessment Observation Category

Category codes used in the US Core Observation Screening Assessment Profile to help identify the type of USCDI Health Status/Assessment data class being reported.

US Core ServiceRequest Category Codes

A set of SNOMED CT and LOINC concepts to classify a requested service

US Core Simple Observation Category

Used to classify the context of a survey, screening or assessment for simple observations and may be used to assist with indexing and searching for appropriate instances.

US Core Simple Observation Codes

This value set includes all LOINC codes and the SNOMED CT finding hierarchy codes

US Core Smoking Status Max-Binding

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

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.

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 Survey Codes

This value set includes screening and assessment panel codes in LOINC (Refer to Appendix A of LOINC Users’ Guide).

US Core Vital Signs ValueSet

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

USPS Two Letter Alphabetic Codes

This value set defines two letter USPS alphabetic codes.

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.

US Core Category

Category codes used across US Core Profiles and resource types. They are typically used when there is a need for categorization for searching and finding resources or workflow hints.

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.

US Core Treatment Intervention Preference CodeSystem

A code representing an individual’s medical intervention (treatment) preferences.

Example: Example Instances

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

10 Minute Apgar Score Example

This example of a US Core Survey Observation Profile illustrates its use to directly capture individual surveys assessment items as an observations. It is not derived from a FHIR QuestionnaireResponse.

10 Minute Apgar Score Panel Example

This example of a US Core Survey Observation Profile illustrates its use to directly capture surveys assessments as a panel of observations. It is not derived from a FHIR QuestionnaireResponse.

10 minute Apgar Color Example

This example of a US Core Survey Observation Profile illustrates its use to directly capture individual surveys assessment items as an observations. It is not derived from a FHIR QuestionnaireResponse.

10 minute Apgar Heart Rate Example

This example of a US Core Survey Observation Profile illustrates its use to directly capture individual surveys assessment items as an observations. It is not derived from a FHIR QuestionnaireResponse.

10 minute Apgar Muscle Tone Example

This example of a US Core Survey Observation Profile illustrates its use to directly capture individual surveys assessment items as an observations. It is not derived from a FHIR QuestionnaireResponse.

10 minute Apgar Reflex Irritability Example

This example of a US Core Survey Observation Profile illustrates its use to directly capture individual surveys assessment items as an observations. It is not derived from a FHIR QuestionnaireResponse..

10 minute Apgar Respiratory effort Example

This example of a US Core Survey Observation Profile illustrates its use to directly capture individual surveys assessment items as an observations. It is not derived from a FHIR QuestionnaireResponse.

Ahc-Hrsn Item Observation Example 68517-2

This AHC HRSN Item Example 68517-2 (How many times in the past 12 months have you had 5 or more drinks in a day (males) or 4 or more drinks in a day (females)?) is an example of the US Core Observation Screening and Assessment Profile and is referenced by the ServiceRequest for Rehab Example

Alcohol Use Disorder Identification Test - Consumption [AUDIT-C] Questionnaire Example

Alcohol Use Disorder Identification Test - Consumption [AUDIT-C] questionnaire example. It is based on the on US Core Screening and Assessments guidance using Questionnaire/QuestionnaireResponse resources.

Alcohol Use Disorder Identification Test - Consumption [AUDIT-C] QuestionnaireResponse Example

This is the LHC Form Alcohol Use Disorder Identification Test - Consumption [AUDIT-C] QuestionnaireResponse example. It is based on the on US Core Screening and Assessments guidance using Questionnaire/QuestionnaireResponse resources.

Alcohol Use Status Example

This is an alcohol-use-status example for the Simple Observation Profile. It is based on the on US Core Screening and Assessments guidance using Simple Observations.

Alcoholic Drinks Per Day Example

This is an Alcoholic Drinks Per Day example for the Simple Observation Profile. It is based on the on US Core Screening and Assessments guidance using Simple Observations.

AllergyIntolerance Example

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

AllergyIntolerance Non-pharmacologic Agent Example

This is a allergyintolerance example for the US Core AllergyIntolerance Profile representing a non-pharmacologic substance (latex) that the patient is allergic to.

AllergyIntolerance Provenance Example

This is a allergyintolerance provenance example for the Bundle Profile.

At Home In Vitro Test Example

This is an At home in vitro test example for the US Core Observation Lab Profile, with a coded result value.

Audit-C Item Example 68517-2

This is a Audit-C Item Example 68517-2 (How many times in the past year have you have X or more drinks in a day?) for the US Core Observation Screening Assessment Profile

Audit-C Item Example 68519-8

This is a Audit-C Item Example 68519-8 (How many standard drinks containing alcohol do you have on a typical day?) for the US Core Observation Screening Assessment Profile

Audit-C Item Example 68520-6

This is a Audit-C Item Example 68520-6 (How often do you have 6 or more drinks on 1 occasion?) for the US Core Observation Screening Assessment Profile

Audit-C Item Example 75626-2

This is a Audit-C Item Example 75626-2 (Total score [AUDIT-C]) for the US Core Observation Screening Assessment Profile

Audit-C Panel Example 72109-2

This is a Audit-C Panel Example 72109-2 (Alcohol Use Disorder Identification Test - Consumption [AUDIT-C]) for the US Core Observation Screening Assessment Profile

Average Blood Pressure Example

This is an average blood pressure example for the Vitalsigns Profile. It is based on the Vital Signs with Qualifying Elements Average Blood Pressure 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.

Blood Pressure Example

This is a blood pressure example for the Vitalsigns Profile.

CBC Example

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

Capillary refill Time Nail Bed Example

This is a Capillary refill Time Nail Bed Example for the Clinical Test Result Observation Profile.

Care Experience Preference Example

This is an care experience preference example for the Care Experience Profile. It is based on the US Core Simple Observation Profile.

CareTeam Example

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

Chest Xray Example

This is an example Media xray image that is reference by the US Core DiagnosticReport Note Profile.

Colonoscopy Example

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

Condition Duodenal Ulcer Example

This example of a US Core Condition Problems and Health Concerns Profile illustrates its use to capture information about a patient’s active duodenal ulcer with a category of ‘problem-list-item’.

Coverage Example

This is a coverage example for the US Core Coverage Profile.

DXA Bone density quantitative measurement panel Example

This is a DXA Bone density quantitative measurement panel report example for the US Core DiagnosticReport Note Profile.

DXA Femur-L ArMass BMD Example

This is a DXA Femur-L ArMass BMD Example for the Imaging Result Observation Profile.

DXA Femur-L T-score BMD Example

This is a DXA Femur-L T-score BMD Example for the Clinical Test Result Observation Profile.

DXA Femur-L Z-score BMD Example

This is a DXA Femur-L Z-score BMD Example for the Imaging Result Observation Profile.

DXA Hip-L ArMass BMD Example

This is a DXA Hip-L ArMass BMD Example for the Imaging Result Observation Profile.

DXA Hip-L T-score BMD Example

This is a DXA Hip-L T-score BMD Example for the Imaging Result Observation Profile.

DXA Hip-L Z-score BMD Example

This is a DXA Hip-L Z-score BMD Example for the Imaging Result Observation Profile.

Deceased Patient Example

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

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.

Discharge Summary Example

This is a discharge summary example for the US Core DocumentReference. It is used in the Write Note Example.

Docref Example 1

This bundle is a the response to a $docref operation and contains an example US Core DocumentReference. It is used in Example 1: Request the latest CCD.

Docref Example 2

This bundle is a the response to a $docref operation and contains an examples of US Core DocumentReference. It is used in Example 2: Request Procedure Notes and Discharge Summaries for 2019.

EKG Strip Image

This is an example Media image that is reference by the US Core DiagnosticReport Note Profile.

EKG impression Example

This is a EKG impression Example for the Clinical Test Result Observation Profile.

EKG lead Example

This is a EKG lead Example for the Clinical Test Result Observation Profile.

Encounter 1 Example

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

Encounter 1036 Example

This is a encounter 1036 example for the Encounter Profile.

Encounter Delivery Example

This is a patient delivery encounter example for the Encounter Profile.

Encounter Diagnosis Example 1

This example of a US Core Condition Encounter Diagnosis Profile illustrates its use to capture information about a patient’s encounter diagnosis.

Encounter Diagnosis Example 2

This example of a US Core Condition Encounter Diagnosis Profile illustrates its use to capture information about a patient’s encounter diagnosis.

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 and CBC example for the US Core DiagnosticReport Lab Profile.

Evs Item Example 68516-4

This is a Evs Item Example 68516-4 (On those days that you engage in moderate to strenuous exercise, how many minutes, on average, do you exercise?) for the US Core Observation Screening Assessment Profile

Evs Item Example 89555-7

This is a Evs Item Example 89555-7 (How many D per W did you engage in moderate to strenuous physical activity in the last 30D) for the US Core Observation Screening Assessment Profile

Evs Panel Example 89574-8

This is a Evs Panel Example 89574-8 (Exercise Vital Sign (EVS)) for the US Core Observation Screening Assessment Profile

Exercise Per Day Example

This is an minutes exercise per day example for the Simple Observation Profile. It is based on the on US Core Screening and Assessments guidance using Simple Observations.

Exercise Per Week Example

This is a days exercise per week example for the Simple Observation Profile. It is based on the on US Core Screening and Assessments guidance using Simple Observations.

Exercise Vital Sign Questionnaire Example

This is the LHC Form Exercise Vital Sign (EVS) Questionnaire Example. It is based on the on US Core Screening and Assessments guidance using Questionnaire/QuestionnaireResponse resources.

Exercise Vital Sign QuestionnaireResponse Example

This is the LHC Form Exercise Vital Sign (EVS) QuestionnaireResponse Example. It is based on the on US Core Screening and Assessments guidance using Questionnaire/QuestionnaireResponse resources.

Goal 1 Example

This is a goal 1 example for the US Core Goal Profile and demonstrates use free text for Goal.description.

Goal 2 Example

This is a goal 2 example for the US Core Goal Profile and demonstrates use of a code for Goal.description.

HL7East Example

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

Head Circumference Example

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

Health Concern Example

This example of a US Core Condition Problems and Health Concerns Profile illustrates its use to capture information about a patient’s health concern.

Heart Rate Example

This is a heart rate example for the Vitalsigns Profile.

Heart rate rhythm Example

This is a Heart rate rhythm Example for the Clinical Test Result Observation Profile.

Height Example

This is a height example for the Vitalsigns Profile.

Hematocrit Example

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

Hemoglobin Example

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

Hemolyzed Serum Specimen Example

This is a serum specimen example for the US Core Specimen Profile. It demonstrates the use of the USCDI requirements for specimen condition and body source site.

Hospital Location

This is an example hospital location for the US Core Location Profile.

Hvs Item Example 88122-7

This is a Hvs Item Example 88122-7 ((I/We) worried whether (my/our) food would run out before (I/we) got money to buy more.) for the US Core Observation Screening Assessment Profile

Hvs Item Example 88123-5

This is a Hvs Item Example 88123-5 (The food that (I/we) bought just didn’t last, and (I/we) didn’t have money to get more.) for the US Core Observation Screening Assessment Profile

Hvs Item Example 88124-3

This is a Hvs Item Example 88124-3 (Food insecurity risk) for the US Core Observation Screening Assessment Profile

Hvs Panel Example 88121-9

This is a Hvs Panel Example 88121-9 (Hunger Vital Sign [HVS]) for the US Core Observation Screening Assessment Profile

Imm 1 Example

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

Jugular vein distension Example

This is a Jugular vein distension Example for the Clinical Test Result Observation 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.

Leukocytes Example

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

MCH Example

This is a MCH example for the US Core Observation Lab Profile. It is also used in the CBC example for the US Core DiagnosticReport Lab Profile.

MCHC Example

This is a MCHC example for the US Core Observation Lab Profile. It is also used in the CBC example for the US Core DiagnosticReport Lab Profile.

MCV Example

This is a MCV example for the US Core Observation Lab Profile. It is also used in the CBC example for the US Core DiagnosticReport Lab Profile.

Medication Dispense Example

This is a dispense example for the US Core MedicationDispense Profile.

MedicationRequest Coded Oral Axid Example

This is an prescribed oral solution example for the US Core MedicationRequest Profile. It represents the medication and reason using codes.

MedicationRequest Contained Oral Axid Example

This is an prescribed oral solution example for the US Core MedicationRequest Profile. It represents the medication as a contained Medication resource.

MedicationRequest Referenced Oral Axid Example

This is an prescribed oral solution example for the US Core MedicationRequest Profile. It represents the medication and reason as reference Medication and Condition resources.

MedicationRequest Self Tylenol Example

This is a “self-prescribed” tylenol example for the MedicationRequest Profile.

Metabolic Panel Example

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

Missing Coded Data Example

This is an example to demonstrate the using ‘unknown’ from the DataAbsentReason Code System when data is missing for a CareTeam resource where the mandatory CareTeam.participant.role value is unknown.

OFC Percentile Example

This is a OFC percentile example for the Head Occipital Frontal Circumference Percentile 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.

Occupation Observation Example

This example of the US Core Observation Occupation Profile documents a nursing assistant’s work type.

Occupation Observation Example: Industry Unknown

This example of the US Core Observation Occupation Profile represents a situation where the occupation is known, but the industry is not.

Occupation Observation Example: Unknown Occupation

This example of the US Core Observation Occupation Profile represents a situation where the industry is known, but the occupation is not.

Organization 2 Example

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

Organization Acme Lab Example

This is an example laboratory example using the US Core Organization Profile.

Organization Acme Payer Example

This is an example payer using the US Core Organization Profile.

Organization Holy Healthcare Example

This is an example managing organization using the US Core Organization 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.

P-R interval {EKG lead} Example

This is a P-R interval {EKG lead} Example for the Clinical Test Result Observation Profile.

PHQ9 Item Example 44250-9

This is a PHQ9 Item Example 44250-9 (Little interest or pleasure in doing things in last 2 weeks) for the US Core Observation Screening Assessment Profile

PHQ9 Item Example 44251-7

This is a PHQ9 Item Example 44251-7 (Poor appetite or overeating) for the US Core Observation Screening Assessment Profile

PHQ9 Item Example 44252-5

This is a PHQ9 Item Example 44252-5 (Trouble concentrating on things, such as reading the newspaper or watching television) for the US Core Observation Screening Assessment Profile

PHQ9 Item Example 44253-3

This is a PHQ9 Item Example 44253-3 (Moving or speaking so slowly that other people could have noticed. Or the opposite-being so fidgety or restless that you have been moving around a lot more than usual) for the US Core Observation Screening Assessment Profile

PHQ9 Item Example 44254-1

This is a PHQ9 Item Example 44254-1 (Feeling tired or having little energy) for the US Core Observation Screening Assessment Profile

PHQ9 Item Example 44255-8

This is a PHQ9 Item Example 44255-8 (Feeling down, depressed, or hopeless in last 2 weeks) for the US Core Observation Screening Assessment Profile

PHQ9 Item Example 44258-2

This is a PHQ9 Item Example 44258-2 (Feeling bad about yourself-or that you are a failure or have let yourself or your family down) for the US Core Observation Screening Assessment Profile

PHQ9 Item Example 44259-0

This is a PHQ9 Item Example 44259-0 (Trouble falling or staying asleep, or sleeping too much) for the US Core Observation Screening Assessment Profile

PHQ9 Item Example 44260-8

This is a PHQ9 Item Example 44260-8 (Thoughts that you would be better off dead, or of hurting yourself in some way) for the US Core Observation Screening Assessment Profile

PHQ9 Item Example 44261-6

This is a PHQ9 Item Example 44261-6 (Patient Health Questionnaire 9 item (PHQ-9) total score [Reported]) for the US Core Observation Screening Assessment Profile

PHQ9 Item Example 69722-7

This is a PHQ9 Item Example 69722-7 (How difficult have these problems made it for you to do your work, take care of things at home, or get along with other people?) for the US Core Observation Screening Assessment Profile

PHQ9 Panel Example 44249-1

This is a PHQ9 Panel Example 44249-1 (PHQ-9 quick depression assessment panel [Reported.PHQ]) for the US Core Observation Screening Assessment Profile

PRAPARE Panel Example 93043-8

This is a Prapare Panel Example 93043-8 (Personal characteristics) for the US Core Observation Screening Assessment Profile

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.

Patient Niece Example

This is a patient niece example for the US Core RelatedPerson Profile 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.

Platelets Example

This is a Platelets example for the US Core Observation Lab Profile and CBC example for the US Core DiagnosticReport Lab 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.

Practitioner Pharmacist Example

This is a pharmacist example using the US Core Practitioner Profile.

PractitionerRole_Practitioner_Endpoint_Bundle_Example Example

This is a PractitionerRole_Practitioner_Endpoint_Bundle_Example example for the Bundle Profile.

Prapare Item Example 54899-0

This is a Prapare Item Example 54899-0 (Preferred language) for the US Core Observation Screening Assessment Profile

Prapare Item Example 56051-6

This is a Prapare Item Example 56051-6 (Do you consider yourself Hispanic/Latino?) for the US Core Observation Screening Assessment Profile

Prapare Item Example 56799-0

This is a Prapare Item Example 56799-0 (Address) for the US Core Observation Screening Assessment Profile

Prapare Item Example 63512-8

This is a Prapare Item Example 63512-8 (How many people are living or staying at this address?) for the US Core Observation Screening Assessment Profile

Prapare Item Example 63586-2

This is a Prapare Item Example 63586-2 (What was your best estimate of the total income of all family members from all sources, before taxes, in last year?) for the US Core Observation Screening Assessment Profile

Prapare Item Example 67875-5

This is a Prapare Item Example 67875-5 (Employment status current) for the US Core Observation Screening Assessment Profile

Prapare Item Example 71802-3

This is a Prapare Item Example 71802-3 (Housing status) for the US Core Observation Screening Assessment Profile

Prapare Item Example 76437-3

This is a Prapare Item Example 76437-3 (Primary insurance) for the US Core Observation Screening Assessment Profile

Prapare Item Example 76501-6

This is a Prapare Item Example 76501-6 (Within the last year, have you been afraid of your partner or ex-partner?) for the US Core Observation Screening Assessment Profile

Prapare Item Example 82589-3

This is a Prapare Item Example 82589-3 (Highest level of educ) for the US Core Observation Screening Assessment Profile

Prapare Item Example 93026-3

This is a Prapare Item Example 93026-3 (Do you feel physically and emotionally safe where you currently live?) for the US Core Observation Screening Assessment Profile

Prapare Item Example 93027-1

This is a Prapare Item Example 93027-1 (Are you a refugee?) for the US Core Observation Screening Assessment Profile

Prapare Item Example 93028-9

This is a Prapare Item Example 93028-9 (In the past year, have you spent more than 2 nights in a row in a jail, prison, detention center, or juvenile correctional facility?) for the US Core Observation Screening Assessment Profile

Prapare Item Example 93029-7

This is a Prapare Item Example 93029-7 (How often do you see or talk to people that you care about and feel close to (For example: talking to friends on the phone, visiting friends or family, going to church or club meetings)?) for the US Core Observation Screening Assessment Profile

Prapare Item Example 93030-5

This is a Prapare Item Example 93030-5 (Has lack of transportation kept you from medical appointments, meetings, work, or from getting things needed for daily living?) for the US Core Observation Screening Assessment Profile

Prapare Item Example 93033-9

This is a Prapare Item Example 93033-9 (Are you worried about losing your housing?) for the US Core Observation Screening Assessment Profile

Prapare Item Example 93034-7

This is a Prapare Item Example 93034-7 (Have you been discharged from the armed forces of the United States?) for the US Core Observation Screening Assessment Profile

Prapare Item Example 93035-4

This is a Prapare Item Example 93035-4 (At any point in the past 2 years, has season or migrant farm work been your or your family’s main source of income?) for the US Core Observation Screening Assessment Profile

Prapare Item Example 93038-8

This is a Prapare Item Example 93038-8 (Stress is when someone feels tense, nervous, anxious or can’t sleep at night because their mind is troubled. How stressed are you?) for the US Core Observation Screening Assessment Profile

Prapare Multiselect-Item Example 32624-9-Answer0

This is a Prapare Multiselect-Item Example 32624-9-Answer0 (Race) for the US Core Observation Screening Assessment Profile

Prapare Multiselect-Item Example 32624-9-Answer1

This is a Prapare Multiselect-Item Example 32624-9-Answer1 (Race) for the US Core Observation Screening Assessment Profile

Prapare Multiselect-Item Example 93031-3-Answer0

This is a Prapare Multiselect-Item Example 93031-3-Answer0 (In the past year, have you or any family members you live with been unable to get any of the following when it was really needed?) for the US Core Observation Screening Assessment Profile

Prapare Multiselect-Item Example 93031-3-Answer1

This is a Prapare Multiselect-Item Example 93031-3-Answer1 (In the past year, have you or any family members you live with been unable to get any of the following when it was really needed?) for the US Core Observation Screening Assessment Profile

Prapare Panel Example 93025-5

This is a Prapare Panel Example 93025-5 (Protocol for Responding to and Assessing Patients’ Assets, Risks, and Experiences [PRAPARE]) for the US Core Observation Screening Assessment Profile

Prapare Panel Example 93039-6

This is a Prapare Panel Example 93039-6 (Optional additional questions) for the US Core Observation Screening Assessment Profile

Prapare Panel Example 93040-4

This is a Prapare Panel Example 93040-4 (Social and emotional health) for the US Core Observation Screening Assessment Profile

Prapare Panel Example 93041-2

This is a Prapare Panel Example 93041-2 (Money and resources) for the US Core Observation Screening Assessment Profile

Prapare Panel Example 93042-0

This is a Prapare Panel Example 93042-0 (Family and home) for the US Core Observation Screening Assessment Profile

Pregnancy Intent Observation Example

This is a pregnancy intent example for the US Core Observation Pregnancy Intent Profile.

Pregnancy Status Observation Example

This is a pregnancy status example for the US Core Observation Pregnancy Status Profile.

Procedure Defibrillator Implant Example

This US Core Procedure Profile is an example of an Defibrillator implant Procedure. In this example, the reason for a referral is communicated through `Procedure.code’.

Pulse intensity Palpation Example

This is a Pulse intensity Palpation Example for the Clinical Test Result Observation Profile.

Q-T interval {EKG lead} Example

This is a Q-T interval {EKG lead} Example for the Clinical Test Result Observation Profile.

QRS dur {EKG lead} Example

This is a QRS dur {EKG lead} Example for the Clinical Test Result Observation Profile.

Questionnaire Hunger Vital Sign [HVS] Example

An example of an SDC Questionnaire that represents the Hunger Vital Sign Example questionnaire defined in LOINC (code 88121-9). The example is generated using the LHC-Forms SDC Questionnaire App.

Questionnaire PHQ-9 Example

An example of a SDC Questionnaire that represents the Hunger Vital Sign Example questionnaire defined in LOINC (code 44249-1). This example is generated using the LHC-Forms SDC Questionnaire App.

Questionnaire PRAPARE Example

An example of an SDC Questionnaire that represents the Protocol for Responding to and Assessing Patients’ Assets, Risks, and Experiences [PRAPARE] questionnaire defined in LOINC (code 93025-5). This example is generated using the LHC-Forms SDC Questionnaire App.

QuestionnaireResponse Glascow Coma Score Example

This example of a US Core QuestionnaireResponse references a non-FHIR survey instrument (in this case a pdf) instead of a FHIR Questionnaire.

QuestionnaireResponse Hunger Vital Sign [HVS] Example

An example of a US Core QuestionnaireResponse that represents questions and selected answers from the Hunger Vital Sign Example questionnaire defined in LOINC (code 88122-7). This example is generated using the LHC-Forms SDC Questionnaire App.

QuestionnaireResponse PHQ-9 Example

An example of a US Core QuestionnaireResponse that represents questions and selected answers from the The Patient Health Questionnaire (PHQ-9) questionnaire defined in LOINC (code 44249-1). The example is generated using the LHC-Forms SDC Questionnaire App.

QuestionnaireResponse PRAPARE Example

This is the QuestionnaireResponse example that is referenced by the US Core Observation Screening Assessment Profile PRAPARE examples. This example is generated using the LHC-Forms SDC Questionnaire App.

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.

SDOH Problem/Health Concern Example

This example of a US Core Condition Problems and Health Concerns Profile illustrates its use to capture information about a patient’s SDOH Problem/Health Concern.

Saint Luke W Endpoint Example

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

Serum BUN Example

This is a BUN 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 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 Creatinine Example

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

Serum Glucose Example

This is a serum glucose 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 Specimen Example

This is a serum specimen example for the US Core Specimen Profile.

Serum Total Bilirubin Example

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

ServiceRequest Example

This is a service request example for the US Core ServiceRequest Profile Profile.

ServiceRequest for Rehab Example

This is an example requesting alcohol rehab sessions for a patient using the US Core ServiceRequest Profile Profile.

Sexual Orientation Observation Example

This is an sexual orientation example for the US Core Observation Sexual Orientation Profile.

Simple Observation Cognitive Status Example

This US Core Simple Observation Profile is a cognitive status determination which is not based on any formal assessment tool or survey. (This example is adapted from the PACIO Cognitive Status Implementation Guide ver 1.0.0.)

Simple Observation Disability Status Example

This US Core Simple Observation Profile is a degree of depression severity determination which is based on the results of a PHQ-9 (Patient Health Questionnaire-9) screening.

Simple Observation Functional Status Example

This US Core Simple Observation Profile is a functional status determination which is not based on any formal assessment tool or survey.

Simple Observation SDOH Example

This US Core Simple Observation Profile is a SDOH determination which is not based on any formal assessment tool or survey.

Some Day Smoker Example

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

Substance Use Status Example

This is an Substance-use-status example for the Simple Observation Profile. It is based on the on US Core Screening and Assessments guidance using Simple Observations.

Taps Item Example 75889-6

This is a Taps Item Example 75889-6 (How often have you had four or more drinks in one day during the past year [Reported]) for the US Core Observation Screening Assessment Profile

Taps Item Example 88037-7

This is a Taps Item Example 88037-7 (How often have you had five or more drinks in one day during the past year [Reported]) for the US Core Observation Screening Assessment Profile

Taps Item Example 96842-0

This is a Taps Item Example 96842-0 (How often have you used any tobacco product in past 12 months) for the US Core Observation Screening Assessment Profile

Taps Item Example 96843-8

This is a Taps Item Example 96843-8 (How often have you used illegal or recreational drugs in past 12 months) for the US Core Observation Screening Assessment Profile

Taps Item Example 96844-6

This is a Taps Item Example 96844-6 (How often have you used any prescription medications just for the feeling, more than prescribed or that were not prescribed for you in past 12 months [TAPS]) for the US Core Observation Screening Assessment Profile

Taps Panel Example 96841-2

This is a Taps Panel Example 96841-2 (Tobacco, Alcohol, Prescription medications, and other Substance use screen [TAPS]) for the US Core Observation Screening Assessment Profile

Targeted Provenance Example

This is a provenance example for the US Core Provenance Profile to demonstrate how Provenance can be used to document the source of individual elements such as Race and Ethnicity (R/E), gender identity.

Targeted Provenance Patient Example

This is a patient example for the US Core Patient Profile to demonstrate how Provenance can be used to document the source of individual elements such as Race and Ethnicity (R/E), gender identity.

Temperature Example

This is a temperature example for the Vitalsigns Profile.

Tobacco, Alcohol, Prescription medications, and other Substance use screen [TAPS] Questionnaire Example

Tobacco, Alcohol, Prescription medications, and other Substance use screen [TAPS] questionnaire example. It is based on the on US Core Screening and Assessments guidance using Questionnaire/QuestionnaireResponse resources.

Tobacco, Alcohol, Prescription medications, and other Substance use screen [TAPS] QuestionnaireResponse Example

This is the LHC Form Tobacco, Alcohol, Prescription medications, and other Substance use screen [TAPS] QuestionnaireResponse example. It is based on the on US Core Screening and Assessments guidance using Questionnaire/QuestionnaireResponse resources.

Treatment Intervention Preference Example

This is an intervention preference example for the Treatment Intervention Profile. It is based on the US Core Simple Observation Profile.

UDI 1 Example

This is a UDI 1 example for the US Core Implantable Device 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.

Weight Example

This is a weight example for the Vitalsigns Profile.

Xray Chest Findings Example

This example of a US Core Observation Clinical Result Profile illustrates its use to capture information about a patient’s radiology study findings.

Xray Chest Impression Example

This example of a US Core Observation Clinical Result Profile illustrates its use to capture information about a patient’s radiology study impression.