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

The R4 API from NHS API — 6 operation(s) for r4.

NHS API R4 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 R4. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 6 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.

7 operations 6 paths 0 schemas 6 GET1 HEAD

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 R4 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 7

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

R4 7
GET
/R4/Binary/{id}
GET
/R4/PractitionerRole
GET
/R4/HealthcareService/{id}
HEAD
/R4/HealthcareService/{id}
GET
/R4/HealthcareService
GET
/R4/Practitioner
GET
/R4/ServiceRequest

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhs-api-r4-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 STU3 API
NHS API ValueSet API