Search for healthcare services (A035, 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. You can use this endpoint to obtain a set of services (up to 20) and their associated attributes, in a single call.

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 at least one service ID in order to use this endpoint.

Use case

As an authenticated user

I would like to obtain information about all services on my patient's current shortlist

So that I can review the entire shortlist of services and each service's current attributes

Related endpoints

• You can retrieve service IDs on a referral via [[HYPERLINK_A005]] as long as the referral has a shortlist of at least one service.
• You can check if a cached service has changed via [[HYPERLINK_A037]].
• You can fetch the attributes of a single service via [[HYPERLINK_A033]].

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