This wiki has undergone a migration to Confluence found Here

Difference between revisions of "Medications"

From HL7 Argonaut Project Wiki
Jump to navigation Jump to search
(Created page with "Back to Argonaut Implementation Guide ==Introduction== The Argonaut Medications IG provides the API documentation for searching for and fetching a pat...")
 
Line 46: Line 46:
 
----
 
----
  
===GET /Condition?patient=[id]===
+
===GET /MedicationStatement?patient={id}===
 
''Support:'' Mandatory to support search by patient.
 
''Support:'' Mandatory to support search by patient.
  
''Implementation Notes:'' Search for all conditions (a.k.a. problems) for a patient. Fetches a bundle of all Condition resources for the specified patient [http://hl7.org/fhir/DSTU2/search.html#reference (how to search by reference)].
+
''Implementation Notes:'' Search for all MedicationStatement resources for a patient. Fetches a bundle of all MedicationStatement resources for the specified patient [http://hl7.org/fhir/DSTU2/search.html#reference (how to search by reference)].
  
 
''Response Class:''
 
''Response Class:''
Line 57: Line 57:
 
*(Status 403): insufficient scope
 
*(Status 403): insufficient scope
 
====Example:====  
 
====Example:====  
  [GET https://fhir-open-api-dstu2.smarthealthit.org/Condition?patient=1137192]
+
  [GET http://fhirtest.uhn.ca/baseDstu2/MedicationStatement?patient=14676]
 
----
 
----
<!--
 
===GET /AllergyIntolerance?patient=[id]&status:below=active===
 
''Support:'' Mandatory to support search by reference.
 
  
''Implementation Notes:'' Fetches a bundle of all active (including confirmed and unconfirmed) AllergyIntolerance resources for the specified patient [http://hl7.org/fhir/DSTU2/search.html#reference (how to search by reference)] [http://hl7.org/fhir/DSTU2/search.html#token (how to search by token)].
+
===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 [http://hl7.org/fhir/DSTU2/search.html#reference (how to search by reference)].
  
 
''Response Class:''
 
''Response Class:''
Line 71: Line 71:
 
*(Status 403): insufficient scope
 
*(Status 403): insufficient scope
 
====Example:====  
 
====Example:====  
  20160315 EH; note this does not work need to use GGs server [GET https://fhir-open-api-dstu2.smarthealthit.org/AllergyIntolerance?patient=1137192&status:below=active]
+
  [GET https://fhir-open-api-dstu2.smarthealthit.org/MedicationOrder?patient=1137192]
 
----
 
----
-->
 
  
 
==Open Issues==
 
==Open Issues==

Revision as of 13:18, 12 April 2016

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 allergies list using GET /Condition?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 Condition must have:

  1. One Identification of the condition, problem or diagnosis in Condition.code.
  2. One patient reference in Condition.patient
  3. One clinical status in Condition.clnicalStatus

Additional elements from http://hl7.org/fhir/daf/medicationstatement-daf.html DAF MedicationStatement Profile] or DAF MedicationOrder Profile] may be present.

Condition Resource 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

The following issues have been identified:

  • 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