This wiki has undergone a migration to Confluence found Here


From HL7 Argonaut Project Wiki
Jump to navigation Jump to search

Back to Argonaut Implementation Guide

**********************PLEASE NOTE********************************
This guide is no longer being actively maintained and updated.
On January 1st 2017, This guide is being superseded by the online 
version of the Argonaut-DSTU2 Implemenation Guide.
hosted at:
The working CI build is avaible now at :  


The Argonaut Immunizations IG provides the API documentation for searching for and fetching a patient's immunization history. It is based on the Data Access Framework (DAF) Immunization Profile, DAF ImmunizationOrder Profile. The search criteria provided in the Quick Start are intended to support the 2015 Edition ONC Certification criterion Data Category Request 170.315(g)(8).

Minimum Requirements



  • A server is capable of returning a all immunizations for a patient using GET /Immunization?patient=[id].
  • A server has ensured that every API request includes a valid Authorization token, supplied via:Authorization: Bearer {server-specific-token-here}
  • A server has rejected any unauthorized requests by returning an HTTP 401 Unauthorized response code.

Mandatory Data Elements

The following data-elements are mandatory (i.e data MUST be present). These are presented below in simple human-readable explanations along with sample data to demonstrate the requirements.

Each Immunization must have:

  1. a status
  2. a date the vaccine was administered
  3. a vaccine code that identifies the kind of vaccine administered
  4. a patient
  5. a flag to indicate whether vaccine was given
  6. a flag to indicate whether the vaccine was reported by patient rather than directly administered.

Formal Summary of the Mandatory Requirements

  1. One status in Immunization.status which is bound to the Argonaut Immunization Status Valueset
  1. One dateTime in
  2. One vaccine code in Immunization.vaccineCode which is bound to the CVX code set
  3. One patient in Immunization.patient
  4. One boolean value in Immunization.wasNotGiven
  5. One boolean value in Immunization.reported

Additional elements from DAF Immunization Profile may be present.

NDC codes as a translational data element

Based upon the 2015 Edition Certification Requirements, the NDC vaccine codes SHOULD be supported as translations to the CVX vaccine codes. A NDC to CVX concept map is provided and the translation is illustrated in the example below.

Immunization Example

Quick Start

Below is a quick overview of the required search and read operations.

GET /Immunization?patient={id}

Support: Mandatory to support search by patient.

Implementation Notes: Search for all Immunization resources for a patient. Fetches a bundle of all Immunization resources for the specified patient (how to search by reference).

Response Class:

  • (Status 200): successful operation
  • (Status 400): invalid parameter
  • (Status 401/4xx): unauthorized request
  • (Status 403): insufficient scope



Open Issues

Issues for this IG have been identified and tracked HERE

  • todo update the system in the search results, valueset expansion for CVX not working in DSTU2 build consider a "local expansion" on the wiki or referencing CDC or VSAC.


Formalized testing with test scripts and objective results reporting is available through the participation of AEGIS and MITRE (Crucible). The testscript provided can be used to test servers: [todo]


Back to Argonaut Implementation Guide