Skip to main content

API catalogue

First time here? Check out Getting Started with NHS Digital APIs.

These are the APIs which are currently available, or in development, from NHS Digital. It includes API standards defined by us. If you're looking for other standards or reference materials, try our Developer A-Z

A

Alerts - HL7 V3 API

Send an alert to a Privacy Officer so they can audit whether access to a patient’s data was appropriate.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Information Governance HL7 V3 API Service Central

Ambulance Analytics - FHIR API

Submit ambulance analytics data to our Data Processing Service (DPS) for analysis and review by NHS England and ambulance trusts.

Urgent And Emergency Care Ambulance Services FHIR MESH Sandbox API Service Central

C

Child Protection - Information Sharing - HL7 V3 API

Access child protection information from Child Protection - Information Sharing (CP-IS) using our HL7 V3 API.

Community health Hospital A&E / Emergency Department Inpatient Social Care Urgent And Emergency Care Ambulance Services A&E / Emergency Department OOH GP Access to Records Key Care Information HL7 V3 API Service Central

COVID-19 Test Results - FHIR API

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

Patient Tests and Diagnostics FHIR REST Sandbox API Service Central

Cyber Alerts - REST API

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

Information Governance Security REST API Service Central

D

Data Registers Service - REST API

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

Reference Data REST API Service Central

Demographics Batch Service API

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

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Demographics API Service Central

Directory of Services - REST API

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

Patient GP / Primary Care Urgent And Emergency Care NHS 111 Reference Data REST API Service Central

Directory of Services - SOAP API

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

Patient GP / Primary Care Urgent And Emergency Care NHS 111 Reference Data SOAP API Service Central

E

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.

Urgent And Emergency Care OOH GP Prescribing Dispensing Reference Data REST API Service Central

Electronic Prescription Service - FHIR API

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

Outpatient Prescribing Dispensing FHIR REST Sandbox API Service Central

Electronic Prescription Service - HL7 V3 API

Access the Electronic Prescription Service (EPS) to send prescriptions from prescribers such as GPs to dispensers such as pharmacies using our HL7 V3 API.

Community health A&E / Emergency Department GP / Primary Care Urgent And Emergency Care A&E / Emergency Department OOH GP Prescribing Dispensing HL7 V3 API Service Central

Electronic Prescription Service Tracker - REST API

Track a patient’s prescriptions within the Electronic Prescription Service (EPS).

Pharmacy Prescribing REST API Service Central

Electronic Transmission of Prescriptions Web Services - SOAP API

Access the NHS UK Web Services to retrieve dispensaries information for a patient

Community health Pharmacy GP / Primary Care Urgent And Emergency Care OOH GP Access to Records Dispensing Reference Data SOAP API Service Central

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.

Hospital GP / Primary Care Referrals FHIR API Service Central

e-Referral Service - HL7 V3 API

Create paperless referrals or manage appointment slots in secondary care using the e-Referral Service (e-RS) HL7 V3 API.

Hospital Appointment / Scheduling Referrals HL7 V3 API Service Central

F

Female Genital Mutilation - Information Sharing - FHIR API

Share female genital mutilation (FGM) information for children under 18 with relevant NHS professionals across England using our Female Genital Mutilation (FGM) Information Sharing FHIR API.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Key Care Information FHIR API Service Central

G

Gazetteer Service - SOAP API

Validate and retrieve UK-based postal addresses.

Demographics Reference Data SOAP API Service Central

General Practice Extraction Service - HL7 V3 API

Send anonymised or patient-identifiable data from GP clinical systems to the General Practice Extraction Service (GPES) for planning and research.

Community health Access to Records Key Care Information SOAP HL7 V3 API Service Central

General Practice Extraction Service - MESH API

Send anonymised or patient-identifiable data from GP clinical systems to the General Practice Extraction Service (GPES) for planning and research.

Community health Access to Records Key Care Information MESH API Service Central

I

Immunisation History - FHIR API

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

Patient Vaccination FHIR REST Sandbox API Service Central

L

Legitimate Relationship Service - HL7 V3 API

Access patients' Legitimate Relationships (LR) using our HL7 V3 API.

Hospital Access to Records Information Governance HL7 V3 API Service Central

M

Message Exchange for Social Care and Health (MESH) API

The Message Exchange for Social Care and Health (MESH) is the main secure large file transfer service used across health and social care organisations.

Transport / Infrastructure Messaging MESH API Service Central Intermediary

N

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.

Community health Hospital A&E / Emergency Department Inpatient Outpatient Mental Health GP / Primary Care Social Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department OOH GP Access to Records Information Governance FHIR REST API Service Central

National Event Management Service - FHIR API

Publish and subscribe to patient-centric event messages with the National Events Management Service (NEMS).

Transport / Infrastructure Continuity of Care (ToC) Messaging FHIR MESH NEMS API Service Central Intermediary

National Record Locator - FHIR API

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

Transport / Infrastructure Access to Records FHIR API Service Central

NHS Care Identity Service 2 API

Verify the identity of healthcare workers in England, such as NHS staff, when they access national clinical information systems.

Hospital GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 Security API Service Central

NHS login API

Access multiple digital health and social care services with a single login for patients and the public, including authentication for returning users.

Patient Security API Service Central

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 REST API Service Central

O

Organisation Data Service - FHIR API

Access details of health and social care organisations using our Organisation Data Service (ODS) FHIR API.

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 A&E / Emergency Department OOH GP Reference Data FHIR API Service Central

Organisation Data Service - ORD API

Access details of health and social care organisations using our Organisation Data Service (ODS) ORD API.

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 A&E / Emergency Department OOH GP Reference Data REST SOAP API Service Central

P

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.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Demographics FHIR Sandbox API Service Central

Personal Demographics Service - HL7 V3 API

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

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Demographics SOAP HL7 V3 API Service Central

Personal Demographics Service - SMSP API

Access patients' personal information, such as name, address, date of birth, related people, registered GP and NHS number using our SMSP API.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Demographics API Service Central

Q

Query Accredited System Information - SOAP API

Access details of accredited systems in the Spine Directory Service (SDS) using this SOAP API.

Hospital GP / Primary Care Reference Data SOAP API Service Central

R

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.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Key Care Information FHIR REST Sandbox API Service Central

S

Signing Service API

Generate an electronic signature using your smartcard.

Outpatient Prescribing Security REST API Service Central

Spine Directory Service - FHIR API

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

Hospital GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 Reference Data FHIR Sandbox API Service Central

Spine Directory Service - LDAP API

Access details of organisations, people and systems registered in the Spine Directory Service (SDS) using our LDAP API.

Hospital GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 Reference Data API Service Central

Spine Security Broker API

Provide single sign-on for healthcare workers using NHS smartcards.

Access to Records Security HL7 V3 API Service Central

Summary Care Record - FHIR API

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

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Access to Records FHIR REST Sandbox API Service Central

Summary Care Record - HL7 V3 API

Access a patient's Summary Care Record (SCR) using our HL7 V3 API. Also previously known as PSIS query and GP summary.

Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP Access to Records HL7 V3 API Service Central

T

Technology Reference Data Update Distribution API

Automate the download of TRUD release files.

Reference Data REST API Service Central

Terminology Server - FHIR API

Retrieve terminologies and classifications from the NHS Digital Terminology Server.

Reference Data FHIR REST API Service Central

U

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.

Urgent And Emergency Care NHS 111 Continuity of Care (ToC) REST API Service Central