This wiki has undergone a migration to Confluence found Here

Procedures

From HL7 Argonaut Project Wiki
Revision as of 14:31, 22 August 2016 by JoshMandel (talk | contribs) (Procedure.patient nshould be Procedure.subject)
Jump to navigation Jump to search

Back to Argonaut Implementation Guide

Introduction

The Argonaut Procedures IG provides the API documentation for searching for and fetching all of a patient's procedures. It is based on the Data Access Framework (DAF) Procedure Profile. 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).

Minimum Requirements

Clients

Servers

  • A server is capable of returning a patient's procedures using GET/Procedure?patient=[id].
  • A server is capable of returning all of all of a patient's procedures over a specified time period using GET /Procedure?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 in the Procedure resource 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 Procedure must have:

  1. a patient
  2. a code that identifies the type of procedure performed on the patient
  3. when the procedure was performed
  4. a status

Formal Summary of the Mandatory Requirements

  1. One patient reference in Procedure.subject
  2. One Identification of the procedure in Procedure.code which is bound to:
  3. A date or a time period in Procedure.performedDateTime or Procedure.performedPeriod
  4. A status code in Procedure.status which is bound to ProcedureStatus Value set (Code set)

Additional elements from DAF Procedure Profile may be present.

Optional vocabulary standards, ICD-10-PCS and Code on Dental Procedures and Nomenclature (CDT Code)

Based upon the 2015 Edition Certification Requirements, ICD-10-PCS codes MAY be supported as translations to either SNOMED-CT or CPT-4/HCPC. If choosing to primarily to dental procedures, the Code on Dental Procedures and Nomenclature (CDT Code) may be used.

Procedure Example

Quick Start

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


GET /Procedure?patient=[id]

Support: Mandatory to support search by patient.

Implementation Notes: Search for all Procedures and health concerns for a patient. Fetches a bundle of all Procedure 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/Procedure?patient=1291938]

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

Support: Mandatory to support search by patient and date or period

Implementation Notes: Search based on date. Fetches a bundle of all Procedure resources for the specified patient for 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 http://fhir2.healthintersections.com.au/open/Procedure?example&date=ge2002]
[GET http://fhir2.healthintersections.com.au/open/Procedure?example&date=ge2010$date=le2015]

Open Issues

Issues for this IG have been identified and tracked HERE

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