Health eData 1 Sandbox
0.1.0 - CI Build United States of America flag

Health eData 1 Sandbox, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/argonautproject/USCDIV7/ 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.

AdverseEvent Examples

Examples for testing the USCDI V7 AdverseEvent examples

Fever After Immunization Example

This example of a US Core AdverseEvent Profile records a fever the patient experienced after an immunization.

Rash After Medication Example

This example of a US Core AdverseEvent Profile records a rash the patient experienced after taking an oral penicillin.

AllergyIntolerance Examples

Examples for testing the USCDI V7 AllergyIntolerance examples

AllergyIntolerance Low Criticality Example

This example of a US Core AllergyIntolerance Profile illustrates a confirmed latex contact allergy assessed as low criticality based on a history of mild, localized contact dermatitis without systemic involvement.

AllergyIntolerance Unable-to-Assess Criticality Example

This example of a US Core AllergyIntolerance Profile illustrates a self-reported childhood sulfonamide reaction for which the recorder cannot determine the potential clinical harm because the patient cannot recall the prior manifestation or severity.

Appointment Examples

Examples for testing the USCDI V7 Appointment examples

Appointment From Referral Example

This example of a US Core Appointment Profile illustrates a booked appointment created in response to a referral ServiceRequest.

Appointment Resulting In An Encounter Example

This example of a US Core Appointment Profile illustrates a fulfilled appointment paired with the resulting Encounter that references it via Encounter.appointment.

Booked Future Appointment Example

This is a booked future annual physical exam appointment example for the US Core Appointment Profile.

Cancelled Appointment Example

This is a cancelled office visit appointment example for the US Core Appointment Profile.

Office Visit Follow-up Appointment Example

This is a fulfilled follow-up office visit appointment example for the US Core Appointment Profile.

Telehealth Appointment Example

This is a booked telehealth consultation appointment example for the US Core Appointment Profile.

CareTeam Examples

Examples for testing the USCDI V7 CareTeam examples

Healthcare Agent CareTeam Example

This example of a US Core CareTeam Profile identifies the patient's healthcare agent - a related person legally authorized to make healthcare decisions on behalf of the patient if the patient cannot communicate with medical personnel.

DeviceRequest Examples

Examples for testing the USCDI V7 DeviceRequest examples

DeviceRequest Continuous Glucose Monitor Example

This is an example order for a continuous glucose monitor for a patient with diabetes using the US Core DeviceRequest Profile.

DeviceRequest CPAP Example

This is an example order for a continuous positive airway pressure (CPAP) device for a patient with obstructive sleep apnea using the US Core DeviceRequest Profile.

DeviceRequest Hearing Aid Example

This is an example order for a hearing aid for a patient with sensorineural hearing loss using the US Core DeviceRequest Profile.

DeviceRequest Home Oxygen Example

This is an example order for a home oxygen concentrator for a patient with chronic obstructive pulmonary disease using the US Core DeviceRequest Profile.

DeviceRequest Insulin Pump Example

This is an example order for an insulin pump for a patient with type 1 diabetes using the US Core DeviceRequest Profile.

DeviceRequest Wheelchair Example

This is an example order for a manual wheelchair as durable medical equipment using the US Core DeviceRequest Profile.

DiagnosticReport Examples

Examples for testing the USCDI V7 DiagnosticReport examples

Chest X-ray Report Linked to ImagingStudy Example

This example of a US Core DiagnosticReport Note Profile is a portable chest radiograph report that links to its images through the imagingStudy reference to the US Core ImagingStudy Profile Chest X-ray example.

Encounter Examples

Examples for testing the USCDI V7 Encounter examples

Encounter From Appointment Example

This is an encounter example for the US Core Encounter Profile that records the visit resulting from a scheduled appointment, referenced via Encounter.appointment.

Flag Examples

Examples for testing the USCDI V7 Flag examples

ASL Interpreter Accommodation Flag Example

This example of a US Core Flag Profile illustrates a patient accommodation indicating that an American Sign Language (ASL) interpreter is needed at the point of care.

Service Animal Accommodation Flag Example

This example of a US Core Flag Profile illustrates a patient accommodation indicating that a service animal must be permitted to accompany the patient within the facility.

Wheelchair Assistance Flag Example

This example of a US Core Flag Profile illustrates a patient accommodation indicating that staff assistance with pushing a wheelchair is needed during clinical encounters.

ImagingStudy Examples

Examples for testing the USCDI V7 ImagingStudy examples

Chest X-ray ImagingStudy Example

This example of a US Core ImagingStudy Profile records a single-series portable chest radiograph accessible through a WADO-RS endpoint. The radiology DiagnosticReport references this study through its imagingStudy element.

Multi-series CT ImagingStudy Example

This example of a US Core ImagingStudy Profile records a two-series computed tomography study of the abdomen and pelvis with the series and instance skeleton populated.

Screening Mammogram ImagingStudy Example

This example of a US Core ImagingStudy Profile records a bilateral screening mammogram and carries a procedureCode so the study can be retrieved by an electronic clinical quality measure (eCQM).

WADO-RS Imaging Endpoint Example

This WADO-RS Endpoint example provides the DICOMweb retrieve base URL used by US Core ImagingStudy examples to access study images.

MedicationAdministration Examples

Examples for testing the USCDI V7 MedicationAdministration examples

Dose Not Given - Patient Refused Example

This example of a US Core MedicationAdministration Profile records a scheduled morning dose of axid that was not administered because the patient refused.

In-Progress Vancomycin Infusion Example

This example of a US Core MedicationAdministration Profile records an in-progress IV infusion of vancomycin 1 g over 90 minutes; the end time is open while the infusion runs.

Inpatient IV Cefazolin Administration Example

This example of a US Core MedicationAdministration Profile records a completed inpatient IV infusion of cefazolin 1 g given over 30 minutes by a registered nurse.

PRN Acetaminophen Administration Example

This example of a US Core MedicationAdministration Profile records a completed PRN oral dose of acetaminophen 650 mg given for pain.

Medication Examples

Examples for testing the USCDI V7 Medication examples

Oral Penicillin V Example

This is an oral penicillin V example for the US Core Medication Profile.

NutritionOrder Examples

Examples for testing the USCDI V7 NutritionOrder examples

NutritionOrder Cardiac Diet Example

This example of a US Core Nutrition Order Profile illustrates a low sodium cardiac diet ordered for a patient with congestive heart failure.

NutritionOrder Clear Liquid Diet Example

This example of a US Core Nutrition Order Profile illustrates a clear liquid diet ordered for a patient in preparation for a colonoscopy procedure.

NutritionOrder Mediterranean Diet Example

This example of a US Core Nutrition Order Profile illustrates a Mediterranean diet ordered to support cardiovascular health for a patient with elevated cardiovascular risk.

NutritionOrder Whole Food Diet Example

This example of a US Core Nutrition Order Profile illustrates a whole food diet ordered for general health promotion. The diet type is recorded as text because the bound FHIR R4 diet-type value set does not include a specific coded concept for "whole food diet."

Observation Examples

Examples for testing the USCDI V7 Observation examples

ASL Interpreter Accommodation Observation Example

This example of a US Core Observation Patient Accommodation Profile records that the patient requires an American Sign Language (ASL) interpreter at the point of care.

ASL Interpreter Accommodation Simple Observation Example

This example of a US Core Simple Observation Profile records that the patient requires an American Sign Language (ASL) interpreter at the point of care.

Service Animal Accommodation Observation Example

This example of a US Core Observation Patient Accommodation Profile records that the patient's service animal must be permitted to accompany the patient within the facility.

Service Animal Accommodation Simple Observation Example

This example of a US Core Simple Observation Profile records that the patient's service animal must be permitted to accompany the patient within the facility.

Tobacco Item Example 11366-2

This is a Tobacco Item Example 11366-2 (History of Tobacco use Narrative) for the US Core Observation Screening Assessment Profile

Tobacco Item Example 72166-2

This is a Tobacco Item Example 72166-2 (Tobacco smoking status) for the US Core Observation Screening Assessment Profile

Tobacco Item Example 74011-8

This is a Tobacco Item Example 74011-8 (Lifetime tobacco use) for the US Core Observation Screening Assessment Profile

Tobacco Item Example 81228-9

This is a Tobacco Item Example 81228-9 (Tobacco product) for the US Core Observation Screening Assessment Profile

Tobacco Item Example 82769-1

This is a Tobacco Item Example 82769-1 (Smoked or non-smoked tobacco) for the US Core Observation Screening Assessment Profile

Tobacco Item Example 8663-7

This is a Tobacco Item Example 8663-7 (Cigarettes smoked current (pack per day) - Reported) for the US Core Observation Screening Assessment Profile

Tobacco Item Example 88029-4

This is a Tobacco Item Example 88029-4 (Tobacco use duration) for the US Core Observation Screening Assessment Profile

Tobacco Item Example 88031-0

This is a Tobacco Item Example 88031-0 (Smokeless tobacco status) for the US Core Observation Screening Assessment Profile

Tobacco Panel Example 88028-6

This is a Tobacco Panel Example 88028-6 (Tobacco use panel) for the US Core Observation Screening Assessment Profile

Tobacco Use Panel Example

This example for the proposed US Core Tobacco Use Profile shows a single Observation using component elements to convey the LOINC 88028-6 Tobacco use panel members. The patient is a current every day cigarette and e-cigarette smoker who also uses smokeless tobacco occasionally, smokes less than one pack per day, has used tobacco for ten years, and has a calculated cumulative exposure of less than ten pack-years.

Wheelchair Assistance Accommodation Observation Example

This example of a US Core Observation Patient Accommodation Profile records that the patient needs staff assistance with pushing a wheelchair during clinical encounters.

Wheelchair Assistance Accommodation Simple Observation Example

This example of a US Core Simple Observation Profile records that the patient needs staff assistance with pushing a wheelchair during clinical encounters.

Patient Examples

Examples for testing the USCDI V7 Patient examples

Patient With ASL Interpreter Accommodation Example

This example of a US Core Patient Profile illustrates the use of the US Core Accommodation Extension to record that the patient requires an American Sign Language (ASL) interpreter at the point of care.

Patient With Healthcare Agent Contact Example

This example of a US Core Patient Profile illustrates the use of Patient.contact to record the patient's Healthcare Agent - the related person legally authorized to make healthcare decisions on behalf of the patient if the patient cannot do so.

Patient With Primary And First Alternate Healthcare Agents Example

This example of a US Core Patient Profile illustrates the use of repeating Patient.contact elements to record both a primary Healthcare Agent and a first alternate Healthcare Agent for the patient.

Patient With Service Animal Accommodation Example

This example of a US Core Patient Profile illustrates the use of the US Core Accommodation Extension to record that the patient's service animal must be permitted to accompany the patient within the facility.

Patient With Wheelchair Assistance Accommodation Example

This example of a US Core Patient Profile illustrates the use of the US Core Accommodation Extension to record that the patient needs staff assistance with pushing a wheelchair during clinical encounters.

Questionnaire Examples

Examples for testing the USCDI V7 Questionnaire examples

Tobacco Use Panel Questionnaire Example

LOINC 88028-6 Tobacco use panel rendered as a structured FHIR Questionnaire. Generated using the NIH SDC LHC-Forms application at <https://lhcforms.nlm.nih.gov/lforms-fhir-app/>. The paired QuestionnaireResponse captures the source data used to derive the US Core Tobacco Use panel Observation.

QuestionnaireResponse Examples

Examples for testing the USCDI V7 QuestionnaireResponse examples

Tobacco Use Panel QuestionnaireResponse Example

Captured answers for the paired LOINC 88028-6 Tobacco use panel Questionnaire. Generated using the NIH SDC LHC-Forms application at <https://lhcforms.nlm.nih.gov/lforms-fhir-app/> and used as the source data for the US Core Tobacco Use panel Observation.

RelatedPerson Examples

Examples for testing the USCDI V7 RelatedPerson examples

Related Person Niece As Durable Power of Attorney

This example of a US Core RelatedPerson Profile records the patient's niece in the Durable Power of Attorney role.

Related Person Niece As Healthcare Power Of Attorney Example

This example of a US Core RelatedPerson Profile records the patient's niece in the legally authorized Healthcare Power of Attorney role.

ServiceRequest Examples

Examples for testing the USCDI V7 ServiceRequest examples

ServiceRequest Podiatrist Referral Example

This example of a US Core ServiceRequest Profile illustrates a referral order to a podiatrist for a patient with diabetic foot care needs.

ServiceRequest Wound Care Referral Example

This example of a US Core ServiceRequest Profile illustrates a referral order to a wound care specialist for a patient with a non-healing chronic wound.

Specimen Examples

Examples for testing the USCDI V7 Specimen examples

Bone Marrow Aspirate Specimen Example

This example of a US Core Specimen Profile illustrates a bone marrow specimen obtained by aspiration.

Lipemic Serum Specimen Venipuncture Example

This example of a US Core Specimen Profile illustrates a lipemic serum specimen obtained by venipuncture and demonstrates the USCDI requirements for both specimen collection method and specimen condition.

Serum Specimen Example

This example of a US Core Specimen Profile illustrates a serum specimen obtained by venipuncture.

Serum Specimen Venipuncture Example

This example of a US Core Specimen Profile illustrates a serum specimen obtained by venipuncture.

Throat Swab Specimen Example

This example of a US Core Specimen Profile illustrates a throat swab specimen obtained by swab collection.

Tissue Biopsy Specimen Example

This example of a US Core Specimen Profile illustrates a tissue specimen obtained by biopsy.

Urine Specimen Catheterized Collection Example

This example of a US Core Specimen Profile illustrates a urine specimen obtained by catheterized collection.

Whole Blood Specimen Venipuncture Example

This example of a US Core Specimen Profile illustrates a whole blood specimen obtained by venipuncture.

Structures: Resource Profiles

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

US Core AdverseEvent Profile

The US Core AdverseEvent Profile inherits from the FHIR AdverseEvent resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Adverse Events Data Class and its Adverse Event and Adverse Event Outcome Data Elements. It sets minimum expectations for the AdverseEvent resource to record, search, and fetch information about a change to patient condition that could be an unintended effect of clinical interventions. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

US Core AllergyIntolerance Profile

The US Core AllergyIntolerance Profile inherits from the FHIR AllergyIntolerance resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Allergies and Intolerances Data Class and its Allergy Intolerance Criticality Data Element. It sets minimum expectations for the AllergyIntolerance resource to record, search, and fetch allergies and adverse reactions associated with a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

US Core Appointment Profile

The US Core Appointment Profile inherits from the FHIR Appointment resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Appointment Data Element of the Encounter Information Data Class. It sets minimum expectations for the Appointment resource to record, search, and fetch information about a healthcare event scheduled for a past, current, or future date and time. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

US Core Condition Encounter Diagnosis Profile

The US Core Condition Encounter Diagnosis Profile inherits from the FHIR Condition resource; refer to it for scope and usage definitions. US Core version 5.0.0 split the US Core Condition Profile into this profile and the US Core Condition Problems and Health Concerns Profile. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Encounter Diagnosis Data Element. It sets minimum expectations for the Condition resource to record, search, and fetch information about an encounter diagnosis. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

US Core DeviceRequest Profile

The US Core DeviceRequest Profile inherits from the FHIR DeviceRequest resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Medical Device Order Data Element of the Orders Data Class. It sets minimum expectations for the DeviceRequest resource to record, search, and fetch orders for medical devices for a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

US Core Flag Profile

The US Core Flag Profile inherits from the FHIR Flag resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Flag resource to record, search, and fetch a patient's reasonable accommodations and other patient-related alerts. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource when using this profile, and constrains the way those elements are used.

US Core ImagingStudy Profile

The US Core ImagingStudy Profile inherits from the FHIR ImagingStudy resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Diagnostic Imaging Data Class and its Diagnostic Imaging Reference Data Element. It sets minimum expectations for the ImagingStudy resource to record, search, and fetch the identifiers, endpoints, and contextual information needed to access a diagnostic imaging study. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

US Core MedicationAdministration Profile

The US Core MedicationAdministration Profile inherits from the FHIR MedicationAdministration resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Medication Administration Data Element of the Medications Data Class. It sets minimum expectations for the MedicationAdministration resource to record, search, and fetch information about medications administered to a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

US Core Nutrition Order Profile

The US Core Nutrition Order Profile inherits from the FHIR NutritionOrder resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Nutrition Order Data Element of the Orders Data Class. It sets minimum expectations for the NutriotionOrder resource to record, search, and fetch nutritional orders for a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

US Core Observation Patient Accommodation Profile

The US Core Observation Patient Accommodation Profile inherits from the FHIR Observation resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Accommodation Data Element of the Patient Demographics/Information Data Class. It sets minimum expectations for the Observation resource to record, search, and fetch information about modifications, tools, technologies, and other supports necessary to enable a patient to access care. Examples include, but are not limited to, sign language interpreters, wheelchair accessibility requirements, and sensory accommodation. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

US Core Patient Profile

The US Core Patient Profile inherits from the FHIR Patient resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Patient Demographics/Information Data Class. It sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

US Core Specimen Profile

The US Core Specimen Profile inherits from the FHIR Specimen resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Specimen resource to record, search, and fetch information about substances associated with a patient being sampled or tested (such as nasopharyngeal swab, whole blood, or serum). It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Structures: Extension Definitions

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

US Core Accommodation Extension

This extension records modifications, tools, technologies, and other supports necessary to enable a patient or other individual to access care, captured as a free-text annotation. Examples include sign language interpreters, wheelchair accessibility requirements, and sensory accommodation.

Terminology: Value Sets

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

US Core Patient Contact Relationship

Codes that represent the relationship of a person identified as a contact for a patient, including roles supporting the USCDI v7 Healthcare Agent Data Element. Combines the FHIR PatientContactRelationship value set with selected HL7, SNOMED CT, and LOINC codes covering healthcare power-of-attorney and primary / alternate healthcare agent designations.

US Core Specimen Collection Method
This value set identifies the technique used to collect a specimen. It includes the SNOMED CT 17636008 Specimen collection (procedure) hierarchy together with additional SNOMED CT concepts that represent procedures producing a specimen but are classified outside that hierarchy.

Example: Example Instances

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

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.

Tobacco Multiselect-Item Example 81228-9-Answer0

This is a Tobacco Multiselect-Item Example 81228-9-Answer0 (Tobacco product) for the US Core Observation Screening Assessment Profile

Tobacco Multiselect-Item Example 81228-9-Answer1

This is a Tobacco Multiselect-Item Example 81228-9-Answer1 (Tobacco product) for the US Core Observation Screening Assessment Profile

Wound Simple Observation Example

This example of a US Core Simple Observation Profile records a wound finding that supports the patient's encounter diagnosis of a burn of the ear.

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

exp-params