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

47 results

Include retired APIs


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.

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

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 FHIR R4 MESH Has sandbox Uses API platform API Service Central

C

Child Protection - Information Sharing - HL7 V3 API

Access child protection information from Child Protection - Information Sharing (CP-IS) as a local authority or an unscheduled care provider using our HL7 V3 API.

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

COVID-19 Medical Exemptions - FHIR API

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

Vaccination Patient FHIR R4 REST Has sandbox Uses API platform API Service Central

COVID-19 Test Results - FHIR API

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

Tests and Diagnostics Patient FHIR R4 REST Has sandbox Uses API platform 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).

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

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

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 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.

Prescribing Dispensing Reference Data Urgent And Emergency Care OOH GP 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.

Prescribing Dispensing Outpatient FHIR R4 REST Has sandbox Uses API platform 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.

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

Electronic Prescription Service Tracker - REST API

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

Prescribing Pharmacy REST API Service Central

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 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.

Referrals Hospital GP / Primary Care FHIR STU3 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.

Appointment / Scheduling Referrals Hospital HL7 V3 Has adaptor 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.

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

FHIR Converter API

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

FHIR STU3 R4 REST Uses API platform API Service Central

G

Gazetteer Service - SOAP API

Validate and retrieve UK-based postal addresses.

Demographics Reference Data SOAP API Service Central
Retired

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.

Access to Records Key Care Information Community health SOAP HL7 V3 Has adaptor 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.

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

I

Immunisation History - FHIR API

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

Vaccination Patient FHIR R4 REST Has sandbox Uses API platform API Service Central

L

Legitimate Relationship Service - HL7 V3 API

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

Access to Records Information Governance Hospital HL7 V3 Has adaptor API Service Central

M

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 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.

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

National Event Management Service - FHIR API

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

Continuity of Care (ToC) Messaging Transport / Infrastructure FHIR STU3 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.

Access to Records Transport / Infrastructure FHIR STU3 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.

Security Hospital GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 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.

Security Patient 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 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 FHIR STU3 API Service Central

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 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.

Demographics Community health Hospital Mental Health Patient Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP FHIR R4 Has sandbox Uses API platform 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.

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

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 Spine Mini Service Provider (SMSP) API.

Demographics Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP 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.

Reference Data Hospital GP / Primary Care 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.

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

S

Signing Service API

Generate an electronic signature using your smartcard.

Prescribing Security Outpatient 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.

Reference Data Hospital GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 FHIR R4 Has sandbox Uses API platform 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.

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

Spine Security Broker API

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

Access to Records Security SOAP 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.

Access to Records Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP FHIR R4 REST Has sandbox Uses API platform 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.

Access to Records Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP HL7 V3 Has adaptor 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 R4 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.

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