FHIR Endpoint

Base Path: /fhir/4.0/Endpoint

Version: 2.0.0

The FHIR Endpoint API allows you to look up details about the FHIR 4.0 Endpoints. The endpoint provides the ability to:

  • Retrieve all Endpoint resources that match a search criteria.
  • Retrieve a specific Endpoint resource based on its FHIR ID.
  • Retrieve the history of an Endpoint resource based on its FHIR ID.
  • Retrieve a specific version of a Endpoint resource based on its FHIR ID and Version ID.
  • Retrieve Endpoint results from third-party sources.

The Endpoint 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 Endpoints

GET /fhir/4.0/Endpoint/

Return all Endpoint resources for the given search criteria, or all Endpoints if a search criteria is not specified.

Parameters

Name

Type

Data Type

Description

Name:

connection-type

optional

Type:

query

Data Type:

array

Description:

Filters the endpoints by the Protocol/Profile/Standard to be used with this endpoint connection. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.

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


Sample Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type|ihe-xca

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters the endpoints by the identifier associated with the endpoint.

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, urn:text:sysA|2345

Name:

name

optional

Type:

query

Data Type:

array

Description:

Filters the endpoints to those that have a matching name or alias. The search for name allows partial matches, is case insensitive and can match any one of the specified names.

Note:

  • Supports passing in a comma-separated list of values.


Sample Value: Health%20Intersections%20CarePlan%20Hub

Name:

organization

optional

Type:

query

Data Type:

array

Description:

Filters the endpoints to those with Endpoint.managingOrganization that match the specified managing organization references.

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


Sample Value: organization.address.city=Auckland&organization.address=123 Grafton Road&organization.name=University Medical Center, Good Health Clinic

Name:

payload-type

optional

Type:

query

Data Type:

array

Description:

Filters the endpoints to those that match the specified payload-type. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.


Sample Value: http://terminology.hl7.org/CodeSystem/endpoint-payload-type|urn:ihe:pcc:nn:2007

Name:

status

optional

Type:

query

Data Type:

array

Description:

Filters the status to those that match the specified status. The type may consists of a coding system and a code separated using a URL encoded | character i.e. %7c. The supported values are:

  • active
  • suspended
  • error
  • off
  • entered-in-error
  • test

Note:


Sample Value: active

Name:

date

optional

Type:

query

Data Type:

array

Description:

Filters the endpoints by the start date of the interval the endpoint is expected to be operational on, before, or after a specific date or date-time. 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. Note: Date range searches are not supported in solutions containing Orion Health Problem List since the patient may have non-date onsets.

The format of the query is

  • date=gt{dateTimeValue}


Sample Value: gt1990-01-01T01:00:00+13: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: include-sources=Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems

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: exclude-sources=Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems

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:

_lastUpdated

optional

Type:

query

Data Type:

array

Description:

Filters based on when the resource version was last changed, 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

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


Sample Value: ge2012-01-01T01:00:00+13:00

Name:

_elements

optional

Type:

query

Data Type:

array

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=status,name,_elements:exclude=*.extension

Name:

-cursor

optional

Type:

query

Data Type:

string

Description:

A server internal parameter to navigate different pages.

This parameter is returned by the server as part of the Bundle 'next' link of a paginated query. And is used to retrieve the next page.


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: 30

Name:

_sort

optional

Type:

query

Data Type:

array

Description:

Request which order results should be returned in.

Supported _sort parameters are:

  • date to sort by Endpoint.period.start ascending
  • -date to sort by Endpoint.period.start descending
  • name to sort by Endpoint.name ascending
  • -name to sort by Endpoint.name descending
  • _lastUpdated to sort by Endpoint.Meta.lastUpdated ascending
  • -_lastUpdatedto sort by Endpoint.Meta.lastUpdated descending

You can use any combination of the parameters


Default Value: -_lastUpdated

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

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.


Default Value: application/json

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:

_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: json

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:

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..* Endpoint 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 Endpoints by a name and a status
curl -X GET "https://developer-solution/fhir/4.0/Endpoint?name=Health%20Intersections%20CarePlan%20Hub&status=active" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve Endpoints

POST /fhir/4.0/Endpoint/_search

Return all Endpoint resources for the given search criteria, or all Endpoints if a search criteria is not specified.

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:

connection-type

optional

Type:

formData

Data Type:

array

Description:

Filters the endpoints by the Protocol/Profile/Standard to be used with this endpoint connection. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.

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


Sample Value: http://terminology.hl7.org/CodeSystem/endpoint-connection-type|ihe-xca

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters the endpoints by the identifier associated with the endpoint.

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,urn:text:sysA|2345

Name:

name

optional

Type:

formData

Data Type:

array

Description:

Filters the endpoints to those that have a matching name or alias. The search for name allows partial matches, is case insensitive and can match any one of the specified names.

Note:

  • Supports passing in a comma-separated list of values.


Sample Value: Health%20Intersections%20CarePlan%20Hub

Name:

organization

optional

Type:

formData

Data Type:

array

Description:

Filters the endpoints to those with Endpoint.managingOrganization that match the specified managing organization references.

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


Sample Value: organization.address.city=Auckland&organization.address=123 Grafton Road&organization.name=University Medical Center, Good Health Clinic

Name:

payload-type

optional

Type:

formData

Data Type:

array

Description:

Filters the endpoints to those that match the specified payload-type. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.


Sample Value: http://terminology.hl7.org/CodeSystem/endpoint-payload-type|urn:ihe:pcc:nn:2007

Name:

status

optional

Type:

formData

Data Type:

array

Description:

Filters the status to those that match the specified status. The type may consists of a coding system and a code separated using a URL encoded | character i.e. %7c. The supported values are:

  • active
  • suspended
  • error
  • off
  • entered-in-error
  • test

Note:


Sample Value: active

Name:

date

optional

Type:

formData

Data Type:

array

Description:

Filters the endpoints by the start date of the interval the endpoint is expected to be operational on, before, or after a specific date or date-time. 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. Note: Date range searches are not supported in solutions containing Orion Health Problem List since the patient may have non-date onsets.

The format of the query is

  • date=gt{dateTimeValue}


Sample Value: gt1990-01-01T01:00:00+13: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: include-sources=Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems

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: exclude-sources=Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems

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:

_lastUpdated

optional

Type:

formData

Data Type:

array

Description:

Filters based on when the resource version was last changed, 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

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


Sample Value: ge2012-01-01T01:00:00+13:00

Name:

_elements

optional

Type:

formData

Data Type:

array

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=status,name,_elements:exclude=*.extension

Name:

-cursor

optional

Type:

formData

Data Type:

string

Description:

A server internal parameter to navigate different pages.

This parameter is returned by the server as part of the Bundle 'next' link of a paginated query. And is used to retrieve the next page.


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: 30

Name:

_sort

optional

Type:

formData

Data Type:

array

Description:

Request which order results should be returned in.

Supported _sort parameters are:

  • date to sort by Endpoint.period.start ascending
  • -date to sort by Endpoint.period.start descending
  • name to sort by Endpoint.name ascending
  • -name to sort by Endpoint.name descending
  • _lastUpdated to sort by Endpoint.Meta.lastUpdated ascending
  • -_lastUpdatedto sort by Endpoint.Meta.lastUpdated descending

You can use any combination of the parameters


Default Value: -_lastUpdated

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

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.


Default Value: application/json

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:

_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: json

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:

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..* Endpoint resources

application/json+fhir

400

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

Sample Requests

Retrieve all Endpoints by its payload-type and identifier
curl -X POST "https://developer-solution/fhir/4.0/Endpoint/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'identifier=urn:oid:1.3.4.5.6.7%7C2345234234234,urn:text:sysA%7C2345' \
-d 'payload-type=http://terminology.hl7.org/CodeSystem/endpoint-payload-type%7Curn:ihe:pcc:nn:2007'

Retrieve a single Endpoint

GET /fhir/4.0/Endpoint/{id}

This method returns the Endpoint 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 Endpoint resource to query for


Sample Value: shaTWIQUXLR7RLNCR45AMPETZEQYJ6UDN6OV43CD6JCRJJZE3OX6IJQ

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

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:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: adUEctf6urd

Name:

_elements

optional

Type:

query

Data Type:

array

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=name,status,_elements:exclude=*.extension

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: json

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:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.


Default Value: application/json

Sample Value: application/json

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 Endpoint resource matching the requested resource ID.

application/json+fhir

400

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

application/json+fhir

404

No Endpoint 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/Endpoint/shaTWIQUXLR7RLNCR45AMPETZEQYJ6UDN6OV43CD6JCRJJZE3OX6IJQ" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve an Endpoint's history

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

This method returns the change history for an Endpoint resource matching the requested resource ID. Endpoint 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 Endpoint can be found, which includes cases where:

  • The specified Endpoint resource cannot be found.
  • The data source for the Endpoint 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 Endpoint resource to query for


Sample Value: shaAVBPGOC6J43TVYLK2D5RX6GVAT3PDVJVHQZ2AIR5NNMBJXJSJY7A

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

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:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: adUEctf6urd

Name:

_elements

optional

Type:

query

Data Type:

array

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=name,status,_elements:exclude=*.extension

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: json

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:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.


Default Value: application/json

Sample Value: application/json

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 0..* Endpoint resources matching the requested resource ID.

application/json+fhir

400

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

application/json+fhir

404

No Endpoint resource found with the requested resource ID.

Sample Requests

Retrieve the history of an endpoint identified a specific resource id
curl -X GET "https://developer-solution/fhir/4.0/Endpoint/shaAVBPGOC6J43TVYLK2D5RX6GVAT3PDVJVHQZ2AIR5NNMBJXJSJY7A/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve a specific version of an Endpoint

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

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

  • The specified Endpoint resource cannot be found.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the Endpoint resource to query for


Sample Value: shaAVBPGOC6J43TVYLK2D5RX6GVAT3PDVJVHQZ2AIR5NNMBJXJSJY7A

Name:

versionid

required

Type:

path

Data Type:

string

Description:

The version of the Endpoint resource


Sample Value: 2

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

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:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: adUEctf6urd

Name:

_elements

optional

Type:

query

Data Type:

array

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=name,status,_elements:exclude=*.extension

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: json

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:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.


Default Value: application/json

Sample Value: application/json

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 Endpoint resource matching the the requested resource ID and version id.

application/json+fhir

400

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

application/json+fhir

404

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

Sample Requests

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