Skip to main content
Creating a new NHS England: Health Education England, NHS Digital and NHS England have merged. More about the merger.

API catalogue

These are the APIs which are currently available, or in development, from NHS Digital and associated organisations. It includes APIs as well as API standards defined by us. For other data standards, see the NHS Data Standards Directory.

First time here? Check out getting started with our APIs.

Not sure which API fits your use case? See if we have a building healthcare software guide that helps.

Quick navigation

Filters

Reset filters
Back to top

Filters

Reset filters
Back to top
32 results
C
Retired

Crisis Care Extract API

Send a CDA document containing Crisis Care Extract information supporting the sharing of care plans for urgent and emergency care.

Continuity of care Key care information Messaging Hospital A&E / emergency department GP / primary care Urgent and emergency care API
D
In production

Digital Child Health - FHIR

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 Publish-subscribe events Internet facing FHIR STU3 MESH NEMS
Retired

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 API standard FHIR STU3
Beta In production

Digital Medicine - FHIR

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 Message integration Internet facing FHIR STU3 MESH
Retired

Discharge - HL7 V3

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

Continuity of care Hospital Inpatient GP / primary care Message integration HL7 V3
Draft

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 API standard FHIR STU3
E
Retired

Emergency Department - HL7 V3

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 Message integration HL7 V3
G
In production

GP2GP - HL7 V3

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

Continuity of care GP / primary care Message integration HL7 V3 Has adaptor
In production Under review for deprecation

GP2GP Management Information MESH

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

Continuity of care GP / primary care Message integration Internet facing REST MESH
In development Internal

GP Connect (Patient Facing) Access Record - FHIR API

Access a patient's GP records.

Access to records Continuity of care Patient-facing GP / primary care API Intermediary Internet facing FHIR STU3 REST Uses OAS
In development Internal

GP Connect (Patient Facing) Appointment Management - FHIR API

Manage a patient's GP appointments.

Continuity of care Referrals and bookings Patient-facing GP / primary care API Intermediary Internet facing FHIR STU3 REST Uses OAS
In development Internal

GP Connect (Patient Facing) Prescriptions - FHIR API

Manage a patient's prescriptions.

Continuity of care Prescribing Patient-facing GP / primary care API Intermediary Internet facing FHIR R4 REST Uses OAS
In development Internal

GP Connect (Patient Facing) User Permissions API

Manage a patient's permissions to access their medical records and services at their GP practice.

Continuity of care Security Patient-facing GP / primary care API Intermediary Internet facing REST Uses OAS
Beta In production

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 API Intermediary FHIR STU3 REST
In production

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 API Intermediary FHIR DSTU2 REST
In production

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 API Intermediary FHIR STU3 REST
In production

GP Connect Appointment Management - FHIR API

Manage GP practice appointments between different systems.

Continuity of care Referrals and bookings Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 API Intermediary FHIR STU3 REST
In production

GP Connect Send Document - FHIR

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 Message integration Internet facing FHIR STU3 MESH
Beta In production

GP Registrations Management Information API

Send real-time management information about GP registrations to us at NHS Digital.

Continuity of care GP / primary care API Central Internet facing REST Uses API platform Uses OAS Uses digital onboarding
N
Draft

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 API standard FHIR STU3
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 API Intermediary Internet facing FHIR
O
In production Deprecated

Online Consultation - MESH

Submit an online consultation via MESH to a GP practice.

Continuity of care GP / primary care Urgent and emergency care Message integration Internet facing MESH
In production Deprecated

Out Of Hours

Send details of an out of hours (OOH) assessment from an out of hours GP system to the patient's registered GP.

Continuity of care GP / primary care Urgent and emergency care NHS 111 Message integration Internet facing MESH
Retired

Outpatients - HL7 V3

Access an outpatient report.

Continuity of care Hospital Outpatient GP / primary care Message integration HL7 V3
P
In production

Personal Demographics Service Notifications - FHIR

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 Publish-subscribe events Internet facing FHIR STU3 MESH NEMS
T
In production

Transfer of Care Emergency Care Discharge - FHIR

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

Continuity of care Hospital A&E / emergency department GP / primary care Urgent and emergency care Message integration Internet facing FHIR STU3 MESH
In production

Transfer of Care Inpatient Discharge - FHIR

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

Continuity of care Hospital Inpatient GP / primary care Message integration Internet facing FHIR STU3 MESH
In production

Transfer of Care Mental Health Discharge - FHIR

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

Continuity of care Hospital Mental health GP / primary care Message integration Internet facing FHIR STU3 MESH
Deprecated

Transfer of Care - MESH

Send transfer of care information from an emergency care provider to a GP practice over MESH.

Continuity of care GP / primary care Urgent and emergency care NHS 111 Message integration Internet facing MESH
In production

Transfer of Care Outpatient Clinic Letter - FHIR

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

Continuity of care Hospital Outpatient GP / primary care Message integration Internet facing FHIR STU3 MESH
V
In production

Vaccination Events - FHIR

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

Continuity of care Vaccination Community health Hospital Inpatient Outpatient GP / primary care Publish-subscribe events Internet facing FHIR STU3 MESH NEMS
Retired

Visitors and Migrants - FHIR API

Identify overseas visitors and migrants liable for charging for their healthcare with the Visitors and Migrants FHIR API.

Continuity of care Key care information Hospital A&E / emergency department Inpatient Mental health GP / primary care Urgent and emergency care API Central FHIR DSTU2