In production

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 API Central Internet facing FHIR R4 REST MESH Has sandbox Uses API platform Uses OAS

---

In production Deprecated

Assessment Discharge and Withdrawal - FHIR

Support transfer of care from hospital to social services for patients with care and support needs.

Continuity of care Hospital Inpatient Social care Message integration Internet facing FHIR DSTU2 MESH

In production

Booking and Referral - FHIR API

Send booking and referral information between NHS service providers using our Booking and Referral FHIR API.

Referrals and bookings A&E / emergency department Ambulance services NHS 111 API Intermediary Internet facing FHIR R4 REST Uses API platform Uses OAS Uses digital onboarding

---

In production

Bowel Cancer Screening - EDIFACT

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

Tests and diagnostics Hospital GP / primary care Message integration Internet facing MESH Has adaptor

In production

Cervical Screening - EDIFACT

Send cervical screening test results from screening laboratories and receive them in GP practices and NHAIS system.

Vaccination Tests and diagnostics Hospital GP / primary care Message integration Internet facing MESH Has adaptor

---

In production

Child Protection - Information Sharing - HL7 V3 API

Access child protection information from Child Protection - Information Sharing (CP-IS) from a healthcare setting.

Access to records Key care information Community health Hospital A&E / emergency department Inpatient Social care Urgent and emergency care Ambulance services OOH GP API Central HL7 V3 MESH Has adaptor Uses digital onboarding

---

In production

Child Protection - Information Sharing - MESH

Share information with Child Protection - Information Sharing (CP-IS) as a local authority.

Access to records Key care information Social care MESH

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

---

In production Deprecated

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

In production Internal

Elective Waiting List API

Use this API to access the Waiting List Minimum Data Set (WLMDS) – The national electronic database of NHS patient waiting list details such as date of birth, a patient's care pathway and date they began waiting.

Referrals and bookings Patient-facing Central Internet facing REST Uses API platform Uses OAS

---

In production

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 GP / primary care API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS

---

In production

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 and bookings Hospital GP / primary care API Central Internet facing FHIR STU3 REST Has sandbox Uses API platform Uses OAS

---

Beta In production Internal

e-Referral Service Patient Care – FHIR API

Retrieve referrals for a patient from the e-Referral Service (e-RS) - the national service for creating and managing paperless referrals in primary and secondary care.

Referrals and bookings Hospital Patient-facing API Central Internet facing FHIR R4 REST Uses API platform Uses OAS

In production

General Practice Extraction Service - MESH

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

---

In production Under review for deprecation

GP2GP Management Information MESH

Provide information to us 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 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 OOH GP Message integration Internet facing FHIR STU3 MESH

---

Beta In production

GP Connect Update Record

Use this integration to update a patient's GP record from a community pharmacy with structured data.

Continuity of care Pharmacy 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

In production

Health Research Data Catalogue API

Retrieve information suitable for publication in a health research data catalogue.

Access to records Key care information API Central Internet facing REST Has sandbox Uses API platform Uses OAS Uses digital onboarding

---

In production

Hello World API

Teach yourself how to connect to our RESTful APIs.

API Central Internet facing REST Has sandbox Uses API platform Uses OAS

In production

Immunisation History - FHIR API

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

Vaccination Patient-facing API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS Uses digital onboarding

In production

Message Exchange for Social Care and Health (MESH) API

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 API Central Internet facing REST MESH Uses OAS Uses digital onboarding

---

Beta In production Internal

Multicast Notification Service API

Publish and receive patient-related state changes from a single centralised system.

API Central Publish-subscribe events Internet facing STU3 REST MESH Has sandbox Uses OAS

In production

National Data Opt-out - MESH

Submit a list of NHS numbers via MESH to be checked against the National Data Opt-out Service.

Patient communication Hospital GP / primary care Message integration MESH

---

In production

National Events Management Service - FHIR API

Publish and subscribe to patient-centric healthcare event messages with the National Events Management Service (NEMS) FHIR API. This national service is implemented on the NHS Spine. 

Continuity of care Messaging Transport / infrastructure API Central Publish-subscribe events Internet facing FHIR STU3 MESH NEMS Uses digital onboarding

---

In production

National Health Application and Infrastructure Services - NHAIS GP Links

Manage GP registrations and other patient data in NHAIS.

Demographics GP / primary care Message integration Internet facing MESH Has adaptor

---

Beta In production

NHS App API

Engage with users of the NHS App.

Patient communication Hospital Patient-facing GP / primary care API Central Internet facing FHIR R4 REST Uses API platform Uses OAS Uses digital onboarding

---

Beta In production

NHS Notify API

Send messages to patients via email, SMS, the NHS App or letter. Previously known as Communications Manager.

Internet facing REST Has sandbox Uses API platform Uses OAS

---

In production

NHS Website Content API

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

Patient-facing API Central Internet facing REST Has sandbox Uses API platform Uses OAS Uses digital onboarding

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

In production Under review for deprecation

Pathology Messaging - EDIFACT

Receive pathology test results in GP practices from laboratories.

Tests and diagnostics Hospital GP / primary care Message integration Internet facing MESH Has adaptor

---

Beta In production Internal

Patient Care Aggregator - FHIR API

Get an aggregated list of referrals and bookings for a patient from secondary care providers.

Referrals and bookings Patient-facing API Intermediary Internet facing FHIR R4 REST Uses API platform Uses OAS

---

In production

Personal Demographics Service - FHIR API

Access patients' personal information, such as name, address, date of birth, related people, registered GP, nominated pharmacy and NHS number using the FHIR version of the Personal Demographics Service (PDS) API.

Demographics Community health Hospital Mental health Patient-facing Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS Uses digital onboarding

---

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

---

Beta In production Internal

Prescriptions for Patients FHIR API

Use this API to access the Patient Facing Services (PFS) capabilities of the Electronic Prescription Service (EPS).

Pharmacy API FHIR REST Has sandbox Uses API platform Uses OAS

In production Deprecated

Radiology MESH

Send radiology messages from a radiology department to a GP system over MESH

Hospital GP / primary care Message integration Internet facing MESH

Beta In production

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 API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS

---

Beta In production

Summary Care Record - FHIR API

Access a 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 API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS Uses digital onboarding

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

---

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

In production

Vaccination

Provide information to us relating to coronavirus (COVID-19) and seasonal flu vaccinations.

Vaccination Community health GP / primary care Message integration Internet facing MESH

---

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