Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

e-Referral Service (e-RS) - FHIR API

Create paperless referrals from primary to secondary care and receive referrals, Clinical Referral Information (CRI) and attachments from the NHS e-Referral Service, as an HL7 FHIR API. OpenAPI harvested verbatim (38 paths).

e-Referral Service (e-RS) - FHIR API is one of 10 APIs that NHS England publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include FHIR, Referrals, and e-RS. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 40 operations across 38 paths. It is described by OpenAPI 3.0.0, at version 0.0.1.

Requests are made against 3 base URLs: https://sandbox.api.service.nhs.uk/referrals/FHIR, https://int.api.service.nhs.uk/referrals/FHIR, https://api.service.nhs.uk/referrals/FHIR.

40 operations 38 paths 0 schemas 17 GET1 HEAD21 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.0.1
Base URL
https://api.service.nhs.uk/referrals/FHIR
Authentication
HTTP Bearer
License
MIT
Resource Areas
1

Authentication & Security 1

e-Referral Service (e-RS) - FHIR API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 40

Across 38 paths, the API surfaces 40 operations — 17 GET, 1 HEAD, 21 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Operations 40
GET
/STU3/CodeSystem/{codeSystemType}
POST
/STU3/ReferralRequest/$ers.fetchworklist
GET
/STU3/ReferralRequest/{ubrn}
GET
/STU3/Task
GET
/STU3/ReferralRequest/{ubrn}/_history/{version}
GET
/STU3/Binary/{attachmentLogicalID}
GET
/R4/Binary/{id}
POST
/STU3/ReferralRequest/{ubrn}/$ers.generateCRI
POST
/STU3/HealthcareService/$ers.searchHealthcareServicesForPatient
POST
/STU3/ReferralRequest/$ers.createReferral
POST
/STU3/ReferralRequest/$ers.createReferralAndSendForTriage
GET
/STU3/Slot
POST
/STU3/Appointment
POST
/STU3/Binary
POST
/STU3/ReferralRequest/{ubrn}/$ers.maintainReferralLetter
POST
/STU3/ReferralRequest/{ubrn}/$ers.acceptReferral
POST
/STU3/ReferralRequest/{ubrn}/$ers.rejectReferral
POST
/STU3/ReferralRequest/{ubrn}/$ers.generatePatientLetter
POST
/STU3/ReferralRequest/{ubrn}/$ers.cancelAppointmentActionLater
POST
/STU3/CommunicationRequest/$ers.fetchworklist
GET
/STU3/CommunicationRequest/{ubrn}
GET
/STU3/CommunicationRequest/{ubrn}/_history/{version}
GET
/STU3/Communication
POST
/STU3/CommunicationRequest/{ubrn}/$ers.sendCommunicationToRequester
POST
/STU3/ReferralRequest/$ers.createFromCommunicationRequestActionLater
POST
/STU3/ReferralRequest/{ubrn}/$ers.recordReviewOutcome
GET
/R4/PractitionerRole
POST
/STU3/ReferralRequest/{ubrn}/$ers.changeShortlist
POST
/STU3/ReferralRequest/{ubrn}/$ers.changeShortlistAndSendForTriage
GET
/R4/HealthcareService/{id}
HEAD
/R4/HealthcareService/{id}
PUT
/STU3/Appointment/{id}
GET
/STU3/Appointment/{id}
GET
/STU3/Appointment/{id}/_history/{version}
GET
/R4/HealthcareService
POST
/STU3/ReferralRequest/{ubrn}/$ers.cancelReferral
GET
/R4/Practitioner
POST
/STU3/CommunicationRequest/{ubrn}/$ers.generateCRI
POST
/STU3/CommunicationRequest/$ers.createAdviceAndGuidance
GET
/R4/ServiceRequest

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhs-e-referral-service-openapi.yaml Raw ↑

Other APIs NHS England publishes across the network.

Personal Demographics Service (PDS) - FHIR API
GP Connect Access Record - Structured - FHIR API
Electronic Prescription Service (EPS) - FHIR API
Booking and Referral Standard (BaRS) - FHIR API
Immunisation History - FHIR API
Organisation Data Service (ODS) - FHIR API
NHS App API
NHS Notify (Communications Manager) API
Service Search (Directory of Healthcare Services) API