Skip to main content

API catalogue

First time here? Check out Getting Started with our APIs.

These are the APIs which are currently available, or in development, from NHS Digital and associated organisations. It includes API services as well as API standards defined by us. 

Search A-Z

23 results
A
In production

Ambulance Data Submission - FHIR API

Submit ambulance data to our Data Processing Service (DPS) for analysis and review by NHS England and ambulance trusts, using our Ambulance Data Submission - FHIR API (formerly Ambulance Analytics).

Urgent and emergency care Ambulance services API Central Internet facing FHIR R4 REST MESH Has sandbox Uses API platform Uses OAS

D
In production

Demographics Batch Service

Submit a file of patient information to the Spine for tracing against the Personal Demographics Service (PDS).

Demographics Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Central Message integration Internet facing
In production

Digital Child Health - FHIR

Share information about a child's health between healthcare workers.

Continuity of care Hospital A&E / emergency department Inpatient Mental health GP / primary care Urgent and emergency care Publish-subscribe events Internet facing FHIR STU3 MESH NEMS
In production

Directory of Services - Urgent and Emergency Care - REST API

Access information on a wide range of health and care services across England using our Directory of Services Urgent and Emergency Care REST API.

Reference data Patient GP / primary care Urgent and emergency care NHS 111 API Central Internet facing REST
In production

Directory of Services - Urgent and Emergency Care - SOAP API

Access information on a wide range of health and care services across England using our Directory of Services Urgent and Emergency Care SOAP API.

Reference data Patient GP / primary care Urgent and emergency care NHS 111 API Central Internet facing SOAP

E
In production Under review for deprecation

Electronic Prescription Service Directory of Services API

Access information about dispensing services, including searching for dispensers who can provide dispensing services for a patient with a given location and urgency, using our Electronic Prescription Service (EPS) Directory of Services (DoS) API.

Prescribing Dispensing Reference data Urgent and emergency care OOH GP API Central Internet facing REST
Retired

Electronic Transmission of Prescriptions Web Services - REST API

Get prescription dispenser information for a patient, using NHS UK Web Services.

Access to records Dispensing Reference data Community health Pharmacy GP / primary care Urgent and emergency care OOH GP API Central Internet facing REST
In production Under review for deprecation

Electronic Transmission of Prescriptions Web Services - SOAP API

Get prescription dispenser information for a patient, using NHS UK Web Services.

Access to records Dispensing Reference data Community health Pharmacy GP / primary care Urgent and emergency care OOH GP API Central Internet facing SOAP

G
In production

GP Connect Send Document - FHIR

Send a PDF consultation summary to a registered GP practice.

Continuity of care Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 Message integration Internet facing FHIR STU3 MESH

N
Beta In production Internal

National Data Opt-out - FHIR API

Capture patients' preferences and control sharing of their data by healthcare organisations for planning and research purposes with our National Data Opt-out (NDOP) FHIR API.

Access to records Information governance Community health Hospital A&E / emergency department Inpatient Outpatient Mental health GP / primary care Social care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central Internet facing FHIR STU3 REST
Retired

National Population Failsafe Management - FHIR API

Raise failsafe alerts about children with the National Population Failsafe Management (NPFM) FHIR API.

Continuity of care Key care information Hospital A&E / emergency department Inpatient Mental health GP / primary care Urgent and emergency care API Intermediary Internet facing FHIR
In production Deprecated

NHS Booking - FHIR API

Search for free slots and book appointments with this API formerly known as FHIR NHS Scheduling API

Appointment / scheduling Urgent and emergency care NHS 111 API Intermediary Internet facing FHIR STU3
In production

NHS CIS2 Care Identity Authentication API

Verify the identity of healthcare workers in England, such as NHS staff, using the NHS Care Identity Service 2 (CIS2). CIS2 provides single sign-on across local and national digital services using smartcards or modern alternatives.

Security Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 API Central Internet facing

O
In production

Organisation Data Service - FHIR API

Access a reduced dataset of health and social care organisations in England and Wales, such as trusts or GP practices, using our Organisation Data Service (ODS) FHIR API.

Reference data Community health Dentistry Hospital A&E / emergency department Inpatient Outpatient Mental health Pharmacy GP / primary care Social care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central Internet facing FHIR STU3
In production

Organisation Data Service - ORD API

Access the full dataset of health and social care organisations in England and Wales, such as trusts or GP practices, using our Organisation Data Service (ODS) ORD API.

Reference data Community health Dentistry Hospital A&E / emergency department Inpatient Outpatient Mental health Pharmacy GP / primary care Social care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central Internet facing REST SOAP
In production Deprecated

Out Of Hours

Send details of an out of hours (OOH) assessment from an out of hours GP system to the patient's registered GP.

Continuity of care GP / primary care Urgent and emergency care NHS 111 Message integration Internet facing MESH

P
In production

Personal Demographics Service - FHIR API

Access patients' personal information, such as name, address, date of birth, related people, registered GP and NHS number using our FHIR version of the Personal Demographics Service (PDS) API.

Demographics Community health Hospital Mental health Patient Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS
In production

Personal Demographics Service Notifications - FHIR

Receive notifications about changes to a patient's demographic details, including record change, birth, death, change of address and change of GP.

Continuity of care Demographics Hospital A&E / emergency department Inpatient Mental health GP / primary care Urgent and emergency care Publish-subscribe events Internet facing FHIR STU3 MESH NEMS

R
In development

Reasonable Adjustment Flag - FHIR API

Access the Reasonable Adjustment Flag - a national record which indicates that a patient requires reasonable adjustments and includes relevant details.

Key care information Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central Internet facing FHIR STU3 REST Has sandbox Uses API platform Uses OAS

S
Beta In production

Spine Directory Service - FHIR API

Access accredited system information and messaging endpoint details in the Spine Directory Service (SDS) using our FHIR-conformant API.

Reference data Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS
In development

Summary Care Record - FHIR API

Access a patient's Summary Care Record (SCR), an electronic record of important patient information, using our FHIR API.

Access to records Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS

T
In production

Transfer of Care Emergency Care Discharge - FHIR

Send discharge information from an emergency care provider to a GP practice.

Continuity of care Hospital A&E / emergency department GP / primary care Urgent and emergency care Message integration Internet facing FHIR STU3 MESH

U
In production

Urgent and Emergency Care Continuous Quality Improvement API

Submit 111 or 999 call triage data for quality monitoring purposes, following an NHS Pathways patient phone assessment.

Continuity of care Urgent and emergency care NHS 111 API Central Internet facing REST