Receive and review advice and guidance requests as a service provider

This page describes the functionality available via our API for service provider organisations to receive advice and guidance requests, including all associated clinical referral information. 

The referral can subsequently be reviewed and actioned by sending back a response or converting the request into a referral.

This use case guide covers:

1. Retrieve advice and guidance information.
2. Review advice and guidance request.

The process diagram shows how the various endpoints can be used to create an integrated solution. Endpoints in red denote those which can be accessed via the application-restricted, unattended access route.

This use case covers the functionality to retrieve full details of an advice and guidance request. 

This includes:

• Advice and guidance request summary information
• Advice and guidance conversation
• References to file attachments

1.1 Identify referrals

Endpoint: Retrieve advice and guidance requests worklist (A023)

The referral process starts with identifying all current advice and guidance requests from the providers worklist.

Worklists provide lists of referrals that meet certain criteria, typically where a user needs to be aware of something important, or to undertake an action, in order to avoid delays to patient care.

The worklist in this case contains advice and guidance requests the provider has received and which need actioning.

1.2 Retrieve advice and guidance information

Endpoints: Retrieve advice and guidance request summary (A024), Retrieve advice and guidance conversation (A025), Retrieve attachment (A042), Retrieve advice and guidance overview PDF (A043)

Once the advice and guidance request is known, then all four endpoints must be used to obtain the full scope of clinical referral information.

These endpoints are also available as application-restricted, unattended access and detailed as part of our security and authorisation options.

Read the guidance on how to ensure your integrated software retrieves all the associated clinical referral information.

Once all summary, conversation and clinically relevant information has been retrieved, further functionality can be used via the API to send back a response or, if clinically appropriate, convert the advice and guidance request to a referral.

2.1 Send advice and guidance response

Endpoint: Send advice and guidance response (A026)

A service provider can review the advice and guidance request and decide to send a response back to the originating referrer.

As part of this review step, it is possible to include attachments with the response. The Upload file to document store (A020) endpoint must be used to upload attachments, ready to be associated when the send response endpoint is called.

2.2 Convert advice and guidance request to a referral

Endpoint: Convert advice and guidance request to referral (A027)

If the referrer has authorised the provider to convert, the following endpoint can be used to convert the advice and guidance request to a referral.

In this process:

• The convert action creates a task for the service provider admin team to shortlist appropriate services for the patient
• An entry will be added to the service providers 'Appointments For Booking' worklist for the admin team to action the task
• This action can only be progressed via the e-RS professional application user interface currently

As part of this review step, it is possible to include attachments. The Upload file to document store (A020) endpoint must be used to upload attachments, ready to be associated when the convert action endpoint is called.