STU 2 Ballot

This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions

D.0 U.S. Data Access Framework (DAF) FHIR Implementation Guide (IG)

This implementation guide is prepared as a U.S. Realm Specification on behalf of the U.S. Office of the National Coordinator (ONC) .

D.0.1 Draft Standard for Trial Use (DSTU)

This DAF FHIR IG is submitted as a DSTU. The focus of the implementation guide is limited in scope to the profiles, operations, value sets and conformance statements it defines. This guide is based on FHIR DSTU 2 and will be published separately from the FHIR specification itself. For full details of the DAF profiles please refer to DAF FHIR IG Table of Contents. For DAF background readers can also access the DAF Project wiki containing development materials and discussions. The DAF project wiki contents are not part of the normative implementation guide content but is provided as additional background reading material.

D.0.2 DAF FHIR IG - Table Of Contents

Readers are advised to read the sections below to get a good overview of the DAF context, however readers trying to access the DAF profiles can skip to the Complete Table of Contents directly.

D.0.3 DAF FHIR IG Overview and Conformance Requirements

The DAF FHIR IG contains four sections:

  • Definitions, Interpretations and Requirements common to all DAF actors
  • Conformance Requirements for each DAF actor
  • DAF profiles, extensions and constraints
  • Security Implementation Guidance

D.0.3.1 Definitions, Interpretations and Requirements common to all DAF actors

This section outlines important definitions used in the DAF FHIR IG including interpretations that need to be used in the context of DAF and conformance requirements common to all DAF actors. The conformance verbs used are defined in FHIR Conformance Rules.

In the context of DAF profiles, Supported on any data element SHALL be interpreted as follows:

  • DAF Responders SHALL be capable of including the data element as part of the query results as specified by the DAF conformance resources.
  • DAF Requestors SHALL be capable of processing resource instances containing the data elements. In other words DAF Requestors SHOULD be capable of displaying the data elements for human use or storing it for other purposes.
  • In situations where information on a particular data element is not present and the reason for absence is unknown, DAF Responders SHALL NOT include the data elements in the resource instance returned as part of the query results.
  • When querying DAF Responders, DAF Requestors SHALL interpret missing data elements within resource instances as data not present in the DAF Responder's systems.
  • In situations where information on a particular data element is missing and the DAF Responder knows the precise reason for the absence of data, DAF Responders SHALL send the reason for the missing information using values from the value set where they exist or using the dataAbsentReason extension.
  • DAF Requestors SHALL be able to process resource instances containing data elements asserting missing information.
  • NOTE: DAF Responders who do not have the capability to store or return a data element tagged as Supported in DAF profiles can still claim conformance to the DAF profiles using the DAF conformance resources.
  • NOTE: The above definition of Supported is derived from HL7v2 concept "Required by may be empty - RE" described in HL7v2 V28_CH02B_Conformance.doc.

Value Set bindings and interpretation: In the context of DAF profiles, value set bindings (required, extensible) for specific data elements follow FHIR terminology requirements.

FHIR Infrastructure usage: DAF uses FHIR RESTful API based on HTTP protocol along with FHIR data types, FHIR search and both xml and json FHIR Resource Formats.

Search Guidance: DAF profiles support the searching (querying) of resources such as Medications, Encounters, Problems, AllergyIntolerances, and Procedures for a particular patient. In order to achieve this in implementation, DAF actors SHOULD use Patient.identifier field to precisely identify the resources relevant to the patient. While other search parameters such as Patient.name, Patient.given could be used as part of the query, incorrect Patient matching could lead to incorrect results.

Patient Matching Guidance: Patient Matching rules and related criteria have to be evaluated by the organization implementing DAF actors to ensure compliance with local policies and regulations. The DAF FHIR IG does not require specific algorithms to be used as part of the implementation.

D.0.3.2 Conformance Requirements for each DAF actor

This section outlines conformance requirements for each of the DAF 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 DAF 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 DAF actors.

  • Conformance requirements for DAF Requestor actor, which is responsible for creating and initiating the queries for information about an individual patient or a set of patients.
  • Conformance requirements for DAF Responder actor, which is responsible for providing responses to the queries submitted by the DAF Requestors.
  • (DRAFT) Conformance requirements for DAF Responder actor core, which are the core requirements for for providing responses to the queries submitted by the DAF Requestor for basic provider and patient access.

D.0.3.3 DAF profiles, extensions and constraints

This section outlines the DAF profiles created using FHIR resources and include both extensions and constraints on top of the base FHIR Resources. DAF profiles were created for each conceptual data element identified in the ONC 2014 Edition Standards and Certification Criteria (S&CC) related to Meaningful Use Stage 2 (MU2) . The table below provides a top-level mapping of the ONC 2014 edition S&CC conceptual data elements to the corresponding DAF Resource profile along with the identification of the base FHIR resource. In addition, within each profile, granular data elements are listed in the "Meaningful Use Data Element Mapping" section of each DAF profile description. While many of these granular data elements were not explicitly mentioned in ONC or CMS Meaningful Use regulations, they are derived from the ONC 2014 Edition S&CC, which references other HL7 standards such as C-CDA, and HL7 v2.5.1 implementation guides for lab reporting and immunizations. These standards identify granular data elements to represent the MU2 conceptual data elements and hence are identified in the individual DAF profiles. For example, MU2 simply says "Medication Allergies" are required. On review of C-CDA an implementer would find that the Allergy Substance, Reaction, etc. are part of what comprises a Medication Allergy along with specific constraints on what is required and optional. In addition to deriving the granular data elements from the MU2 conceptual data elements and referenced standards, the DAF community further refined these data elements as DAF priority data elements in the individual profiles. For sake of brevity the DAF profiles are referred to as DAF-Resource name.

Meaningful Use conceptual data element DAF profile FHIR Resource
Medication allergies DAF-AllergyIntolerance AllergyIntolerance
Laboratory Order(s) DAF-DiagnosticRequest DiagnosticRequest
Laboratory Test(s) DAF-DiagnosticReport DiagnosticReport
Encounter Diagnoses DAF-Encounter Encounter
Family Health History DAF-FamilyMemberHistory FamilyMemberHistory
Immunizations DAF-Immunization Immunization
Laboratory Result Value(s) DAF-Results Observation
Medications DAF profiles for medications, DAF-Medication, DAF-MedicationStatement, DAF-MedicationAdministration, DAF-MedicationDispense, DAF-MedicationOrder Medication, MedicationStatement, MedicationAdministration, MedicationDispense, MedicationOrder
Patient name, Sex, Date of Birth, Race, Ethnicity, Preferred Language DAF-Patient Patient
Problems DAF-Condition (Problem) Condition
Procedures DAF-Procedure Procedure
Smoking status DAF-SmokingStatus Observation
Vital Signs (Height, weight, BP, BMI) DAF-VitalSigns Observation
MedicationAllergies list, Problem list, Medication List, Immunizations, Encounters, Laboratory Result Values, Procedure List DAF List (DAF-AllergyList, DAF-ProblemList, DAF-MedicationList, DAF-ImmunizationList, DAF-EncounterList, DAF-ResultsList, DAF-ProcedureList) List
DAF Supporting Profiles:DAF-Organization, DAF-Location, DAF-Practitioner, DAF-Substance,DAF-RelatedPerson,DAF-Specimen Organization, Location, Practitioner, Substance, RelatedPerson,Specimen

D.0.3.4 DAF FHIR IG Security Implementation Guidance

Implementations must meet the security requirements documented in the security section of the DAF FHIR IG.

D.0.4 Author Information

Author Name
Brett Marquard (Primary)
Nagesh Bashyam (Primary)
Grahame Grieve (Supporting)
Lloyd McKenzie (Supporting)