FHIR HealthcareService
Base Path: /fhir/4.0/HealthcareService
Version: 1.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.
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 HealthcareService Resources by Criteria
GET /fhir/4.0/HealthcareService/
This method returns all HealthcareServices by search criteria.
Parameters
Name
Type
Data Type
Description
Name:
specialty
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those that match the specified specialty.
Sample Value: http://snomed.info/sct/Dermatology|17561000
Name:
name
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those with the specified name.
Sample Value: Smile Dental
Name:
service-type
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those that match the specified service-type. Values are passed in as {codingSystem}|{code}
Sample Value: http://snomed.info/sct|25961008
Name:
service-category
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those that match the specified service-category. Values are passed in as {codingSystem}|{code}
Sample Value: Community Health Care|7
Name:
active
optional
Type:
query
Data Type:
string
Description:
Filters the 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 the HealthcareServices to specific characteristics(attributes). Values are passed in as {codingSystem}|{code}.
Sample Value: Wheelchair Access|10005
Name:
coverage-area
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareService based on the location(s) service is intended for/available to. Note: This parameter can be chained to further define filters on the reference location. For each chained parameter, you can specify multiple values separated by commas.
Sample Value: coverage-area=Location/r0023
Name:
endpoint
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices based on the technical endpoint references providing access to services operated for this role. Note: This parameter can be chained to further define filters on the reference endpoint. For each chained parameter, you can specify multiple values separated by commas.
Sample Value: endpoint.name=Health Intersections CarePlan Hub
Name:
identifier
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices based on an external identifier.
Sample Value: http://hl7.org/fhir/R4/healthcareservice.html|123456
Name:
location
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those that match the specified location references. Note: This parameter can be chained to further define filters on the reference location. For each chained parameter, you can specify multiple values separated by commas. e.g location.name=medical-center&location.address-city=Auckland
Sample Value: location=Location/16
Name:
organization
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those that match the specified organization references. Note: This parameter can be chained to further define filters on the reference organization. For each chained parameter, you can specify multiple values separated by commas. e.g organization.name=Mental Hospital&organization.type=Hospital|h0323
Sample Value: organization=Organization/e0001
Name:
program
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those applicable to specific programs. Values are passed in as {codingSystem}|{code}.
Sample Value: PTSD outreach|efk01106
Name:
-include-sources
optional
Type:
query
Data Type:
array
Description:
The -include-sources parameter defines which sources should be queried for the results.
Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.
Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20HealthcareServices
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%20HealthcareServices
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header.
Possible values are json and xml. The default value is json.
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response.
Possible values are application/json and application/xml. The default value is application/xml.
Sample Value: application/xml
Responses
200
Returns a FHIR Bundle containing 0..* HealthcareService resources.
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 crietria
curl -X GET "https://developer-solution/fhir/4.0/HealthcareService/?specialty=http://snomed.info/sct/Dermatology%7C17561000" \
-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:
query
Data Type:
array
Description:
Filters the HealthcareServices to those that match the specified specialty.
Sample Value: http://snomed.info/sct/Dermatology|17561000
Name:
name
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those with the specified name.
Sample Value: Smile Dental
Name:
service-type
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those that match the specified service-type. Values are passed in as {codingSystem}|{code}
Sample Value: http://snomed.info/sct|25961008
Name:
service-category
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those that match the specified service-category. Values are passed in as {codingSystem}|{code}
Sample Value: Community Health Care|7
Name:
active
optional
Type:
query
Data Type:
string
Description:
Filters the 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 the HealthcareService to specific characteristics(attributes). Values are passed in as {codingSystem}|{code}
Sample Value: Wheelchair Access|10005
Name:
coverage-area
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareService based on the location(s) service is intended for/available to. Note: This parameter can be chained to further define filters on the reference location. For each chained parameter, you can specify multiple values separated by commas.
Sample Value: coverage-area=Location/r0023
Name:
endpoint
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices based on the technical endpoint references providing access to services operated for this role. Note: This parameter can be chained to further define filters on the reference endpoint. For each chained parameter, you can specify multiple values separated by commas.
Sample Value: endpoint.name=Health Intersections CarePlan Hub
Name:
identifier
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices based on an external identifier.
Sample Value: http://hl7.org/fhir/R4/healthcareservice.html|123456
Name:
location
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those that match the specified location references. Note: This parameter can be chained to further define filters on the reference location. For each chained parameter, you can specify multiple values separated by commas. e.g location.name=medical-center&location.address-city-Auckland
Sample Value: location=Location/16
Name:
organization
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those that match the specified organization references. Note: This parameter can be chained to further define filters on the reference organization. For each chained parameter, you can specify multiple values separated by commas. e.g organization.name=Mental Hospital&organization.type=Hospital|h0323
Sample Value: organization=Organization/e0001
Name:
program
optional
Type:
query
Data Type:
array
Description:
Filters the HealthcareServices to those applicable to specific programs. Values are passed in as {codingSystem}|{code}.
Sample Value: PTSD outreach|efk01106
Name:
-include-sources
optional
Type:
query
Data Type:
array
Description:
The -include-sources parameter defines which sources should be queried for the results.
Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.
Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20HealthcareServices
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%20HealthcareServices
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header.
Possible values are json and xml. The default value is json.
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response.
ossible values are application/json and application/xml. The default value is application/xml.
Sample Value: application/xml
Responses
200
Returns a FHIR Bundle containing 0..* HealthcareService resources
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 crietria
curl -X POST "https://developer-solution/fhir/4.0/HealthcareService/_search?specialty=http://snomed.info/sct/Dermatology%7C17561000" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='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:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header.
Possible values are json and xml. The default value is json.
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response.
Possible values are application/json and application/xml. The default value is application/xml.
Sample Value: application/xml
Responses
200
Returns a HealthcareService resource matching the requested resource ID.
400
This code is returned when the FHIR ID is empty or not valid.
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 History for a HealthcareService Resource by its FHIR ID
GET /fhir/4.0/HealthcareService/{id}/_history
This method returns all the versions for a specific HealthcareService resource based on its FHIR ID.
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: GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header.
Possible values are json and xml. The default value is json.
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response.
Possible values are application/json and application/xml. The default value is application/xml.
Sample Value: application/xml
Responses
200
Returns history of a HealthcareService with given id in the response body.
404
HealthcareService resource id is specified, but no corresponding resource is found.
Sample Requests
Retrieve the history of a HealthcareService identified a specific resource id.
curl -X GET "https://developer-solution/fhir/4.0/HealthcareService/GRQTEZRVGI4GILJTMQ4WMLJUGIYTILLBGJRTALLFMM2TGZRRG44TOZLDGJAFGMI/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='