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

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

NHS API STU3 API is one of 13 APIs that NHS API 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.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.

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
0.0.1
Base URL
https://api.service.nhs.uk/personal-demographics
Authentication
HTTP Bearer
License
MIT
Resource Areas
1

Authentication & Security 1

NHS API 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}
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-api-stu3-api-openapi.yml Raw ↑

Other APIs NHS API publishes across the network.

GP Connect Access Document - FHIR API
EPS Prescription Tracker - FHIR API
Booking and Referral - FHIR API
NHS Website Content API
Elective Waiting List API
NHS API CodeSystem API
NHS API List{id} API
NHS API Metadata API
NHS API Organization API
NHS API OrganizationAffiliation API
NHS API R4 API
NHS API ValueSet API