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 STU3 API

The STU3 API from NHS Digital — 32 operation(s) for stu3.

NHS Digital STU3 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 STU3. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 33 operations across 32 paths. 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.

33 operations 32 paths 0 schemas 11 GET21 POST1 PUT

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 STU3 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuth_Token). By default, every request must be authenticated.

Paths & Operations 33

Across 32 paths, the API surfaces 33 operations — 11 GET, 21 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

STU3 33
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}
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
POST
/STU3/ReferralRequest/{ubrn}/$ers.changeShortlist
POST
/STU3/ReferralRequest/{ubrn}/$ers.changeShortlistAndSendForTriage
PUT
/STU3/Appointment/{id}
GET
/STU3/Appointment/{id}
GET
/STU3/Appointment/{id}/_history/{version}
POST
/STU3/ReferralRequest/{ubrn}/$ers.cancelReferral
POST
/STU3/CommunicationRequest/{ubrn}/$ers.generateCRI
POST
/STU3/CommunicationRequest/$ers.createAdviceAndGuidance

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhs-digital-stu3-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