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

Filters

Reset filters
Back to top

Search A-Z

Filters

Reset filters
Back to top
39 results

Include retired APIs

A
Stable

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 Internet facing FHIR R4 MESH Has sandbox Uses API platform API service Central
C
Stable Internal use only

COVID-19 Medical Exemptions - FHIR API

Access a patient’s coronavirus (COVID-19) medical exemption status.

Vaccination Patient Internet facing FHIR R4 REST Has sandbox Uses API platform API service Central
Private beta

COVID-19 Test Results - FHIR API

Access a patient’s coronavirus (COVID-19) test results history.

Tests and diagnostics Patient Internet facing FHIR R4 REST Has sandbox Uses API platform API service Central
Beta

Cyber Alerts - REST API

Access a feed of alerts issued by our cyber security centre.

Information governance Security Internet facing REST API service Central
D
Beta Under review

Data Registers Service - REST API

Access a wide range of live lists of lookup data with our Data Registers Service.

Reference data Internet facing REST API service Central
Stable

Demographics Batch Service API

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 Internet facing API service Central
Stable

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 Internet facing REST API service Central
Stable

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 Internet facing SOAP API service Central
E
Stable Under review

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 Internet facing REST API service Central
Beta

Electronic Prescription Service - FHIR API

Access the Electronic Prescription Service (EPS) - the national service used to send electronic prescriptions from GP surgeries to pharmacies.

Prescribing Dispensing Outpatient GP / primary care Internet facing FHIR R4 REST Has sandbox Uses API platform API service Central
Beta

Electronic Prescription Service Tracker - REST API

Track a patient’s prescriptions using our Electronic Prescription Service (EPS) Tracker API.

Prescribing Pharmacy Internet facing REST API service Central
Stable Under review

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 Internet facing SOAP API service Central
Beta

e-Referral Service - FHIR API

Access the e-Referral Service (e-RS) - the national service for creating and managing paperless referrals in primary and secondary care.

Appointment / scheduling Referrals Hospital GP / primary care Internet facing FHIR STU3 Has sandbox Uses API platform API service Central
F
Alpha

FHIR Converter API

Convert FHIR resources from FHIR STU3 to FHIR R4 and vice versa.

Internet facing FHIR STU3 R4 REST Uses API platform API service Central
G
Alpha

GP Registrations Management Information API

Send real-time management information about GP registrations to us at NHS Digital.

Continuity of care GP / primary care Internet facing REST Uses API platform API service Central
H
Alpha

Health Research Data Catalogue API

Retrieve information suitable for publication in a health research data catalogue.

Access to records Key care information Internet facing REST Has sandbox Uses API platform API service Central
Beta

Hello World API

Teach yourself how to connect to our RESTful APIs.

Internet facing REST Has sandbox Uses API platform API service Central
I
Private beta

Immunisation History - FHIR API

Access a patient’s coronavirus (COVID-19) immunisation history.

Vaccination Patient Internet facing FHIR R4 REST Has sandbox Uses API platform API service Central
M
Stable

Message Exchange for Social Care and Health (MESH) API

Transfer messages and large files securely across health and social care organisations using the Message Exchange for Social Care and Health (MESH) API.

Messaging Transport / infrastructure Internet facing MESH API service Central
N
Beta Internal use only

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 Internet facing FHIR STU3 REST API service Central
Stable

National Event Management Service - FHIR API

Publish and subscribe to patient-centric healthcare event messages with the National Events Management Service (NEMS) FHIR API. This national service is implemented on the NHS Spine. 

Continuity of care Messaging Transport / infrastructure Internet facing FHIR STU3 MESH NEMS API service Central
Beta

National Record Locator - FHIR API

Locate and access patient information shared by other healthcare organisations using the National Record Locator (NRL) FHIR API.

Access to records Transport / infrastructure Internet facing FHIR STU3 API service Central
Private beta

NHS App API

Engage with users of the NHS App.

Patient communication Hospital Patient GP / primary care Internet facing FHIR R4 REST Uses API platform API service Central
Stable

NHS CIS2 Care Identity Authentication - API

Verify the identity of healthcare workers in England, such as NHS staff, when they access national clinical information systems, using the NHS Care Identity Service 2 (CIS2). 

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

NHS login API

Access multiple digital health and social care services with a single login for patients and the public.

Security Patient Internet facing API service Central
Stable

NHSmail APIs

Integrate with NHSmail using these native Microsoft Exchange APIs.

Messaging Transport / infrastructure Internet facing REST API service Central
Stable

NHS Syndicated Content - REST APIs

Pull content from the NHS.UK website about health conditions, health news, medicines A-Z and more, using our free NHS Syndicated Content APIs and widgets.

Patient Internet facing REST API service Central
O
Stable

Ordnance Survey Places API

Identify UK addresses with the OS Places API. 

Demographics Reference data Internet facing REST API service Central Ordnance Survey
Stable

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 Internet facing FHIR STU3 API service Central
Stable

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 Internet facing REST SOAP API service Central
P
Stable

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 Internet facing FHIR R4 Has sandbox Uses API platform API service Central
R
Alpha

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 Internet facing FHIR STU3 REST Has sandbox Uses API platform API service Central
S
Stable

Service Search API

Access the information about NHS services, including searching for and getting a lists of coronavirus (COVID 19) walk-in sites, organisation types and organisations.

Vaccination Reference data Patient Internet facing REST API service Central
Alpha

Signing Service API

Generate an electronic signature using your smartcard.

Prescribing Security Outpatient Internet facing REST Uses API platform API service Central
Private beta

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 Internet facing FHIR R4 Has sandbox Uses API platform API service Central
Alpha

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 Internet facing FHIR R4 REST Has sandbox Uses API platform API service Central
T
Stable

Technology Reference Update Distribution API

Automate the download of TRUD release files, including classification products, NHS data model and dictionary, and terminology products.

Reference data Internet facing REST API service Central
Stable

Terminology Server - FHIR APIs

Retrieve terminologies and classifications from the NHS Digital Terminology Server, such as SNOMED-CT or ICD-10.

Reference data Internet facing FHIR R4 REST API service Central
U
Stable

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 Internet facing REST API service Central