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

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

D

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

Digital Maternity API standards

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

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

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

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 Retired

Dose Syntax API standards

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

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

E

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 Retired

G

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

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

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

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

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

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

N

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.

Hospital A&E / Emergency Department Inpatient GP / Primary Care Urgent And Emergency Care Ambulance Services A&E / Emergency Department Access to Records Continuity of Care (ToC) FHIR API Standard

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

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 Retired

O

Outpatients - HL7 V3 API

Access an outpatient report.

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

P

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

T

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

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

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

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

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

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