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

38 results

Include 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

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

Receive bowel cancer screening test results in GP practices from the screening system.

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

C

Child Protection - Information Sharing - HL7 V3 API

Access child protection information from Child Protection - Information Sharing (CP-IS) as a local authority or an unscheduled care provider 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 OOH GP HL7 V3 Has adaptor API Service Central

D

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

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

E

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

G

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 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 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 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 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 FHIR STU3 MESH API Service Intermediary

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

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 OOH GP FHIR STU3 REST API Service Central

NHS App API

Engage with users of the NHS App.

Patient Communication Hospital Patient GP / Primary Care FHIR R4 REST Uses API platform 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

O

Organisation Data Service - FHIR API

Access a reduced dataset of health and social care organisations in England and Wales, 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 OOH GP FHIR STU3 API Service Central

Organisation Data Service - ORD API

Access the full dataset of health and social care organisations in England and Wales, 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 OOH GP REST SOAP API Service Central

P

Pathology Messaging - EDIFACT API

Receive pathology test results in GP practices from laboratories.

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 Patient Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP FHIR R4 Has sandbox Uses API platform 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 FHIR STU3 MESH NEMS API Service Intermediary
Deprecated

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 Uses API platform API Service Central

S

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 Uses API platform 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

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 Uses API platform 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

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

V

Vaccination Events - FHIR API

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