This wiki has undergone a migration to Confluence found Here

Goals

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:  http://fhir.org/guides/argonaut
The working CI build is avaible now at : 
http://build.fhir.org/ig/Healthedata1/Argo-DSTU2/  

Introduction

The Argonaut Goals IG provides the API documentation for searching for and fetching patient goals using the Goal resource. The search supports the 2015 Edition ONC Certification criterion Data Category Request 170.315(g)(8).

Minimum Requirements

Clients

Servers

  • A server is capable of returning all of a patient's goals using GET [base]/Goal?patient=[id].
  • A server is capable of returning all of all of a patient's goals over a specified time period using GET [base]/Goal?patient=[id]&date=[date]{&date=[date]}.
  • 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 Goal must have:

  1. a patient
  2. a text description of the goal
  3. a status

Formal Summary of the Mandatory Requirements

  1. A patient reference in Goal.patient
  2. A description in Goal.description
  3. A status in Goal.status
    • Goal.status is bound to GoalStatus Value set (Code set)
Goal Resource Example

Quick Start

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


GET /Goal?patient=[id]

Support: Mandatory to support search by patient.

Implementation Notes: Search for all goals for a patient. Fetches a bundle of all Goal 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/Goal?patient=1137192]


GET /Goal?patient=[id]&date=[date]{&date=[date]}

Support: Mandatory to support search by date

Implementation Notes: Search for all goals for a patient within a time period. Fetches a bundle of all Goal resources for the specified patient with a specified time period. (how to search by reference) and (how to search by date).

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/Goal?patient=1137192&date=ge2015-01-14]
[GET https://fhir-open-api-dstu2.smarthealthit.org/Goal?patient=1137192&date=ge2015-01-14&date=le2016-01-14]


Open Issues

Issues for this IG have been identified and tracked HERE

TODO add examples

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