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

internal

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
internal

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
internal

Ambulance Messaging - HL7 V3 API

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

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

Assessment Discharge and Withdrawal - FHIR API

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

Hospital Inpatient Social Care Continuity of Care (ToC) FHIR MESH API Service Intermediary

B

internal

Bowel Cancer Screening - EDIFACT API

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

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

C

internal

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
internal

COVID-19 Test Results - FHIR API

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

Patient / Citizen Tests and Diagnostics FHIR REST Sandbox API Service Central
internal

Cyber Alerts - REST API

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

Information Governance Security REST API Service Central

D

internal

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
internal

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
internal

Digital Child Health - FHIR API

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

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

Digital Medicine - FHIR API

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

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

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 / Citizen GP / Primary Care Urgent And Emergency Care NHS 111 Reference Data REST API Service Central
internal

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 / Citizen GP / Primary Care Urgent And Emergency Care NHS 111 Reference Data SOAP API Service Central
internal

Discharge - HL7 V3 API

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

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

E

internal

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
internal

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
internal

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
internal

Electronic Prescription Service Tracker - REST API

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

Pharmacy Prescribing REST API Service Central
internal

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
internal

Emergency Department - HL7 V3 API

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

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

e-Referral Service - FHIR API

Create paperless referrals from primary to secondary care using the e-Referral Service (e-RS) FHIR API.

Hospital GP / Primary Care Appointment / Scheduling Referrals FHIR API Service Central
internal

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

internal

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

internal

Gazetteer Service - SOAP API

Validate and retrieve UK-based postal addresses.

Demographics Reference Data SOAP API Service Central
internal

General Practice Extraction Service - HL7 V3 API

Send anonymised or patient-identifiable data from GP clinical systems for planning and research.

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

GP2GP - HL7 V3 API

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

GP / Primary Care Continuity of Care (ToC) HL7 V3 API Service Intermediary
internal

GP Connect Access Document - FHIR API

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

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

GP Connect Access Record HTML - FHIR API

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

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

GP Connect Access Record Structured - FHIR API

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

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

GP Connect Appointment Management - FHIR API

Manage GP practice appointments between different systems.

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

GP Connect Send Document - FHIR API

Send a PDF consultation summary to a registered GP practice.

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

I

internal

Immunisation History - FHIR API

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

Patient / Citizen Vaccination FHIR REST Sandbox API Service Central

L

internal

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

internal

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

internal

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 MESH API Service Central
internal

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
internal

National Health Application and Infrastructure Services - NHAIS GP Links API

Manage GP registrations and other patient data in NHAIS.

GP / Primary Care Demographics MESH API Service Intermediary
internal

National Population Failsafe Management - FHIR API

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

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

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
internal

NHS App API

Engage with users of the NHS App.

Hospital Patient / Citizen GP / Primary Care Patient Communication REST API Service Intermediary
internal

NHS Booking - FHIR API

Search for free slots and book appointments with this API formerly known as FHIR NHS Scheduling API

Urgent And Emergency Care NHS 111 Appointment / Scheduling FHIR API Service Intermediary
internal

NHS Care Identity Service 2 API

Verify the identity of health and care professionals 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
internal

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 / Citizen Security API Service Central
internal

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

O

internal

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
internal

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
internal

Outpatients - HL7 V3 API

Access an outpatient report.

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

P

internal

Pathology Messaging - EDIFACT API

Send pathology test results from laboratories to GP practices.

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

Pathology Messaging - FHIR API

Share pathology results in NHS primary and secondary care settings.

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

Pathology Messaging - HL7 V3 API

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

Hospital GP / Primary Care Tests and Diagnostics HL7 V3 API Service Intermediary
internal

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
internal

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
internal

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.

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

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

internal

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

internal

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

internal

Signing Service API

Generate an electronic signature using your smartcard.

Outpatient Prescribing Security REST API Service Central
internal

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
internal

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
internal

Spine Security Broker API

Provide single sign-on for Spine users.

Access to Records Security HL7 V3 API Service Central
internal

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
internal

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

internal

Technology Reference Data Update Distribution API

Automate the download of TRUD release files.

Reference Data REST API Service Central
internal

Terminology Server - FHIR API

Retrieve terminologies and classifications from the NHS Digital Terminology Server.

Reference Data FHIR REST API Service Central
internal

Transfer of Care Emergency Care Discharge - FHIR API

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

Hospital A&E / Emergency Department GP / Primary Care Urgent And Emergency Care A&E / Emergency Department Continuity of Care (ToC) FHIR MESH API Service Intermediary
internal

Transfer of Care Inpatient Discharge - FHIR API

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

Hospital Inpatient GP / Primary Care Continuity of Care (ToC) FHIR MESH API Service Intermediary
internal

Transfer of Care Mental Health Discharge - FHIR API

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

Hospital Mental Health GP / Primary Care Continuity of Care (ToC) FHIR MESH API Service Intermediary
internal

Transfer of Care Outpatient Clinic Letter - FHIR API

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

Hospital Outpatient GP / Primary Care Continuity of Care (ToC) FHIR MESH API Service Intermediary

U

internal

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

V

internal

Vaccination Adverse Reactions COVID-19 API

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

Community health GP / Primary Care Vaccination MESH API Service Intermediary
internal

Vaccination APIs

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

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

Vaccination Events - FHIR API

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

Community health Hospital Inpatient Outpatient GP / Primary Care Continuity of Care (ToC) Vaccination FHIR MESH NEMS API Service Intermediary
Last edited: 24 May 2021 5:12 pm