How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NHS England STU3 API

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

NHS England STU3 API is one of 25 APIs that NHS England 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 and API documentation.

This API exposes 33 operations across 32 paths. It is described by OpenAPI 3.2.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.

33 operations 32 paths 0 schemas 11 GET21 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.1
Base URL
https://api.service.nhs.uk/personal-demographics/FHIR/R4
Authentication
HTTP Bearer
License
MIT
Resource Areas
1

Authentication & Security 1

NHS England STU3 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

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}
Get stu3 code system by code system type
getSTU3CodeSystemByCodeSystemType
POST
/STU3/ReferralRequest/$ers.fetchworklist
Create stu3 referral request $ers fetchworklist
postSTU3ReferralRequest$ersFetchworklist
GET
/STU3/ReferralRequest/{ubrn}
Get stu3 referral request by ubrn
getSTU3ReferralRequestByUbrn
GET
/STU3/Task
Get stu3 task
getSTU3Task
GET
/STU3/ReferralRequest/{ubrn}/_history/{version}
Get stu3 referral request by ubrn history by version
getSTU3ReferralRequestByUbrnHistoryByVersion
GET
/STU3/Binary/{attachmentLogicalID}
Get stu3 binary by attachment logical id
getSTU3BinaryByAttachmentLogicalID
POST
/STU3/ReferralRequest/{ubrn}/$ers.generateCRI
Create stu3 referral request by ubrn $ers generate cri
postSTU3ReferralRequestByUbrn$ersGenerateCRI
POST
/STU3/HealthcareService/$ers.searchHealthcareServicesForPatient
Create stu3 healthcare service $ers search healthcare services for patient
postSTU3HealthcareService$ersSearchHealthcareServicesForPatient
POST
/STU3/ReferralRequest/$ers.createReferral
Create stu3 referral request $ers create referral
postSTU3ReferralRequest$ersCreateReferral
POST
/STU3/ReferralRequest/$ers.createReferralAndSendForTriage
Create stu3 referral request $ers create referral and send for triage
postSTU3ReferralRequest$ersCreateReferralAndSendForTriage
GET
/STU3/Slot
Get stu3 slot
getSTU3Slot
POST
/STU3/Appointment
Create stu3 appointment
postSTU3Appointment
POST
/STU3/Binary
Create stu3 binary
postSTU3Binary
POST
/STU3/ReferralRequest/{ubrn}/$ers.maintainReferralLetter
Create stu3 referral request by ubrn $ers maintain referral letter
postSTU3ReferralRequestByUbrn$ersMaintainReferralLetter
POST
/STU3/ReferralRequest/{ubrn}/$ers.acceptReferral
Create stu3 referral request by ubrn $ers accept referral
postSTU3ReferralRequestByUbrn$ersAcceptReferral
POST
/STU3/ReferralRequest/{ubrn}/$ers.rejectReferral
Create stu3 referral request by ubrn $ers reject referral
postSTU3ReferralRequestByUbrn$ersRejectReferral
POST
/STU3/ReferralRequest/{ubrn}/$ers.generatePatientLetter
Create stu3 referral request by ubrn $ers generate patient letter
postSTU3ReferralRequestByUbrn$ersGeneratePatientLetter
POST
/STU3/ReferralRequest/{ubrn}/$ers.cancelAppointmentActionLater
Create stu3 referral request by ubrn $ers cancel appointment action later
postSTU3ReferralRequestByUbrn$ersCancelAppointmentActionLater
POST
/STU3/CommunicationRequest/$ers.fetchworklist
Create stu3 communication request $ers fetchworklist
postSTU3CommunicationRequest$ersFetchworklist
GET
/STU3/CommunicationRequest/{ubrn}
Get stu3 communication request by ubrn
getSTU3CommunicationRequestByUbrn
GET
/STU3/CommunicationRequest/{ubrn}/_history/{version}
Get stu3 communication request by ubrn history by version
getSTU3CommunicationRequestByUbrnHistoryByVersion
GET
/STU3/Communication
Get stu3 communication
getSTU3Communication
POST
/STU3/CommunicationRequest/{ubrn}/$ers.sendCommunicationToRequester
Create stu3 communication request by ubrn $ers send communication to requester
postSTU3CommunicationRequestByUbrn$ersSendCommunicationToRequester
POST
/STU3/ReferralRequest/$ers.createFromCommunicationRequestActionLater
Create stu3 referral request $ers create from communication request action later
postSTU3ReferralRequest$ersCreateFromCommunicationRequestActionLater
POST
/STU3/ReferralRequest/{ubrn}/$ers.recordReviewOutcome
Create stu3 referral request by ubrn $ers record review outcome
postSTU3ReferralRequestByUbrn$ersRecordReviewOutcome
POST
/STU3/ReferralRequest/{ubrn}/$ers.changeShortlist
Create stu3 referral request by ubrn $ers change shortlist
postSTU3ReferralRequestByUbrn$ersChangeShortlist
POST
/STU3/ReferralRequest/{ubrn}/$ers.changeShortlistAndSendForTriage
Create stu3 referral request by ubrn $ers change shortlist and send for triage
postSTU3ReferralRequestByUbrn$ersChangeShortlistAndSendForTriage
PUT
/STU3/Appointment/{id}
Replace stu3 appointment by id
putSTU3AppointmentById
GET
/STU3/Appointment/{id}
Get stu3 appointment by id
getSTU3AppointmentById
GET
/STU3/Appointment/{id}/_history/{version}
Get stu3 appointment by id history by version
getSTU3AppointmentByIdHistoryByVersion
POST
/STU3/ReferralRequest/{ubrn}/$ers.cancelReferral
Create stu3 referral request by ubrn $ers cancel referral
postSTU3ReferralRequestByUbrn$ersCancelReferral
POST
/STU3/CommunicationRequest/{ubrn}/$ers.generateCRI
Create stu3 communication request by ubrn $ers generate cri
postSTU3CommunicationRequestByUbrn$ersGenerateCRI
POST
/STU3/CommunicationRequest/$ers.createAdviceAndGuidance
Create stu3 communication request $ers create advice and guidance
postSTU3CommunicationRequest$ersCreateAdviceAndGuidance

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhs-england-stu3-api-openapi.yml 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
NHS England Booking API
NHS England Callbacks API
NHS England Channels API
NHS England Code System API
NHS England Communication API
NHS England Immunization API
NHS England List{id} API
NHS England Message API
NHS England Message Batches API
Where this information came from

This is an independent, third-party profile of NHS England STU3 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.