This wiki has undergone a migration to Confluence found Here

Medications

From HL7 Argonaut Project Wiki
Jump to navigation Jump to search

Back to Argonaut Implementation Guide

Introduction

The Argonaut Medications IG provides the API documentation for searching for and fetching a patient's medications. It is based on the Data Access Framework (DAF) MedicationStatement Profile, DAF MedicationOrder Profile, and draws requirements from Argonaut Sprint 4. 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

Clients

Servers

  • A server is capable of returning a patient's medications GET /MedicationStatement?patient=[id].
  • A server is capable of returning a patient's medication orders GET /MedicationOrder?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 MedicationStatment must have:

  1. a patient
  2. a status
  3. a date or date range
  4. a medication

Formal Summary of the Mandatory Requirements

  1. One patient reference in MedicationStatement.patient
  2. One status in MedicationStatement.status
  3. One date or period in MedicationStatement.effectiveDateTime or MedicationStatment.effectivePeriod
  4. One medication in medicationCodeableConcept vs medicationReference?.
MedicationStatement Example

Each MedicationOrder must have:

  1. a date for when written
  2. a status
  3. a patient
  4. a prescriber
  5. a medication

Formal Summary of the Mandatory Requirements

  1. One date in MedicationOrder.dateWritten
  2. One status in MedicationOrder.status
  3. One patient reference in MedicationOrder.patient
  4. One practitioner in MedicationOrder.prescriber
  5. One medication in medicationCodeableConcept vs medicationReference?.

Additional elements from DAF MedicationStatement Profile or DAF MedicationOrder Profile may be present.

MedicationOrder Example

Quick Start

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


GET /MedicationStatement?patient={id}

Support: Mandatory to support search by patient.

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

Example:

[GET http://fhirtest.uhn.ca/baseDstu2/MedicationStatement?patient=14676]

GET /MedicationOrder?patient={id}

Support: Mandatory to support search by patient.

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

Example:

[GET https://fhir-open-api-dstu2.smarthealthit.org/MedicationOrder?patient=1137192]

Open Issues

Issues for this IG have been identified and tracked HERE

  • Status based search

Resources

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]

References


Back to Argonaut Implementation Guide