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

59 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

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

Clinical Decision Support API standards

API standards to support the triage and onward referral of patients who are interacting with Urgent and Emergency Care services, such as NHS 111.

Clinical Decision Support Hospital A&E / Emergency Department Patient GP / Primary Care Urgent And Emergency Care NHS 111 FHIR STU3 REST API Standard
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 (ToC) Key Care Information Messaging Hospital A&E / Emergency Department GP / Primary Care Urgent And Emergency Care API Service

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

Digital Maternity API standards

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

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

Digital Medicine - FHIR API

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

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

Directory of Services - Urgent and Emergency Care - REST API

Access information on a wide range of health and care services across England using our Directory of Services Urgent and Emergency Care REST API.

Reference Data Patient GP / Primary Care Urgent And Emergency Care NHS 111 REST API Service Central

Directory of Services - Urgent and Emergency Care - SOAP API

Access information on a wide range of health and care services across England using our Directory of Services Urgent and Emergency Care SOAP API.

Reference Data Patient GP / Primary Care Urgent And Emergency Care NHS 111 SOAP API Service Central
Retired

Discharge - HL7 V3 API

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

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

Dose Syntax API standards

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

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

E

Electronic Prescribing and Medicines Administration API standards

Use these API standards to share medication requests between ePMA systems and hospital pharmacy or stock control systems.

Prescribing Dispensing Hospital A&E / Emergency Department Inpatient GP / Primary Care Urgent And Emergency Care FHIR STU3 API Standard

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.

Prescribing Dispensing Community health A&E / Emergency Department GP / Primary Care Urgent And Emergency Care OOH GP HL7 V3 Has adaptor API Service Central

Electronic Transmission of Prescriptions Web Services - SOAP API

Get prescription dispenser information for a patient, using NHS UK Web Services.

Access to Records Dispensing Reference Data Community health Pharmacy GP / Primary Care Urgent And Emergency Care OOH GP SOAP API Service Central
Retired

Emergency Department - HL7 V3 API

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

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

End of Life API standards

API standards to enable sharing and updating of digital end of life care (EoLC) records.

Access to Records Community health Hospital GP / Primary Care Social Care Urgent And Emergency Care Ambulance Services NHS 111 FHIR STU3 API Standard

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

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

Female Genital Mutilation - Information Sharing - SMSP API standards

Become a Spine Mini Service Provider giving access to female genital mutilation (FGM) information for children under 18 to relevant NHS professionals across England, using our Female Genital Mutilation - Information Sharing (FGM-IS) SMSP API standards.

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 Standard

G

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 (ToC) GP / Primary Care HL7 V3 Has adaptor API Service Intermediary

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

H
Retired

Health Protection Electronic Notification API

Inform Public Health England (PHE) that a notifiable disease has been diagnosed in a patient, using our Health Protection Electronic Notification (HPEN) API. Includes PHE's response message.

Messaging Information Governance Tests and Diagnostics Community health Hospital A&E / Emergency Department GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP API Service

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

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 (ToC) Hospital A&E / Emergency Department Inpatient GP / Primary Care Urgent And Emergency Care Ambulance Services FHIR STU3 API Standard

Manage GP registrations and other patient data in NHAIS.

Demographics GP / Primary Care 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 (ToC) Key Care Information Hospital A&E / Emergency Department Inpatient Mental Health GP / Primary Care Urgent And Emergency Care FHIR API Service Intermediary

NHS 111 API standard

API standard to share information between NHS 111 and other organisations, such as GPs and ambulance services, and query the Repeat Caller Service.

Hospital A&E / Emergency Department GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 SOAP HL7 V3 Has adaptor API Standard

NHS App API

Engage with users of the NHS App.

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

Outpatients - HL7 V3 API

Access an outpatient report.

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

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

Personal Demographics Service - SMSP API standards

Become a Spine Mini Service Provider giving access to 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 standards.

Demographics Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP API Standard

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

Summary Care Record - SMSP API standards

Become a Spine Mini Service Provider giving access to a patient's Summary Care Record using our SMSP API standards.

Access to Records Community health Hospital Mental Health Pharmacy GP / Primary Care Urgent And Emergency Care Ambulance Services NHS 111 OOH GP HL7 V3 API Standard

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

Vaccination APIs

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

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

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