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


The Argonaut CareTeam IG provides the API documentation for searching for and fetching a patient's current care team list using the CarePlan resource. 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). Note: A CareTeam resource is being developed for a future version of FHIR. However since the scope of this IG is FHIR DSTU2 we will limit the use to that version.

Usage Overview


  • A client is able to connect to a server and fetch all current care team members for a patient using GET[base]/CarePlan?Patient=[id]&category=careteam


  • 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. a patient
  2. a status

Each CarePlan should have:

  1. a participant role if participant is present
  2. either a complete name or a reference to participant
    • Note the participant can be
      • a practitioner (doctor, nurse, therapist)
      • the patient
      • a relative or friend or guardian
      • an organization
CarePlan Resource Example

Quick Start

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

GET/CarePlan?Patient/[id]&status=current$_include=CarePlan:participant.member[choice of Practitioner | RelatedPerson | Patient | Organization]

Support: Mandatory to support search by patient.

Implementation Notes: Search for all current care team members for a patient. Fetches a bundle of all current CarePlan resource(s) and the participants referenced by the CarePlan resource(s) for the specified patient (how to search by reference) (how to search by token) (how to include referenced resources in search result).

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