FHIR Procedure
Base Path: /fhir/1.0/Procedure
Version: 2.0.0
The FHIR Procedure API allows you to look up details about the procedures that were performed on a patient. The endpoint provides the ability to:
- Retrieve all Procedure resources that match a search criteria for a given patient.
- Retrieve a specific Procedure resource based on its resource ID.
The data returned in this API is subject to privacy and permissions settings, refer to the Working with Privacy guide to learn how this might affect your application.
The Procedure API aggregates data from multiple sources, to learn about working with aggregated APIs refer to the Aggregated APIs guide in the Knowledge Hub.
This API is based on the DSTU2 release of the FHIR standard, for more information on this API refer to the official FHIR documentation.
Authorization: OAuth 2.0 Bearer token is required to access the resources of this API. Once signed up, credentials and URL to access the OAuth API can be found on My Apps Page.
Methods
Get Procedures for a Patient
GET /fhir/1.0/Procedure/
This method returns all procedures for the patient identified by patient.identifier. Optionally filtering by the procedure's code and date, and the identifier of the person who performed the procedure.
Parameters
Name
Type
Data Type
Description
Name:
patient.identifier
required
Type:
query
Data Type:
string
Description:
The patient identifier consists of patient identifier namespace, also known as the system, and identifier, separated using a URL encoded | character i.e. %7c.
Sample Value: ORION|AAAA-0124-8
Name:
date
optional
Type:
query
Data Type:
string
Description:
Filters the procedures to those with a performed date on, before, or after a specific date or date-time.
The supported prefixes are >, >=, < and <=. If no prefix is used, exact date or date-time matching is implied.
Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00).
Ensure that special characters such as + are URL encoded i.e. %2B.
Sample Value: >=2013-01-01T01:00:00+13:00
Name:
code
optional
Type:
query
Data Type:
string
Description:
Filters the procedures to those that match the specified code. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.
Sample Value: http://snomed.info/sct|456004
Name:
performer.actor.identifier
optional
Type:
query
Data Type:
string
Description:
Filters the procedures to those that match the specified performer identifier. The identifier consists of identifier namespace, also known as the system, and identifier, separated using a URL encoded | character i.e. %7c.
Sample Value: SYS_A-PV|5501611
Name:
encounter.identifier
optional
Type:
query
Data Type:
string
Description:
Filters the procedures to those that have an associated encounter with the specified identifier. The identifier consists of identifier namespace, also known as the system, and identifier, separated using a URL encoded | character i.e. %7c.
Sample Value: CH-ENC|E94569-4565.9
Responses
200
Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* Procedure resources
Sample Requests
Get all Patient Procedures
curl -X GET "https://api.orionhealth.io/fhir/1.0/Procedure/?patient.identifier=ORION%7CAAAA-0124-8" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'Search for specific Patient Procedures
curl -X GET "https://api.orionhealth.io/fhir/1.0/Procedure/?patient.identifier=ORION%7CAAAA-0124-8&date=>=2013-01-01T01:00:00+13:00" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'Get Procedures for a Patient
POST /fhir/1.0/Procedure/_search
This method returns all procedures for the patient identified by patient.identifier. Optionally filtering by the procedure's code and date, and the identifier of the person who performed the procedure. This is the secure alternative to the GET search.
Parameters
Name
Type
Data Type
Description
Name:
Content-Type
required
Type:
header
Data Type:
string
Description:
Specifies how to encode the form data. The Content-Type value must be application/x-www-form-urlencoded
Sample Value: application/x-www-form-urlencoded
Name:
patient.identifier
required
Type:
formData
Data Type:
string
Description:
The patient identifier consists of patient identifier namespace, also known as the system, and identifier, separated using a URL encoded | character i.e. %7c.
Sample Value: ORION|AAAA-0124-8
Name:
date
optional
Type:
formData
Data Type:
string
Description:
Filters the procedures to those with a performed date on, before, or after a specific date or date-time.
The supported prefixes are >, >=, < and <=. If no prefix is used, exact date or date-time matching is implied.
Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00).
Ensure that special characters such as + are URL encoded i.e. %2B.
Sample Value: >=2013-01-01T01:00:00+13:00
Name:
code
optional
Type:
formData
Data Type:
string
Description:
Filters the procedures to those that match the specified code. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.
Sample Value: http://snomed.info/sct|456004
Name:
performer.actor.identifier
optional
Type:
formData
Data Type:
string
Description:
Filters the procedures to those that match the specified performer identifier. The identifier consists of identifier namespace, also known as the system, and identifier, separated using a URL encoded | character i.e. %7c.
Sample Value: SYS_A-PV|5501611
Name:
encounter.identifier
optional
Type:
formData
Data Type:
string
Description:
Filters the procedures to those that have an associated encounter with the specified identifier. The identifier consists of identifier namespace, also known as the system, and identifier, separated using a URL encoded | character i.e. %7c.
Sample Value: CH-ENC|E94569-4565.9
Responses
200
Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* Procedure resources
Sample Requests
Get all Patient Procedures
curl -X POST "https://api.orionhealth.io/fhir/1.0/Procedure/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'patient.identifier=ORION%7CAAAA-0124-8'Search for specific Patient Procedures
curl -X POST "https://api.orionhealth.io/fhir/1.0/Procedure/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'patient.identifier=ORION%7CAAAA-0124-8' \
-d 'date=>=2013-01-01T01:00:00+13:00'Retrieve a single Procedure
GET /fhir/1.0/Procedure/{id}
This method returns the Procedure resource matching the requested resource ID.
Parameters
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the Procedure resource
Sample Value: shaRCKMH6OERV6XXHV2BUJWTURNDOHMWT3YTFEZIRDH2WJBUYYWVEGQ
Responses
200
Returns a Procedure resource matching the requested resource ID.
404
No Procedure resource found with the requested resource ID.
Sample Request
curl -X GET "https://api.orionhealth.io/fhir/1.0/Procedure/shaRCKMH6OERV6XXHV2BUJWTURNDOHMWT3YTFEZIRDH2WJBUYYWVEGQ" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'