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.

99 results

Include retired APIs

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

Ambulance Data Submission - FHIR API

Submit ambulance data to our Data Processing Service (DPS) for analysis and review by NHS England and ambulance trusts, using our Ambulance Data Submission - FHIR API (formerly Ambulance Analytics).

Urgent And Emergency Care Ambulance Services FHIR R4 MESH Has sandbox API Service Central

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

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

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 (ToC) Patient Communication A&E / Emergency Department Ambulance Services NHS 111 FHIR R4 REST API Service Intermediary

Booking and Referral Standard implementation guide

A standard for healthcare IT systems that enables booking and referral information to be sent between NHS service providers.

Appointment / Scheduling Referrals Access to Records Continuity of Care (ToC) Patient Communication A&E / Emergency Department Ambulance Services NHS 111 FHIR R4 REST API Standard

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

Care Connect FHIR API standards

API standards using FHIR STU3 to create a unified approach to interoperability across England.

FHIR STU3 API Standard

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

Become a Spine Mini Service Provider giving access to child protection information from Child Protection - Information Sharing (CP-IS) for an unscheduled care provider using our SMSP API standards.

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

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

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

COVID-19 Medical Exemptions - FHIR API

Access a patient’s coronavirus (COVID-19) medical exemption status.

Vaccination Patient FHIR R4 REST Has sandbox API Service Central

COVID-19 Test Results - FHIR API

Access a patient’s coronavirus (COVID-19) test results history.

Tests and Diagnostics Patient FHIR R4 REST Has sandbox API Service Central

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

Cyber Alerts - REST API

Access a feed of alerts issued by our cyber security centre.

Information Governance Security REST API Service Central

Data Registers Service - REST API

Access a wide range of live lists of lookup data with our Data Registers Service.

Reference Data REST API Service Central

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

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 Directory of Services API

Access information about dispensing services, including searching for dispensers who can provide dispensing services for a patient with a given location and urgency, using our Electronic Prescription Service (EPS) Directory of Services (DoS) API.

Prescribing Dispensing Reference Data Urgent And Emergency Care OOH GP REST API Service Central

Electronic Prescription Service - FHIR API

Access the Electronic Prescription Service (EPS) - the national service used to send electronic prescriptions from GP surgeries to pharmacies.

Prescribing Dispensing Outpatient FHIR R4 REST Has sandbox API Service Central

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 Prescription Service Tracker - REST API

Track a patient’s prescriptions using our Electronic Prescription Service (EPS) Tracker API.

Prescribing Pharmacy REST 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

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

Eyecare Electronic Referral Service API standard

Pass details of a new referral to an Eyecare Electronic Referral System (EeRS).

Appointment / Scheduling Referrals API Standard

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

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

FHIR Converter API

Convert FHIR resources from FHIR R4 to STU3 and vice versa.

FHIR STU3 R4 REST API Service Central

FHIR UK Core API standards

API standards using FHIR release 4 to create a unified approach to interoperability across England, Scotland, Wales and Northern Ireland.

FHIR R4 API Standard

Gazetteer Service - SOAP API

Validate and retrieve UK-based postal addresses.

Demographics Reference Data SOAP API Service Central

Retired

General Practice Extraction Service - HL7 V3 API

Send anonymised or patient-identifiable data from GP clinical systems to the General Practice Extraction Service (GPES) for planning and research.

Access to Records Key Care Information Community health SOAP HL7 V3 Has adaptor API Service Central

General Practice Extraction Service - MESH API

Send anonymised or patient-identifiable data from GP clinical systems to the General Practice Extraction Service (GPES) for planning and research.

Access to Records Key Care Information Community health MESH API Service Central

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.

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

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

Hello World API

Teach yourself how to connect to our RESTful APIs.

REST Has sandbox

Immunisation History - FHIR API

Access a patient’s coronavirus (COVID-19) immunisation history.

Vaccination Patient FHIR R4 REST Has sandbox API Service Central

Interoperability Toolkit 3 Messaging Distribution FHIR API standards

API standards for a set of generic messaging components using FHIR STU3 to create a unified approach to NHS message and document flows across England.

FHIR STU3 MESH API Standard

Interoperability Toolkit Messaging HL7 V2 API standards

API standards for a set of messaging components using HL7 V2.

Messaging API Standard

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

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

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

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 (ToC) Messaging Transport / Infrastructure FHIR STU3 MESH NEMS API Service Central Intermediary

National Health Application and Infrastructure Services - NHAIS GP Links API

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

National Record Locator - FHIR API

Locate and access patient information shared by other healthcare organisations using the National Record Locator (NRL) FHIR API.

Access to Records Transport / Infrastructure FHIR STU3 API Service Central

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

Access multiple digital health and social care services with a single login for patients and the public, including authentication for returning users.

Security Patient API Service Central

NHS Syndicated Content - REST APIs

Pull content from the NHS.UK website about health conditions, health news, medicines A-Z and more, using our free NHS Syndicated Content APIs and widgets.

Patient REST API Service Central

Retired

Non-Coded CDA Document API

Send a Clinical Document Architecture (CDA) message when no other specific document profile exists using a Non-Coded CDA Document profile.

Messaging API Service

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.

Retired

Outpatients - HL7 V3 API

Access an outpatient report.

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

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

API catalogue

Search A-Z

Filters

Search A-Z

Filters

99 results