Base Path: /fhir/3.0/Encounter
Version: 1.0.0
The FHIR Encounter API allows you to look up a patient's encounters. The endpoint provides the ability to:
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 Encounter 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 STU3 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.
GET /fhir/3.0/Encounter/
This method returns all encounters for the patient identified by patient.identifier. Optionally filtering by the encounter's date.
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
.
The subject.identifier variant of this parameter is also supported.
Sample Value: ORION|AAAA-0124-8
Name:
date
optional
Type:
query
Data Type:
array
Description:
Filters the encounters to those with an encounter date on, before, or after a specific date, date-time, or date range.
The supported prefixes are gt
, ge
, lt
, le
and eq
. 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: gt2013-01-01T01:00:00%2B13:00
200
Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* Encounter resources
curl -X GET "https://api.orionhealth.io/fhir/3.0/Encounter/?patient.identifier=ORION%7CAAAA-0124-8" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'
curl -X GET "https://api.orionhealth.io/fhir/3.0/Encounter/?patient.identifier=ORION%7CAAAA-0124-8&date=gt2013-01-01T01:00:00%2B13:00" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'
POST /fhir/3.0/Encounter/_search
This method returns all encounters for the patient identified by patient.identifier. Optionally filtering by the encounter's date. This is the secure alternative to the GET search.
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
.
The subject.identifier variant of this parameter is also supported.
Sample Value: ORION|AAAA-0124-8
Name:
date
optional
Type:
formData
Data Type:
array
Description:
Filters the encounters to those with an onset date on, before, or after a specific date, date-time, or date range.
The supported prefixes are gt
, ge
, lt
, le
and eq
. 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: gt2013-01-01T01:00:00%2B13:00
200
Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* Encounter resources
curl -X POST "https://api.orionhealth.io/fhir/3.0/Encounter/_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'
curl -X POST "https://api.orionhealth.io/fhir/3.0/Encounter/_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=gt2013-01-01T01:00:00%2B13:00'
GET /fhir/3.0/Encounter/{id}
This method returns the Encounter resource matching the requested resource ID.
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the Encounter resource
Sample Value: IUZDSMBQGQWTAMBRFYYUAQ2IFVCU4QY
200
Returns an Encounter resource matching the requested resource ID.
400
This code is returned when the FHIR ID is empty or not valid.
404
No Encounter resource found with the requested resource ID.
curl -X GET "https://api.orionhealth.io/fhir/3.0/Encounter/IUZDSMBQGQWTAMBRFYYUAQ2IFVCU4QY" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'