FHIR HealthcareService

Base Path: /fhir/4.0/HealthcareService

Version: 2.0.0

The FHIR HealthcareService API allows you to look up and retrieve HealthcareService information. The endpoint provides the ability to:

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

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.

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 HealthcareServices

GET /fhir/4.0/HealthcareService/

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

Parameters

Name

Type

Data Type

Description

Name:

specialty

optional

Type:

query

Data Type:

array

Description:

Filters specialty of the service provided by this healthcare service. 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://snomed.info/sctCode|408467006

Name:

name

optional

Type:

query

Data Type:

array

Description:

Filters HealthcareServices to those with the specified name.

Note:

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


Sample Value: Consulting psychologists

Name:

service-type

optional

Type:

query

Data Type:

array

Description:

Filters HealthcareServices by the type of service provided by this healthcare service. 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/service-type|Feldenkrais

Name:

service-category

optional

Type:

query

Data Type:

array

Description:

Filters HealthcareServices by the service Category of the Healthcare Service. 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/service-category|Adoption

Name:

active

optional

Type:

query

Data Type:

string

Description:

Filters HealthcareServices based on their current status.

Note: Set the value to true to retrieve active HealthcareServices or false to retrieve inactive HealthcareServices.


Sample Value: true

Name:

characteristic

optional

Type:

query

Data Type:

array

Description:

Filters HealthcareServices by one of the HealthcareService's characteristics. 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: Wheelchair Access|10005

Name:

coverage-area

optional

Type:

query

Data Type:

array

Description:

Filters HealthcareServices by the location(s) service is intended for/available to, identified by their HealthcareService.coverageArea reference.

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


Sample Value: coverage-area:Location.address-city=AUCKLAND

Name:

endpoint

optional

Type:

query

Data Type:

array

Description:

Filters HealthcareServices by the technical endpoints providing access to electronic services operated for the healthcare service, identified by their HealthcareService.endpoint reference.

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


Sample Value: endpoint.name=Health Intersections CarePlan Hub

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters HealthcareServices by the identifier associated with the HealthcareService.

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:

location

optional

Type:

query

Data Type:

array

Description:

Filters HealthcareServices by the location of the Healthcare Service, identified by their HealthcareService.location reference.

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


Sample Value: location.address-city=AUCKLAND

Name:

organization

optional

Type:

query

Data Type:

array

Description:

Filters HealthcareServices by the organization that provides this Healthcare Service, identified by their HealthcareService.providedBy 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=Auckland%20Hospital

Name:

program

optional

Type:

query

Data Type:

array

Description:

Filters HealthcareServices by one of the Programs supported by this HealthcareService 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/program|ChildFIRST

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=type,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:

  • active to sort by HealthcareService.active ascending
  • -active to sort by HealthcareService.active descending
  • name to sort by HealthcareService.name ascending
  • -name to sort by HealthcareService.name descending
  • _lastUpdated to sort by HealthcareService.Meta.lastUpdated ascending
  • -_lastUpdatedto sort by HealthcareService.Meta.lastUpdated descending

You can use any combination of the parameters


Default Value: -_lastUpdated

Sample Value: _sort=-active,_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.. HealthcareService 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

Get all HealthcareServices by criteria
curl -X GET "https://developer-solution/fhir/4.0/HealthcareService?specialty=http://snomed.info/sctCode%7C408467006" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve HealthcareServices by criteria

POST /fhir/4.0/HealthcareService/_search

This method returns all HealthcareServices by search criteria. 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:

specialty

optional

Type:

formData

Data Type:

array

Description:

Filters specialty of the service provided by this healthcare service. 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://snomed.info/sctCode%7C408467006

Name:

name

optional

Type:

formData

Data Type:

array

Description:

Filters HealthcareServices to those with the specified name.

Note:

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


Sample Value: akron

Name:

service-type

optional

Type:

formData

Data Type:

array

Description:

Filters HealthcareServices by the type of service provided by this healthcare service. 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/service-type|Feldenkrais

Name:

service-category

optional

Type:

formData

Data Type:

array

Description:

Filters HealthcareServices by the service Category of the Healthcare Service. 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/service-category|Adoption

Name:

active

optional

Type:

formData

Data Type:

string

Description:

Filters HealthcareServices based on their current status.

Note: Set the value to true to retrieve active HealthcareServices or false to retrieve inactive HealthcareServices.


Sample Value: true

Name:

characteristic

optional

Type:

formData

Data Type:

array

Description:

Filters HealthcareServices by one of the HealthcareService's characteristics. 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: Wheelchair Access|10005

Name:

coverage-area

optional

Type:

formData

Data Type:

array

Description:

Filters HealthcareServices by the location(s) service is intended for/available to, identified by their HealthcareService.coverageArea reference.

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


Sample Value: coverage-area:Location.address-city=AUCKLAND

Name:

endpoint

optional

Type:

formData

Data Type:

array

Description:

Filters HealthcareServices by the technical endpoints providing access to electronic services operated for the healthcare service, identified by their HealthcareService.endpoint reference.

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


Sample Value: endpoint.name=Health Intersections CarePlan Hub

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters HealthcareServices by the identifier associated with the HealthcareService.

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:

location

optional

Type:

formData

Data Type:

array

Description:

Filters HealthcareServices by the location of the Healthcare Service, identified by their HealthcareService.location reference.

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


Sample Value: location.address-city=AUCKLAND

Name:

organization

optional

Type:

formData

Data Type:

array

Description:

Filters HealthcareServices by the organization that provides this Healthcare Service, identified by their HealthcareService.providedBy 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.type=Auckland%20Hospital

Name:

program

optional

Type:

formData

Data Type:

array

Description:

Filters HealthcareServices by one of the Programs supported by this HealthcareService 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/program|ChildFIRST

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=type,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:

  • active to sort by HealthcareService.active ascending
  • -active to sort by HealthcareService.active descending
  • name to sort by HealthcareService.name ascending
  • -name to sort by HealthcareService.name descending
  • _lastUpdated to sort by HealthcareService.Meta.lastUpdated ascending
  • -_lastUpdatedto sort by HealthcareService.Meta.lastUpdated descending

You can use any combination of the parameters


Default Value: -_lastUpdated

Sample Value: _sort=-active,_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.. HealthcareService 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

Get all HealthcareServices by specific criteria
curl -X POST "https://developer-solution/fhir/4.0/HealthcareService/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'specialty=http://snomed.info/sctCode%7C408467006'

Retrieve a single HealthcareService

GET /fhir/4.0/HealthcareService/{id}

This method returns the HealthcareService 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 HealthcareService resource to retrieve.


Sample Value: GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI

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=type,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 a HealthcareService 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 HealthcareService resource found with the requested resource ID.

Sample Requests

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

Retrieve a HealthcareService's history

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

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

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


Sample Value: shaG63KLF4AZWPP2Q2RWRZLKURATYMTMQTJSN2VB4IXPMOQYOSJX5WQ

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=type,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..* HealthcareService resources matching the requested resource ID.

application/json+fhir

400

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

application/json+fhir

404

No HealthcareService resource found with the requested resource ID.

Sample Requests

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

Retrieve a specific version of a HealthcareService

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

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

  • The specified HealthcareService resource cannot be found.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the HealthcareService resource to retrieve history for.


Sample Value: sha5GVVGQPTJSANY4YT7OJILVR3LQDXLLVZA55ARKTBTGTJ3CW7LGSA

Name:

versionid

required

Type:

path

Data Type:

string

Description:

The version of the HealthcareService 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=type,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 a HealthcareService resource matching the the requested resource ID and version id.

application/json+fhir

400

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

application/json+fhir

404

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

Sample Requests

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