Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Creating e-Referrals for Referring Organisations

How to create new e-referrals from within other systems using the e-RS integration APIs
Status: Live

Definition

This page describes the APIs required to conduct a search for services relevant for the selected patient, create an e-referral with a shortlist of directly and/or in-directly bookable services or create an e-referral for a Referral Assessment Service (RAS). The APIs also allow for the initial upload of attachments (Sometimes known as “The referral letter”) and generate a confirmation letter for the patient. The search limits results to services which are appropriate for patient and the referring organisation based on the commissioning rules that apply to the authenticated user and/or the patient.

Following creation of a referral to a directly bookable service in e-RS a search for available appointment slots can be performed and a slot booked for the patient against their referral. In the case where there are no available appointment slots for a directly bookable service then the responsibility for booking the patient’s appointment can be deferred to the service provider. In both cases the relevant patient letter can be downloaded.

Process Diagram

Creating Referrals

The following APIs can be used to create an e-referral

Authentication and Authorisation

Reference Data

Create Referral

Book Appointment

Notes:
The creation of an e-referral to a service set up as a RAS is different to other referrals. Therefore, a referral request for a RAS should be created using the endpoint A021: Create Referral And Send For Triage with a shortlist containing ONLY the intended service. However, a referral containing a shortlist of non-RAS services (I.e. Directly bookable services (DBS) or in-directly bookable services (IBS)) should be created using A011: Create Referral.

Clinical information should be collated into an attachment and added to the referral, it cannot currently be uploaded as separate structured data.

All content is available under the Open Government Licence v3.0, except where otherwise stated