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

85 results

Include deprecated and 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 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 R4 MESH Has sandbox API Service Central

Ambulance Messaging - HL7 V3 API

Ambulance Messaging supports the Ambulance Service Summary Patient Report containing a summary of care events and care data.

Appointment / Scheduling Urgent And Emergency Care Ambulance Services HL7 V3 API Service Intermediary Retired

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 (ToC) Hospital Inpatient Social Care FHIR DSTU2 MESH API Service Intermediary

B

Bowel Cancer Screening - EDIFACT API

Send bowel cancer screening test results from the screening system to GP practices.

Tests and Diagnostics Hospital GP / Primary Care MESH Has adaptor API Service Intermediary

C

Care Connect FHIR API standards

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

FHIR STU3 API Standard

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 A&E / Emergency Department OOH GP HL7 V3 Has adaptor API Service Central

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 A&E / Emergency Department FHIR STU3 REST API Standard

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

Digital Child Health - FHIR API

Share information about a child's health between healthcare professionals.

Continuity of Care (ToC) Hospital A&E / Emergency Department Inpatient Mental Health GP / Primary Care Urgent And Emergency Care A&E / Emergency Department FHIR STU3 MESH NEMS API Service Intermediary

Digital Maternity API standards

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

Access to Records Continuity of Care (ToC) Community health Hospital Maternity GP / Primary Care FHIR STU3 API Standard

Digital Medicine - FHIR API

Notify a patient's registered GP practice of care services provided by a pharmacy, such as immunisation.

Continuity of Care (ToC) Vaccination Pharmacy GP / Primary Care FHIR STU3 MESH API Service Intermediary

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.

Reference Data Patient GP / Primary Care Urgent And Emergency Care NHS 111 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.

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

Discharge - HL7 V3 API

Send a discharge report following transfer of responsibility for a patient.

Continuity of Care (ToC) Hospital Inpatient GP / Primary Care HL7 V3 API Service Intermediary Retired

Dose Syntax API standards

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

Continuity of Care (ToC) Prescribing Dispensing Community health Hospital GP / Primary Care FHIR STU3 API Standard

E

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 A&E / Emergency Department FHIR STU3 API Standard

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 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 A&E / Emergency Department OOH GP HL7 V3 Has adaptor API Service Central

Electronic Prescription Service Tracker - REST API

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

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

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

Emergency Department - HL7 V3 API

Send an emergency department report following discharge or transfer of responsibility for a patient.

Continuity of Care (ToC) Hospital A&E / Emergency Department GP / Primary Care Urgent And Emergency Care A&E / Emergency Department HL7 V3 API Service Intermediary Retired

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

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

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.

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

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 (ToC) GP / Primary Care HL7 V3 Has adaptor API Service Intermediary

GP Connect Access Document - FHIR API

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

Access to Records Continuity of Care (ToC) Hospital A&E / Emergency Department Inpatient Outpatient GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department FHIR STU3 REST API Service Intermediary

GP Connect Access Record: HTML - FHIR API

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

Access to Records Continuity of Care (ToC) Hospital A&E / Emergency Department Inpatient Outpatient GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department FHIR DSTU2 REST API Service Intermediary

GP Connect Access Record: Structured - FHIR API

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

Access to Records Continuity of Care (ToC) Hospital A&E / Emergency Department Inpatient Outpatient GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department FHIR STU3 REST API Service Intermediary

GP Connect Appointment Management - FHIR API

Manage GP practice appointments between different systems.

Appointment / Scheduling Continuity of Care (ToC) Hospital A&E / Emergency Department Inpatient Outpatient GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department FHIR STU3 REST API Service Intermediary

GP Connect Send Document - FHIR API

Send a PDF consultation summary to a registered GP practice.

Continuity of Care (ToC) Hospital A&E / Emergency Department Inpatient Outpatient GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 A&E / Emergency Department FHIR STU3 MESH API Service Intermediary

H

Hello World API

Teach yourself how to connect to our RESTful APIs.

REST Has sandbox

I

Immunisation History - FHIR API

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

Vaccination Patient FHIR R4 REST Has sandbox API Service Central

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

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

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

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

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 (ToC) Hospital A&E / Emergency Department Inpatient GP / Primary Care Urgent And Emergency Care Ambulance Services A&E / Emergency Department FHIR STU3 API Standard

National Event Management Service - FHIR API

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

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

Manage GP registrations and other patient data in NHAIS.

Demographics GP / Primary Care MESH Has adaptor API Service Intermediary

National Population Failsafe Management - FHIR API

Raise failsafe alerts about children with the National Population Failsafe Management (NPFM) FHIR API.

Continuity of Care (ToC) Key Care Information Hospital A&E / Emergency Department Inpatient Mental Health GP / Primary Care Urgent And Emergency Care A&E / Emergency Department FHIR API Service Intermediary Retired

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 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 A&E / Emergency Department SOAP HL7 V3 Has adaptor API Standard

NHS App API

Engage with users of the NHS App.

Patient Communication Hospital Patient GP / Primary Care FHIR R4 REST 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 FHIR STU3 API Service Intermediary

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 details of health and social care organisations, 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 A&E / Emergency Department OOH GP FHIR STU3 API Service Central

Organisation Data Service - ORD API

Access details of health and social care organisations, 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 A&E / Emergency Department OOH GP REST SOAP API Service Central

Outpatients - HL7 V3 API

Access an outpatient report.

Continuity of Care (ToC) Hospital Outpatient GP / Primary Care HL7 V3 API Service Intermediary Retired

P

Pathology Messaging - EDIFACT API

Send pathology test results from laboratories to GP practices.

Tests and Diagnostics Hospital GP / Primary Care MESH Has adaptor API Service Intermediary

Pathology Messaging - FHIR API

Share pathology results in NHS primary and secondary care settings.

Tests and Diagnostics Hospital GP / Primary Care FHIR STU3 MESH API Service Intermediary

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

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 Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP FHIR R4 Has 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.

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

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 (ToC) Demographics Hospital A&E / Emergency Department Inpatient Mental Health GP / Primary Care Urgent And Emergency Care A&E / Emergency Department FHIR STU3 MESH NEMS API Service Intermediary

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

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 (ToC) Hospital A&E / Emergency Department GP / Primary Care Urgent And Emergency Care A&E / Emergency Department 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 (ToC) Hospital Inpatient GP / Primary Care 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 (ToC) Hospital Mental Health GP / Primary Care 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 (ToC) Hospital Outpatient GP / Primary Care 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 (ToC) Urgent And Emergency Care NHS 111 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 MESH API Service Intermediary

Vaccination APIs

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

Appointment / Scheduling Vaccination Community health GP / Primary Care MESH API Service Intermediary

Vaccination Events - FHIR API

Send and receive messages about changes to a patient's vaccination details.

Continuity of Care (ToC) Vaccination Community health Hospital Inpatient Outpatient GP / Primary Care FHIR STU3 MESH NEMS API Service Intermediary