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 services as well as API standards defined by us. 

58 results

Include retired APIs


A

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

Assessment Discharge and Withdrawal - FHIR API

Support transfer of care from hospital to social services for patients with care and support needs.

Continuity of care Hospital Inpatient Social care Internet facing FHIR DSTU2 MESH API service Intermediary

B

Booking and Referral - FHIR API

Send booking and referral information between NHS service providers using our Booking and Referral FHIR API.

Appointment / scheduling Referrals Access to records Continuity of care Patient communication A&E / emergency department Ambulance services NHS 111 Internet facing FHIR R4 REST Has sandbox Uses API platform API service Intermediary

Bowel Cancer Screening - EDIFACT API

Receive bowel cancer screening test results in GP practices from the screening system.

Tests and diagnostics Hospital GP / primary care Internet facing MESH Has adaptor API service Intermediary

C

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

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

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

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

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

Digital Child Health - FHIR API

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 Internet facing FHIR STU3 MESH NEMS API service Intermediary

Digital Medicine - FHIR API

Notify a patient's registered GP practice about care services delivered at a pharmacy, such as an immunisation.

Continuity of care Dispensing Vaccination Pharmacy GP / primary care Internet facing FHIR STU3 MESH API service Intermediary

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

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

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

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

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

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

F

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

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

GP2GP Management Information MESH API

Provide information to NHS Digital on the progress of the patient migration process between GP practices (GP2GP).

Continuity of care GP / primary care Internet facing REST MESH API service Central

GP Connect Send Document - FHIR API

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 Internet facing FHIR STU3 MESH API service Intermediary

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

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

Hello World API

Teach yourself how to connect to our RESTful APIs.

Internet facing REST Has sandbox Uses API platform API service Central

I

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

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 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 Internet facing 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 Messaging Transport / infrastructure Internet facing FHIR STU3 MESH NEMS API service Central Intermediary

Manage GP registrations and other patient data in NHAIS.

Demographics GP / primary care Internet facing MESH Has adaptor API service 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 Internet facing FHIR STU3 API service Central

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 Intermediary

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

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

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

P

Pathology Messaging - EDIFACT API

Receive pathology test results in GP practices from laboratories.

Tests and diagnostics Hospital GP / primary care Internet facing MESH Has adaptor API service Intermediary

Pathology Messaging - FHIR API

Share pathology results from a Laboratory Information Management System (LIMS) to the requestor in NHS primary or secondary care settings.

Tests and diagnostics Hospital GP / primary care Internet facing FHIR STU3 MESH API service Intermediary

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

Personal Demographics Service Notifications - FHIR API

Receive notifications about changes to a patient's demographic details, including 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 Internet facing FHIR STU3 MESH NEMS API service Intermediary

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

S

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

Signing Service API

Generate an electronic signature using your smartcard.

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

T

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

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

Transfer of Care Emergency Care Discharge - FHIR API

Create and transmit documents containing Transfer of Care information supporting an emergency care discharge.

Continuity of care Hospital A&E / emergency department GP / primary care Urgent and emergency care Internet facing FHIR STU3 MESH API service Intermediary

Transfer of Care Inpatient Discharge - FHIR API

Create and transmit documents containing Transfer of Care information supporting an inpatient discharge.

Continuity of care Hospital Inpatient GP / primary care Internet facing FHIR STU3 MESH API service Intermediary

Transfer of Care Mental Health Discharge - FHIR API

Create and transmit documents containing Transfer of Care information supporting a mental health discharge.

Continuity of care Hospital Mental health GP / primary care Internet facing FHIR STU3 MESH API service Intermediary

Transfer of Care Outpatient Clinic Letter - FHIR API

Create and transmit documents containing Transfer of Care information following an outpatient consultation in a clinic.

Continuity of care Hospital Outpatient GP / primary care Internet facing FHIR STU3 MESH API service Intermediary

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 Urgent and emergency care NHS 111 Internet facing REST API service Central

V

Vaccination Adverse Reactions COVID-19 API

Provide information to NHS Digital on adverse reactions relating to coronavirus (COVID-19) vaccinations.

Vaccination Community health GP / primary care Internet facing MESH API service Intermediary

Vaccination APIs

Provide information to NHS Digital relating to coronavirus (COVID-19) and seasonal flu 2021-22 vaccinations.

Vaccination Community health GP / primary care Internet facing MESH API service Intermediary

Vaccination Events - FHIR API

Publish or receive messages about changes to a patient's vaccination details.

Continuity of care Vaccination Community health Hospital Inpatient Outpatient GP / primary care Internet facing FHIR STU3 MESH NEMS API service Intermediary