Status:

This site has now been archived.

Please visit https://digital.nhs.uk/developer/api-catalogue/e-referral-service-fhir to learn more about how to integrate with the e-Referral Service (e-RS) FHIR API.

Definition

This page describes the functionality available for receiving e-referrals into other software systems including how to retrieve the “Referrals for Review” worklist, the Clinical Referral Information (CRI) and any referral attachments (Sometimes known as “The referral letter”) from the NHS e-Referral Service (e-RS). Further APIs also allow sending the result of a clinical review back to e-RS (i.e. Accept or Reject). These APIs have been developed in accordance with the FHIR STU3 specification, guidance for developers is available online here.

Process Diagram

The following APIs are used to receive e-referrals from e-RS

Authentication and Authorisation

• A001 – Create Professional Session
• A002 – Professional Session Select Role
• A003 – Delete Professional Session

Reference Data

• A004 - Retrieve Reference Data

Clinical Referral Information

• A005 – Retrieve Referral Request
• A006 – Retrieve Attachment
• A007 – Retrieve Clinical Information
• A008 – Retrieve Worklist ASI worklist now available

Clinical Review

• A013 – Accept Referral
• A014 – Reject Referral
• A022: Cancel Appointment, Action Later
• A028: Record Review Outcome

Advice & Guidance

• A023 - Retrieve Advice and Guidance Requests Worklist
• A024 - Retrieve Advice and Guidance Request Summary
• A025 - Retrieve Advice and Guidance Conversation
• A026 - Send Advice and Guidance Response
• A027 - Convert Advice and Guidance Request to Referral