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

The communication API from NHS Digital — 4 operation(s) for communication.

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

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

4 operations 4 paths 0 schemas 2 GET2 POST

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

Paths & Operations 4

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

communication 4
POST
/communication/in-app/FHIR/R4/CommunicationRequest
Send an in-app message
create-in-app 2 params body → 201400401403429
POST
/communication/notification/FHIR/R4/CommunicationRequest
Send a push notification
create-notification 2 params body → 201400401403429
GET
/communication/report/receipts/FHIR/R4/Task
Get a daily receipt report
get-receipt-report 4 params → 200400401403429
GET
/communication/report/patients
Get details of NHS App users
get-patient-report 4 params → 200400401403404429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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