Argonaut Data Query Implementation Guide Version 1.0.0

This page is part of the Argonaut Data Query Implementation Guide (v1.0.0: Release) based on FHIR R2. This is the current published version. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-argo-procedure

This profile sets minimum expectations for the Procedure resource to record, search and fetch procedures associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the Argonaut Procedure profile:

  • Query for procedures performed on a Patient
  • Record a procedure performed on a Patient
Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Procedure must have:

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

Profile specific implementation guidance:

Examples

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://fhir.org/guides/argonaut/StructureDefinition/argo-procedure

This profile builds on Procedure.

This profile was published on Tue Oct 18 00:00:00 AEDT 2016 as a draft by Argonaut Project.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Complete Summary of the Mandatory Requirements

  1. One patient reference in Procedure.patient
  2. A status code in Procedure.status which has a required binding to:
  3. One Identification of the procedure in Procedure.code which has:
  4. A date or a time period in Procedure.performedDateTime or Procedure.performedPeriod

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

D.4.1.2 Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the Argonaut Data Query implementation guide server for a complete list of supported RESTful operations and search parameters for this IG.


GET /Procedure?patient=[id]

Example:

GET https://fhir-open-api-dstu2.smarthealthit.org/Procedure?patient=1291938

Support: Mandatory to support search by patient.

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

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

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

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