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

NHS Digital Referral API

The Referral API from NHS Digital — 2 operation(s) for referral.

NHS Digital Referral API is one of 23 APIs that NHS Digital publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Referral. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 3 base URLs: https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4, https://int.api.service.nhs.uk/booking-and-referral/FHIR/R4, https://api.service.nhs.uk/booking-and-referral/FHIR/R4.

2 operations 2 paths 7 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.service.nhs.uk/personal-demographics
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

NHS Digital Referral API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuth_Token). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Referral 2
GET
/ServiceRequest
Get referral/s for a patient
getReferralByPatient 9 params → 2004XX5XX
GET
/ServiceRequest/{id}
Get a specific referral
getReferral 8 params → 2004XX5XX

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

RequestingPractitionerToken
TargetIdentifier
SearchBundleRef
RequestingSoftwareToken
RequestingOrganisationToken
ServiceRequest
OperationalOutcome

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhs-digital-referral-api-openapi.yml Raw ↑

Other APIs NHS Digital publishes across the network.

Personal Demographics Service - FHIR API
Electronic Prescription Service - FHIR API
Summary Care Record - FHIR API
National Record Locator - FHIR API
Booking and Referral - FHIR API
GP Connect Appointment Management - FHIR API
e-Referral Service - FHIR API
Immunisation History - FHIR API
NHS App API
Directory of Healthcare Services (Service Search) API
NHS Login API
Spine Directory Service - FHIR API