Retrieve healthcare service information

Retrieve healthcare service (A033, FHIR R4)

Overview

A patient may have 0 to 20 services associated with a single referral. A service is a place where a referrer can send a patient or obtain clinical advice concerning a specific patient. Services have attributes that can be used to understand a services functionality, terms of use, and contact information. You can use this endpoint to obtain the current version and attributes of a single service.

Supported security patterns

  • Application-restricted, unattended access
  • Healthcare worker, user-restricted access

Pre-requisites

Application-restricted access

In order to use this endpoint you must be an authenticated e-RS calling application, working in the context of a Referring Organisation.

Healthcare worker, user-restricted access

In order to use this endpoint you must be an authenticated e-RS user and use one of the following e-RS roles:

  • REFERRING_CLINICIAN
  • REFERRING_CLINICIAN_ADMIN

You need to have identified one service ID in order to use this endpoint.

Use case

As an authenticated user

I would like to be able to see current service information

So that I can trust that the service information is correct for my patient's referral

Related endpoints

  • You can retrieve service IDs on a referral via [[HYPERLINK_A005]] as long as the referral has a shortlist containing at least a single service.
  • You can check if a cached service has changed via [[HYPERLINK_A037]].
  • You can retrieve the attributes of an entire shortlist of services (1-20) via [[HYPERLINK_A035]].

Known Issues

The HealthcareService.type attribute is being returned as a singular object by this endpoint. As per the FHIR standard, this attribute should be an array. See our problems and fixes section for more information.

Sandbox test scenarios

You can test the following scenarios in our sandbox environment

ScenarioService Id
Service and minimal attributes1
Service and its attributes2
get/R4/HealthcareService/{id}

Path parameters

idstring required
Example:1

The ID of the service to be retrieved. It must be valid and relate to an existing Healthcare Service otherwise a HTTP 404 response will be returned.

Parameters

#/paths/~1R4~1Practitioner/get/parameters/0 — unresolved $ref
#/paths/~1R4~1Binary~1%7Bid%7D/get/parameters/3 — unresolved $ref
#/paths/~1R4~1Binary~1%7Bid%7D/get/parameters/2 — unresolved $ref
#/paths/~1R4~1Practitioner/get/parameters/1 — unresolved $ref

Response

Response contains the Healthcare Service requested.

Changes

No recorded changes to this endpoint across all 1 revision of this API.