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.
The following APIs can be used to create an e-referral
Authentication and Authorisation
- A001 – Create Professional Session
- A002 – Professional Session Select Role
- A003 – Delete Professional Session
- A010 - Patient Service Search
- A011 - Create Referral
- A021 - Create Referral and Send for Triage
- A020 - Upload File To Document Store
A012 - Maintain Referral Letter
(Additional attachments can now be added or removed after first upload)
- A019 - Generate Patient Letter with shortlist and details of how to book an appointment