From HL7 Argonaut Project Wiki
Revision as of 06:53, 15 April 2016 by Eric Haas (talk | contribs) (Created page with "Back to Argonaut Implementation Guide ==Introduction== The Argonaut CareTeam provides the API documentation for searching for and fetching a patient's...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Back to Argonaut Implementation Guide


The Argonaut CareTeam provides the API documentation for searching for and fetching a patient's care team list. 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 current care team list using GET /CarePlan?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 CarePlan must have:

  1. One Identification of the condition, care team or diagnosis in CarePlan.code.
  2. One patient reference in CarePlan.patient
  3. One clinical status in CarePlan.clonicalStatus

Additional elements from DAF CarePlan Profile may be present.

CarePlan Resource Example

Quick Start

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

GET /CarePlan?patient=[id]

Support: Mandatory to support search by patient.

Implementation Notes: Search for all conditions (a.k.a. care teams) for a patient. Fetches a bundle of all CarePlan 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 the vitals 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