US-Core CI Build

This page is part of the US Core (v0.0.0: STU1 Ballot 1) based on FHIR v1.8.0. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

US Core Implementation Guide

Introduction

The data elements, extension, and terminology used in the US Core Implemenation Guide are based upon ONC 2015 Edition Common Clinical Data Set (CCDS) as well as essential administrative and conformance requirements. These requirements were originally developed, balloted, and published in FHIR DSTU2 as part of the ONC sponsored Data Access Framework (DAF) project and were subsequently updated to define the minimum mandatory conformance requirements needed for accessing patient data as defined by the Argonaut pilot implementations. In addition to Argonaut, these profiles are used by the [DAF-Research], QI-Core, and CIMI and are intended to be a common core for other US Realm guides.

US Core Actors

The following actors are part of the US Core IG.

  • US Core Requestor: An application that initiates a data access request to retrieve patient data. This can be thought of as the client in a client-server interaction.
  • US Core Responder: A product that responds to the data access request providing patient data. This can be thought of as the server in a client-server interaction.

US Core Profiles

The US Core Profiles are intended to meet the 2015 Edition certification criterion for Patient Selection 170.315(g)(7) and Application Access – Data Category Request 170.315(g)(8). They were created for each of the 2015 Edition Common Clinical Data Set. The Location, Organization and Practitioner Profiles are not called out specifically in the certification criteria but are included because they are directly referenced by other profiles. Where applicable the US Core Profiles are based on the HL7 U.S. Data Access Framework ([DAF]) FHIR DSTU2 Implementation Guide. However, the requirements per resource are a subset of those of the DAF implementation guide.

The table below lists the FHIR Resources used for the corresponding 2015 Edition Common Clinical Data Set (CCDS) Data elements:

No CCDS Data Element FHR Resource
(1) Patient Name Patient
(2) Sex Patient
(3) Date of birth Patient
(4) Race Patient
(5) Ethnicity Patient
(6) Preferred language Patient
(7) Smoking status Observation
(8) Problems Condition
(9) Medications Medication, MedicationStatement, MedicationRequest
(10) Medication allergies AllergyIntolerance
(11) Laboratory test(s) Observation, DiagnosticReport
(12) Laboratory value(s)/result(s) Observation, DiagnosticReport
(13) Vital signs Observation
(14) (no longer required) -
(15) Procedures Procedure
(16) Care team member(s) CareTeam
(17) Immunizations Immunization
(18) Unique device identifier(s) for a patient’s implantable device(s) Device
(19) Assessment and plan of treatment CarePlan
(20) Goals Goal
(21) Health concerns Condition

Note on Searches based on a date or date range:

Allergies, Immunizations, Medications, Problems and Health Concerns, UDI, Smoking Status do not require a date range search since a system should return all relevant resources.

Date range search requirements are included in the Quick Start section for the following resources - Vital Signs, Laboratory Results, Goals, Procedures, and Assessment and Plan of Treatment.

The list of US Core Profiles is shown below. Each profile defines the minimum mandatory elements, extensions and terminology requirements that MUST be present. For each profile requirements and guidance are given in a simple narrative summary. A formal hierarchical table that presents a logical view of the content in both a differential and snapshot view is also provided along with references to appropriate terminologies and examples.

  • US Core Allergies Profile US Core Allergies Profile
  • US Core CarePlan Profile US Core CarePlan Profile
  • US Core CareTeam Profile US Core CareTeam Profile
  • US Core Condition Profile US Core Condition Profile
  • US Core Implanted Device Profile US Core Implanted Device Profile
  • US Core Diagnostic Report Profile US Core Diagnostic Report Profile
  • US Core Goal Profile US Core Goal Profile
  • US Core Immunization Profile US Core Immunization Profile
  • US Core Location Profile US Core Location Profile
  • US Core Medication Profile US Core Medication Profile
  • US Core Medication Request Profile US Core Medication Request Profile
  • US Core Medication Statement Profile US Core Medication Statement Profile
  • US Core Result Observation US Core Result Observation
  • US Core Smoking Status Observation Profile US Core Smoking Status Observation Profile
  • US Core Vital Signs Profile US Core Vital Signs Profile
  • US Core Organization Profile US Core Organization Profile
  • US Core Patient Profile US Core Patient Profile
  • US Core Practitioner US Core Practitioner
  • US Core Procedure Profile US Core Procedure Profile
  • US-Core Conformance Requirements

    This section outlines conformance requirements for each of the US-Core actors identifying the specific profiles that need to be supported, the specific RESTful operations that need to be supported, and the search parameters that need to be supported. Note: The individual US-Core profiles identify the structural constraints, terminology bindings and invariants, however, implementers must refer to the conformance requirements for details on the RESTful operations, specific profiles and the search parameters applicable to each of the US-Core actors.

    • Conformance requirements for the US-Core Client (Requestor Actor) which is responsible for creating and initiating the queries for information about an individual patient.
    • Conformance requirements for the US-Core Server (Responder Actor) which is responsible for providing responses to the queries submitted by the US-Core Requestors. 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).

    Primary Authors: Brett Marquard, Nagesh Bashyam, Eric Haas

    Secondary Authors: Grahame Grieve, Lloyd McKenzie