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 Allergy provides the API documentation for searching for and fetching patient allergies. It is based on the Data Access Framework (DAF) AllergyIntolerance Profile and draws requirements from Argonaut Sprint 5. 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).

Argonaut Success Criteria



  • A server is capable of returning a patient's allergies list using GET /AllergyIntolerance?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 explanation and a more thorough formal summary of the requirements. Sample data is provided to demonstrate the requirements.

Each AllergyIntolerance must have:

  1. a patient
  2. a code which tells you what the patient is allergic to
  3. a status of the allergy

Formal Summary of the Mandatory Requirements

  1. One Identification of a substance, or a class of substances, that is considered to be responsible for the adverse reaction risk in AllergyIntolerance.substance
    • AllergyIntolerance.substance with an extensible binding to a Value set (Code set) consisting of:
      • NDF-RT codes for drug class allergies
      • RxNorm codes limited to term types (TTY) , 'BN' Brand Name, 'IN' ingredient, 'MIN' multiple ingredient, and 'PIN' precise ingredient for drug ingredient allergies
      • SNOMED CT if no other code from above code systems are available.
  2. One patient reference in AllergyIntolerance.patient
  3. One status in AllergyIntolerance.status

Additional elements from DAF AllergyIntolerance Profile may be present.

AllergyIntolerance Resource Example

Quick Start

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

GET /AllergyIntolerance?patient=[id]

Support: Mandatory to support search by patient.

Implementation Notes: Search for all allergies for a patient. Fetches a bundle of all AllergyIntolerance 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


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