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. 

97 results

Include retired APIs


A
Stable

Access Control Service HL7 V3 API

Manage patient consent to share their information, including their Summary Care Record (SCR), with the Access Control Service.

Access to records Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP HL7 V3 API service Central
Stable

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

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
Alpha

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
Stable

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
Alpha

Care Connect FHIR API standards

API standards using FHIR STU3 to create a unified approach to interoperability across England.

FHIR STU3 API standard
Stable

Cervical Screening - EDIFACT API

Receive cervical screening test results in GP practices and NHAIS from the screening system.

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

Child Protection - Information Sharing - HL7 V3 API

Access child protection information from Child Protection - Information Sharing (CP-IS) 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 MESH Has adaptor API service Central
Stable

Child Protection - Information Sharing - SMSP API standards

Become a Spine Mini Service Provider giving access to child protection information from Child Protection - Information Sharing (CP-IS) for an unscheduled care provider using our SMSP API standards.

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 API standard
Alpha

Clinical Decision Support API standards

API standards to support the triage and onward referral of patients who are interacting with Urgent and Emergency Care services, such as NHS 111.

Clinical decision support Hospital A&E / emergency department Patient GP / primary care Urgent and emergency care NHS 111 FHIR STU3 REST API standard
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

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
Alpha

Digital Maternity API standards

API standards to enable sharing and updating of digital maternity records.

Access to records Continuity of care Community health Hospital Maternity GP / primary care FHIR STU3 API standard
Private beta

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

Dose Syntax API standards

API standards to provide a structured way to record dosage instructions between primary and secondary care settings.

Continuity of care Prescribing Dispensing Community health Hospital GP / primary care FHIR STU3 API standard

E
Beta

Electronic Prescribing and Medicines Administration API standards

Use these API standards to share medication requests between ePMA systems and hospital pharmacy or stock control systems.

Prescribing Dispensing Hospital A&E / emergency department Inpatient GP / primary care Urgent and emergency care FHIR STU3 API standard
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 Internet facing FHIR R4 REST Has sandbox Uses API platform API service Central
Stable Under review

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

End of Life API standards

API standards to enable sharing and updating of digital end of life care (EoLC) records.

Access to records Community health Hospital GP / primary care Social care Urgent and emergency care Ambulance services NHS 111 FHIR STU3 API standard
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.

Referrals Hospital GP / primary care Internet facing FHIR STU3 Uses API platform API service Central
Stable

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
Beta

Eyecare Electronic Referral Service API standard

Pass details of a new eyecare referral to an Eyecare Electronic Referral System (EeRS).

Appointment / scheduling Referrals API standard

F
Beta

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
Beta

Female Genital Mutilation - Information Sharing - SMSP API standards

Become a Spine Mini Service Provider giving access to female genital mutilation (FGM) information for children under 18 to relevant NHS professionals across England, using our Female Genital Mutilation - Information Sharing (FGM-IS) SMSP API standards.

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

FHIR UK Core API standards

API standards using FHIR release 4 to create a unified approach to interoperability across England, Scotland, Wales and Northern Ireland.

FHIR R4 API standard

G
Stable Under review

Gazetteer Service - SOAP API

Validate and retrieve UK-based postal addresses.

Demographics Reference data SOAP API service Central
Stable

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
Stable

GP2GP - HL7 V3 API

Transfer patients' electronic health records, securely and quickly, between their old and new practices when they change GPs.

Continuity of care GP / primary care HL7 V3 Has adaptor API service Intermediary
Stable Under review

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
Beta

GP Connect Access Document - FHIR API

Retrieve unstructured documents from a patient’s GP practice record.

Access to records Continuity of care Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 FHIR STU3 REST API service Intermediary
Stable

GP Connect Access Record: HTML - FHIR API

View a patient's GP practice record, with read-only access.

Access to records Continuity of care Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 FHIR DSTU2 REST API service Intermediary
Beta

GP Connect Access Record: Structured - FHIR API

Retrieve structured information from a patient’s GP practice record.

Access to records Continuity of care Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 FHIR STU3 REST API service Intermediary
Beta

GP Connect Appointment Management - FHIR API

Manage GP practice appointments between different systems.

Appointment / scheduling Continuity of care Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 FHIR STU3 REST API service Intermediary
Stable

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

Interface Mechanism 1 API standards

API standards to support the integration of your systems with any principal clinical GP system using IM1.

Access to records Hospital A&E / emergency department Patient GP / primary care Urgent and emergency care API standard
Beta

Interoperability Toolkit 2 Messaging API standards

API standards for a set of messaging components using HL7 V2 and HL7 V3.

Messaging API standard
Stable

Interoperability Toolkit 3 Messaging Distribution FHIR API standards

API standards for a set of generic messaging components using FHIR STU3 to create a unified approach to NHS message and document flows across England. 

FHIR STU3 MESH API standard

L
Deprecated

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

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
Alpha

National Early Warning Score 2 API standards

API standards to enable sharing of patients' vital signs and NEWS2 scores between systems and across care boundaries, for example, between two hospitals.

Access to records Continuity of care Hospital A&E / emergency department Inpatient GP / primary care Urgent and emergency care Ambulance services FHIR STU3 API standard
Stable

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
Stable

Manage GP registrations and other patient data in NHAIS.

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

NHS 111 API standard

API standard to share information between NHS 111 and other organisations, such as GPs and ambulance services, and query the Repeat Caller Service.

Hospital A&E / emergency department GP / primary care Urgent and emergency care Ambulance services NHS 111 SOAP HL7 V3 Has adaptor API standard
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 Intermediary
Stable Under review

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

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
Alpha

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
Stable

Pathology Messaging - HL7 V3 API

Request laboratory tests and send the results back to the requester, usually the patient's GP or consultant.

Tests and diagnostics Hospital GP / primary care HL7 V3 Has adaptor API service Intermediary
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
Stable Under review

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
Stable

Personal Demographics Service Notifications - FHIR API

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

Personal Demographics Service - SMSP API standards

Become a Spine Mini Service Provider giving access to 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 standards.

Demographics Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API standard

Q
Stable Under review

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

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
Stable Under review

Spine Security Broker API

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

Access to records Security SOAP API service Central
Alpha

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
Stable

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
Stable

Summary Care Record - SMSP API standards

Become a Spine Mini Service Provider giving access to a patient's Summary Care Record using our SMSP API standards.

Access to records Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP HL7 V3 API standard

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
Stable

Transfer of Care Emergency Care Discharge

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

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

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
Stable

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
Stable

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

V
Stable

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
Stable

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
Stable

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