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. 

33 results

Include retired APIs


A
Retired

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

Child Screening API

The Child Screening Domain Message Specification supports the Child Screening Report - A CDA document containing child screening information. 

Key care information Messaging Tests and diagnostics API service Intermediary

D
Beta

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

Discharge - HL7 V3 API

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

Continuity of care Hospital Inpatient GP / primary care HL7 V3 API service Intermediary

E
Retired

Emergency Department - HL7 V3 API

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

Continuity of care Hospital A&E / emergency department GP / primary care Urgent and emergency care HL7 V3 API service Intermediary

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

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

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

National Population Failsafe Management - FHIR API

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

Continuity of care Key care information Hospital A&E / emergency department Inpatient Mental health GP / primary care Urgent and emergency care Internet facing FHIR API service Intermediary
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

O
Retired

Outpatients - HL7 V3 API

Access an outpatient report.

Continuity of care Hospital Outpatient GP / primary care HL7 V3 API service Intermediary

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

T
Stable

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

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