FHIR Encounter

Base Path: /fhir/4.0/Encounter

Version: 1.2.0

The FHIR Encounter API allows you to look up a patient's encounters. The endpoint provides the ability to:

  • Retrieve all Encounter resources that match a search criteria for a given patient.
  • Retrieve a specific Encounter resource based on its FHIR ID.
  • Supports exporting resources via FHIR Bulk.

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 R4 release of the FHIR standard, for more information on this API refer to the official FHIR documentation.

Methods

Retrieve Encounters for a Patient

GET /fhir/4.0/Encounter/

This method returns all encounters for the patient identified either by patient.identifier or by patient. Optionally filtering by the encounter's date.

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.

Note: You must either define the patient.identifier or patient, not both.


Sample Value: ORION|AAA-00328-9

Name:

patient

required

Type:

query

Data Type:

string

Description:

The patient resource id.

Note: You must either define the patient.identifier or patient, not both.


Sample Value: IFAUCQJNGAYTENBNHBAE6USJJ5HA

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: gt2009-01-01T01:00:00%2B13:00

Name:

-include-sources

optional

Type:

query

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.


Sample Value: Orion%20Health%5C%5Cu2122%20R4%20HL7V2%20Encounters

Name:

-exclude-sources

optional

Type:

query

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled..


Sample Value: Orion%20Health%5C%5Cu2122%20R4%20HL7V2%20Encounters

Name:

-cdr-include-cancelled

optional

Type:

query

Data Type:

string

Description:

The Only supported values for the parameter are "true" or "false". Set to true to return all CDR8 encounters (including the cancelled that are not returned by default).

Note: -cdr-include-cancelled is applicable only for the Encounters CDR8 source, and ignored by other sources.


Sample Value: true

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the Accept header.

Possible values are json and xml. The default value is xml.


Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response.

Possible values are application/json and application/xml. The default value is application/xml.


Sample Value: application/xml

Responses

application/json+fhir

200

Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* Encounter resources

application/json+fhir

400

This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.

Sample Requests

Retrieve Encounters with a specific date for a Patient identified by a patient identifier
curl -X GET "https://developer-solution/fhir/4.0/Encounter/?patient.identifier=ORION%7CAAA-00328-9&date=gt2009-01-01T01:00:00%2B13:00" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve Encounters for a Patient

POST /fhir/4.0/Encounter/_search

This method returns all encounters for the patient identified either by patient.identifier or by patient. Optionally filtering by the encounter's date. 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.

Note: You must either define the patient.identifier or patient, not both.


Sample Value: ORION|AAAA-0124-8

Name:

patient

required

Type:

formData

Data Type:

string

Description:

The patient resource id.

Note: You must either define the patient.identifier or patient, not both.


Sample Value: IFAUCQJNGAYTENBNHBAE6USJJ5HA

Name:

date

optional

Type:

formData

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

Name:

-include-sources

optional

Type:

formData

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.


Sample Value: Orion%20Health%5C%5Cu2122%20R4%20HL7V2%20Encounters

Name:

-exclude-sources

optional

Type:

formData

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled..


Sample Value: Orion%20Health%5C%5Cu2122%20R4%20HL7V2%20Encounters

Name:

-cdr-include-cancelled

optional

Type:

formData

Data Type:

string

Description:

The Only supported values for the parameter are "true" or "false". Set to true to return all CDR8 encounters (including the cancelled that are not returned by default).

Note: -cdr-include-cancelled is applicable only for the Encounters CDR8 source, and ignored by other sources.


Sample Value: true

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the Accept header.

Possible values are json and xml. The default value is xml.


Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response.

Possible values are application/json and application/xml. The default value is application/xml.


Sample Value: application/xml

Responses

application/json+fhir

200

Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* Encounter resources

application/json+fhir

400

This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.

Sample Requests

Retrieve Encounters for a Patient identified by a patient resource id
curl -X POST "https://developer-solution/fhir/4.0/Encounter/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'patient=IFAUCQJNGAYTENBNHBAE6USJJ5HA'

Retrieve a single Encounter

GET /fhir/4.0/Encounter/{id}

This method returns the Encounter 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 Encounter resource


Sample Value: shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the Accept header.

Possible values are json and xml. The default value is xml.


Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response.

Possible values are application/json and application/xml. The default value is application/xml.


Sample Value: application/xml

Responses

application/json+fhir

200

Returns an Encounter resource matching the requested resource ID.

application/json+fhir

400

This code is returned when the FHIR ID is empty or not valid.

application/json+fhir

404

No Encounter resource found with the requested resource ID.

Sample Requests

Retrieve an Encounter identified by a specific resource id
curl -X GET "https://developer-solution/fhir/4.0/Encounter/shaO74NZR7CTOEKDLODIFSODJS4DLRWBEJ6XIO4PGOGJDCTSMCWVNSQ" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='