FHIR EpisodeOfCare

Base Path: /fhir/4.0/EpisodeOfCare

Version: 2.0.0

The FHIR EpisodeOfCare API allows you to look up a patient's Episode of Care, which is often used to describe a coherent group of activities (such as encounters) related to a patient's health condition or problem. The endpoint provides the ability to:

The endpoint provides the ability to:

  • Retrieve all EpisodeOfCare resources that match search criteria for a given patient.
  • Retrieve a specific EpisodeOfCare resource based on its resource ID.
  • Retrieve the history of an EpisodeOfCare resource based on its FHIR ID.
  • Retrieve a specific version of an EpisodeOfCare resource based on its FHIR ID and Version ID.
  • Retrieve EpisodeOfCare results from third-party sources.
  • 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 EpisodeOfCare API aggregates data from multiple sources, to learn about working with aggregated APIs refer to the Working with Aggregation 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 EpisodeOfCares for a Patient

GET /fhir/4.0/EpisodeOfCare/

This method returns all Episode of Cares for the patient identified either by patient.identifier or by patient. Optionally filtering by using multiple search parameters.

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 a combination of those parameters.

  • In addition to having the required patient.identifier or patient, you can defined chained patient elements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

    Sample format of the query is

    • patient.identifier={namespace}|{identifier}
    • patient.identifier={namespace}|{identifier}&patient.gender=male&patient.birthdate=2002-05-01


Sample Value: OHCP|6f255034

Name:

patient

required

Type:

query

Data Type:

string

Description:

The patient resource id.

Note:

  • You must either define the patient.identifier or patient, not a combination of those parameters.

  • In addition to having the required patient.identifieror patient, you can defined chained patient elements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

    Sample format of the query is

    • patient={patient FHIRID}
    • patient={patient FHIRID}&patient.gender=male&patient.birthdate=2002-05-01


Sample Value: GZTDENJVGAZTIQCPJBBVA

Name:

care-manager

optional

Type:

query

Data Type:

array

Description:

Filters Episode of Cares based on the Care manager/care coordinator for the patient, identified by their EpisodeOfCare.careManager reference.

Note: care-manager can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: care-manager.name=Julie Miller

Name:

condition

optional

Type:

query

Data Type:

array

Description:

Filters Episode of Cares based on the Conditions/problems/diagnoses this Episode of Care is for, identified by their EpisodeOfCare.diagnosis.condition reference.

Note: condition can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: condition.clinicalStatus=active

Name:

date

optional

Type:

query

Data Type:

array

Description:

Filters the Episode of Cares to those with a period 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.

The format of the query is

  • date=gt{dateTimeValue}
  • date=ge{dateTimeValue}&date=le{dateTimeValue}


Sample Value: gt2020-01-01

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters Episode of Cares based on the identifier associated with this Episode of Care.

Note: The identifier can be a single item or a comma separated list of identifiers. Each identifier is defined by system and value, separated using a URL encoded | character i.e. %7c.


Sample Value: urn:oid:1.3.4.5.6.7|2345234234234

Name:

incoming-referral

optional

Type:

query

Data Type:

array

Description:

Filters Episode of Cares based on the incoming referral request for the Episode of Care, identified by their EpisodeOfCare.referralRequest reference.

Note: incoming-referral can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: incoming-referral.status=active

Name:

organization

optional

Type:

query

Data Type:

array

Description:

Filters Episode of Cares based on the organization that has assumed the specific responsibilities of this Episode of Care, identified by their EpisodeOfCare.managingOrganization reference.

Note: organization can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: organization.name=General%20Hospital

Name:

status

optional

Type:

query

Data Type:

array

Description:

Filters Episode of Cares based on the current status of the Episode of Care as provided (does not check the status history collection). Multiple statuses can be specified as comma-separated values. Possible values are:

  • planned
  • waitlist
  • active
  • onhold
  • finished
  • cancelled

  • entered-in-error

    Note:

    • if a status system is specified only http://hl7.org/fhir/episode-of-care-status can be used.
    • Supports passing in a comma-separated list of values.


Sample Value: active

Name:

type

optional

Type:

query

Data Type:

array

Description:

Filters Episode of Cares that match the specified Type/class of the Episode of Care - e.g. specialist referral, disease management. For each specified type, system and code are separated using a URL encoded | character i.e. %7c. It is matched to the EpisodeOfCare.type.

Note: Supports passing in a comma-separated list of values.


Sample Value: http://terminology.hl7.org/CodeSystem/episodeofcare-type|pac

Name:

_summary

optional

Type:

query

Data Type:

string

Description:

Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are

  • true: return summaries only
  • false: return full resources
  • count: return the count of search matches
  • text: return only the text, id, meta, and top-level mandatory elements
  • data: remove the text element


Sample Value: true

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 parameters 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%E2%84%A2%20R4%20HL7V2%20EpisodeOfCares

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%E2%84%A2%20R4%20HL7V2%20EpisodeOfCares

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=condition,type,status,_elements:exclude=*.type

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.


Default Value: xml

Sample Value: json

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

Sample Value: true

Name:

-cursor

optional

Type:

query

Data Type:

string

Description:

This is a server internal parameter to navigate different pages, indicating the server a cursor till where result matches were already returned.

This parameter is returned by the server as part of the next link of a paginated query.


Name:

_count

optional

Type:

query

Data Type:

integer

Description:

Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.

The returned bundle may contain a next link if more results could be available.


Sample Value: 100

Name:

_sort

optional

Type:

query

Data Type:

string

Description:

Request which order results should be returned in.

Supported _sort parameters are:

  • date to sort by EpisodeOfCare.period ascending.
  • -date to sort by EpisodeOfCare.period descending.
  • _lastUpdated to sort by EpisodeOfCare.meta.lastUpdated ascending.
  • -_lastUpdated to sort by EpisodeOfCare.meta.lastUpdated descending.

You can use any combination of the parameters.


Default Value: -date

Sample Value: _sort=-date,_sort=-date, -_lastUpdated

Name:

_lastUpdated

optional

Type:

query

Data Type:

array

Description:

Allows the user to filter Episode of Cares by the lastUpdated date. The date value can be a single date, as well as lower and/or upper bound.

The supported operations are: =gt, =ge, =lt, =ne, =le, =eq. For more information about using these search operators, refer to the date section on the FHIR Search page.

The {dateTimeValue} value should be in the following format: 2013-01-01T23:00:00-05:00. However, the time portion can be excluded. If a time portion is provided, the time zone must be provided as well.

It is highly recommended to provide the time zone portion in any query. Ensure that special characters such as '+' are encoded so that it can be interpreted correctly. For example: "2014-01-01T00:00:00+13:00" should be encoded like this: "2014-01-01T00:00:00%2B13:00".

If a date query comes in without a time zone, the date will be interpreted according to the server's time zone.

Including this query parameter includes all EpisodeOfCares that match the specified EpisodeOfCare.Meta.lastUpdated.


Sample Value: _lastUpdated=gt2012-01-01&_lastUpdated=lt2022-01-01

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.


Default Value: application/xml

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

Returns a FHIR Bundle containing 0.. OperationOutcome resources and 0.. EpisodeOfCare 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 all EpisodeOfCares matching specified search criteria for a patient identified by a patient identifier
curl -X GET "https://developer-solution/fhir/4.0/EpisodeOfCare?patient.identifier=OHCP%7C6f255034&date=gt2020-01-01&status=active&type=http://terminology.hl7.org/CodeSystem/episodeofcare-type%7Cpac" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve EpisodeOfCares for a Patient

POST /fhir/4.0/EpisodeOfCare/_search

This method returns all Episode of Cares for the patient identified either by patient.identifier or by patient. Optionally filtering by using multiple search parameters. This is a secure alternative to the GET method.

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 a combination of those parameters.

  • In addition to having the required patient.identifier or patient, you can defined chained patient elements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

    Sample format of the query is

    • patient.identifier={namespace}|{identifier}
    • patient.identifier={namespace}|{identifier}&patient.gender=male&patient.birthdate=2002-05-01


Sample Value: OHCP|6f255034

Name:

patient

required

Type:

formData

Data Type:

string

Description:

The patient resource id.

Note:

  • You must either define the patient.identifier or patient, not a combination of those parameters.

  • In addition to having the required patient.identifieror patient, you can defined chained patient elements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

    Sample format of the query is

    • patient={patient FHIRID}
    • patient={patient FHIRID}&patient.gender=male&patient.birthdate=2002-05-01


Sample Value: GZTDENJVGAZTIQCPJBBVA

Name:

care-manager

optional

Type:

formData

Data Type:

array

Description:

Filters Episode of Cares based on the Care manager/care coordinator for the patient, identified by their EpisodeOfCare.careManager reference.

Note: care-manager can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: care-manager.name=Julie Miller

Name:

condition

optional

Type:

formData

Data Type:

array

Description:

Filters Episode of Cares based on the Conditions/problems/diagnoses this Episode of Care is for, identified by their EpisodeOfCare.diagnosis.condition reference.

Note: condition can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: condition.clinicalStatus=active

Name:

date

optional

Type:

formData

Data Type:

array

Description:

Filters the Episode of Cares to those with a period 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.

The format of the query is

  • date=gt{dateTimeValue}
  • date=ge{dateTimeValue}&date=le{dateTimeValue}


Sample Value: gt2020-01-01

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters Episode of Cares based on the identifier associated with this Episode of Care.

Note: The identifier can be a single item or a comma separated list of identifiers. Each identifier is defined by system and value, separated using a URL encoded | character i.e. %7c.


Sample Value: urn:oid:1.3.4.5.6.7|2345234234234

Name:

incoming-referral

optional

Type:

formData

Data Type:

array

Description:

Filters Episode of Cares based on the incoming referral request for the Episode of Care, identified by their EpisodeOfCare.referralRequest reference.

Note: incoming-referral can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: incoming-referral.status=active

Name:

organization

optional

Type:

formData

Data Type:

array

Description:

Filters Episode of Cares based on the organization that has assumed the specific responsibilities of this Episode of Care, identified by their EpisodeOfCare.managingOrganization reference.

Note: organization can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: organization.name=General%20Hospital

Name:

status

optional

Type:

formData

Data Type:

array

Description:

Filters Episode of Cares based on the current status of the Episode of Care as provided (does not check the status history collection). Multiple statuses can be specified as comma-separated values. Possible values are:

  • planned
  • waitlist
  • active
  • onhold
  • finished
  • cancelled

  • entered-in-error

    Note:

    • if a status system is specified only http://hl7.org/fhir/episode-of-care-status can be used.
    • Supports passing in a comma-separated list of values.


Sample Value: active

Name:

type

optional

Type:

formData

Data Type:

array

Description:

Filters Episode of Cares that match the specified Type/class of the Episode of Care - e.g. specialist referral, disease management. For each specified type, system and code are separated using a URL encoded | character i.e. %7c. It is matched to the EpisodeOfCare.type.

Note: Supports passing in a comma-separated list of values.


Sample Value: http://terminology.hl7.org/CodeSystem/episodeofcare-type|pac

Name:

_summary

optional

Type:

formData

Data Type:

string

Description:

Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are

  • true: return summaries only
  • false: return full resources
  • count: return the count of search matches
  • text: return only the text, id, meta, and top-level mandatory elements
  • data: remove the text element


Sample Value: true

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 parameters 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%E2%84%A2%20R4%20HL7V2%20EpisodeOfCares

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%E2%84%A2%20R4%20HL7V2%20EpisodeOfCares

Name:

_elements

optional

Type:

formData

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=condition,type,status,_elements:exclude=*.type

Name:

_format

optional

Type:

formData

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.


Default Value: xml

Sample Value: json

Name:

_pretty

optional

Type:

formData

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

Sample Value: true

Name:

-cursor

optional

Type:

formData

Data Type:

string

Description:

This is a server internal parameter to navigate different pages, indicating the server a cursor till where result matches were already returned.

This parameter is returned by the server as part of the next link of a paginated query.


Name:

_count

optional

Type:

formData

Data Type:

integer

Description:

Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.

The returned bundle may contain a next link if more results could be available.


Sample Value: 100

Name:

_sort

optional

Type:

formData

Data Type:

string

Description:

Request which order results should be returned in.

Supported _sort parameters are:

  • date to sort by EpisodeOfCare.period ascending.
  • -date to sort by EpisodeOfCare.period descending.
  • _lastUpdated to sort by EpisodeOfCare.meta.lastUpdated ascending.
  • -_lastUpdated to sort by EpisodeOfCare.meta.lastUpdated descending.

You can use any combination of the parameters.


Default Value: -date

Sample Value: _sort=-date,_sort=-date, -_lastUpdated

Name:

_lastUpdated

optional

Type:

formData

Data Type:

array

Description:

Allows the user to filter Episode of Cares by the lastUpdated date. The date value can be a single date, as well as lower and/or upper bound.

The supported operations are: =gt, =ge, =lt, =ne, =le, =eq. For more information about using these search operators, refer to the date section on the FHIR Search page.

The {dateTimeValue} value should be in the following format: 2013-01-01T23:00:00-05:00. However, the time portion can be excluded. If a time portion is provided, the time zone must be provided as well.

It is highly recommended to provide the time zone portion in any query. Ensure that special characters such as '+' are encoded so that it can be interpreted correctly. For example: "2014-01-01T00:00:00+13:00" should be encoded like this: "2014-01-01T00:00:00%2B13:00".

If a date query comes in without a time zone, the date will be interpreted according to the server's time zone.

Including this query parameter includes all EpisodeOfCares that match the specified EpisodeOfCare.Meta.lastUpdated.


Sample Value: _lastUpdated=gt2012-01-01&_lastUpdated=lt2022-01-01

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.


Default Value: application/xml

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

Returns a FHIR Bundle containing 0.. OperationOutcome resources and 0.. EpisodeOfCare 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 all EpisodeOfCares that match specified search criteria for a patient identified by a patient resource id
curl -X POST "https://developer-solution/fhir/4.0/EpisodeOfCare/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'patient=GZTDENJVGAZTIQCPJBBVA' \
-d 'status=active'

Retrieve a single EpisodeOfCare

GET /fhir/4.0/EpisodeOfCare/{id}

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


Sample Value: MM4WINRQMMZTGLJQGM3WELJUMM4DOLLBG5TGMLJZGA4TON3GHFSTANZUMVAFGMI

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=condition,type,status,_elements:exclude=*.type

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

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.


Default Value: 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.


Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

Returns an EpisodeOfCare 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 EpisodeOfCare resource found with the requested resource ID or protected by privacy restrictions.

Sample Requests

Retrieve Episode of Cares identified by a specific id
curl -X GET "https://developer-solution/fhir/4.0/EpisodeOfCare/MM4WINRQMMZTGLJQGM3WELJUMM4DOLLBG5TGMLJZGA4TON3GHFSTANZUMVAFGMI" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve an EpisodeOfCare's history

GET /fhir/4.0/EpisodeOfCare/{id}/_history

This method returns the change history for an EpisodeOfCare resource matching the requested resource ID. EpisodeOfCare resources can be retrieved from multiple data sources, and not all sources are able to return history information. This operation will return an empty set of data if no versions of the specified EpisodeOfCare can be found, which includes cases where:

  • The specified EpisodeOfCare resource cannot be found.
  • The data source for the EpisodeOfCare is unable to return history information.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the EpisodeOfCare resource


Sample Value: shaWEEICZGNVUFTEGZLOXS6D3ARJCJA5W3ZPNERZL7IP6VARAGBSDWQ

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=condition,type,status,_elements:exclude=*.type

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

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.


Default Value: 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.


Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

A FHIR Bundle containing 1..* EpisodeOfCare resources matching the requested resource ID.

application/json+fhir

400

The source providing the EpisodeOfCare resource is not capable of returning history of EpisodeOfCare resources.

application/json+fhir

404

No EpisodeOfCare resource found with the requested resource ID.

Sample Requests

Retrieve the history of EpisodeOfCares identified by a resource id
curl -X GET "https://developer-solution/fhir/4.0/EpisodeOfCare/shaWEEICZGNVUFTEGZLOXS6D3ARJCJA5W3ZPNERZL7IP6VARAGBSDWQ/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve a specific version of an EpisodeOfCare

GET /fhir/4.0/EpisodeOfCare/{id}/_history/{versionid}

This method returns the specified version of an EpisodeOfCare resource matching the requested resource ID. EpisodeOfCare resources can be retrieved from multiple data sources. This operation will return an empty set of data if no versions of the specified Episode of Care can be found, which includes cases where:

  • The specified EpisodeOfCare resource cannot be found.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the EpisodeOfCare resource


Sample Value: shaUVPZHMCMH5ACN76OKCHJSUAJDQXTPPIPSRXJFFISDFUZ72NJ3TUA

Name:

versionid

required

Type:

path

Data Type:

integer

Description:

The version of the EpisodeOfCare resource


Sample Value: 1

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=condition,type,status,_elements:exclude=*.type

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

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.


Default Value: 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.


Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

Returns an EpisodeOfCare resource matching the the requested resource ID and version id.

application/json+fhir

400

The source providing the EpisodeOfCare resource is not capable of returning history of EpisodeOfCare resources.

application/json+fhir

404

  • No EpisodeOfCare resource found with the requested resource ID.
  • The version id specified does not exist for the EpisodeOfCare resource with the requested resource ID.

Sample Requests

Retrieve the version of EpisodeOfCare identified by a resource id and a version id
curl -X GET "https://developer-solution/fhir/4.0/EpisodeOfCare/shaUVPZHMCMH5ACN76OKCHJSUAJDQXTPPIPSRXJFFISDFUZ72NJ3TUA/_history/1" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='