Assessment and Plan of Treatment

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 Assessment and Plan of Treatment IG provides the API documentation for searching for and fetching patient assessment and plan of treatment data using the CarePlan resource. The search supports the narrative elements of the Assessment and Plan Section which is the minimal necessary criteria to support the 2015 Edition ONC Certification criterion Data Category Request 170.315(g)(8).

Argonaut Success Criteria

Clients


Servers



  • 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 CarePlan must have:

  1. a patient
  2. a category code of "assess-plan"
  3. a status
  4. a narrative summary of the patient assessment and plan of treatment

Formal Summary of the Mandatory Requirements

  1. A narrative summary in CarePlan.text
  2. One reference to a patient in CarePlan.subject
  3. One category in Careplan.category which must have:
  4. One status in CarePlan.status
CarePlan Resource Example

Quick Start

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


GET /CarePlan?patient=[id]&category=assess-plan

Support: Mandatory to support search by patient.

Implementation Notes: Search for all patient assessments and plans of treatment for a patient. Fetches a bundle of all CarePlan resources for the specified patient (how to search by reference) and (how to search by token).

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/CarePlan?patient=1137192&category=assess-plan]

GET /CarePlan?patient=[id]&category=assess-plan&status=active

Support: SHOULD support search by reference and status.

Implementation Notes: Search for all active allergies for a patient. Fetches a bundle of all active (status = 'active') CarePlan resources for the specified patient (how to search by reference) (how to search by token) and Composite Search Parameters.

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/CarePlan?patient=1137192&status=active]

GET /CarePlan?patient=[id]&category=assess-plan&date=[date]{&date=[date]}

Support: Mandatory to support search by date

Implementation Notes: Search for all assessment and plan of treatment for a patient within a time period. Fetches a bundle of all CarePlan resources for the specified patient for a specified time period. (how to search by reference) and (how to search by token) 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/CarePlan?patient=1137192&category=assess-plan&date=ge2015-01-14]
[GET https://fhir-open-api-dstu2.smarthealthit.org/CarePlan?patient=1137192&category=assess-plan&date=ge2015-01-14&date=le2016-01-14]

GET /CarePlan?patient=[id]&category=assess-plan&status=active&date=[date]{&date=[date]}

Support: SHOULD support search by status="active" and date

Implementation Notes: Search for all active assessment and plan of treatment for a patient within a time period. Fetches a bundle of all active (careplan = "active") CarePlan resources for the specified patient for a specified time period. (how to search by reference) and (how to search by token) 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/CarePlan?patient=1137192&category=assess-plan&datatus=active&date=ge2015-01-14]

Open Issues

Issues for this IG have been identified and tracked HERE

todo - update examples, fix links

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