STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

D.9.0 U.S. Data Access Framework (DAF) Immunization Profile

D.9.0.1 Scope and Usage

This profile sets expectations for use of the Immunization resource to record immunization events associated with a patient within the DAF FHIR IG. This profile identifies which core elements, extensions, vocabularies and value sets must be Supported by DAF actors. For the definition of Supported please refer to DAF FHIR IG. The data elements identified by the profile are based on ONC 2014 Edition S&CC and DAF use cases. The mappings between the ONC 2014 Edition S&CC data elements and DAF data elements are captured in the table below, where the first column identifies the ONC 2014 Edition S&CC data element name, the second column maps the ONC 2014 Edition S&CC data elements to DAF data elements which are derived from ONC 2014 Edition S&CC standards and DAF use cases and lastly the third column identifies the mapping to FHIR resources and attributes.

D.9.0.2 Meaningful Use Data Element Mapping

The DAF-Immunization profile mapping to Meaningful Use data elements and FHIR Resources are as shown below.For an overview of how the DAF profiles and data elements were derived from ONC 2014 Edition S&CC please refer to DAF FHIR IG data mapping section.


Meaningful Use Data Element Name Mapping to Priority DAF Data Elements FHIR Resource Mapping
Immunizations
Immunization Vaccine Immunization.vaccineType
Vaccination Date Immunization.date
Vaccine Manufacturer Immunization.manufacturer
Vaccine Lot Number Immunization.lotNumber
Immunization Administered by Provider Immunization.performer
Vaccine Expiration Date Immunization.expirationDate
Vaccination Dosage Administered Immunization.doseQuantity
Vaccination Body Site Immunization.site
Vaccination Ordering Provider Immunization.requester
Vaccination Reaction Immunization.reaction.symptom.code
Vaccination Refused Immunization.refusedIndicator
Vaccination Refusal Reason Immunization.explanation.refusalReason

D.9.0.3 Boundaries and Relationships

This profile relies on the following other profiles:

  • DAF-Patient is used by DAF-Immunization profile to refer to patients.
  • FHIR Extensibility defines how extensions can be applied to FHIR resources and data types. Specifically the data-absent-reason extension can be used to code data elements with missing information when appropriate. See DAF FHIR IG for additional guidance.

D.9.0.4 Content

Profiles:
DAF-ImmunizationDefines constraints and extensions on the Immunization resource for use in querying and retrieving patient's immunization information.

D.9.0.4.1 Search Parameters

The full list of supported search parameters are can be accessed at DAF Requestor conformance expectations and DAF Responder conformance expectations.

D.9.0.4.2 Example Usage Scenarios

The following are example usage scenarios for the DAF-Immunization profile:

  • Query for immunizations belonging to a Patient
  • Query for all patients who have had a specific vaccine administered
  • Query for immunizations administered based on lot number

D.9.0.4.3 Profile specific implementation guidance

Implementers need to be mindful of the following during their implementation

    Representing Immunization not given: No immunization given can be represented with DAF-Immunization profile profile with appropriate code in immunization.explanation.reasonNotGiven.

    See DAF FHIR IG for implementation guidance common to all profiles.