Skip to main content

API and integration catalogue

These are the APIs and integrations which are currently available, or in development, from NHS England and associated organisations. It includes APIs as well as API standards defined by us. For other data standards, see the NHS Data Standards Directory.

First time here? Check out getting started with our APIs.

Not sure which API fits your use case? See if we have a building healthcare software guide that helps.

Quick navigation

Filters

Reset filters
Back to top

Filters

Reset filters
Back to top
92 results
A
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
C
Draft

Care Connect FHIR API standards

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

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

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

Access to records Key care information Social care MESH
Draft

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-facing GP / primary care Urgent and emergency care NHS 111 API standard FHIR STU3 REST
Beta In production

Cyber Alerts - REST API

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

Information governance Security API Central Internet facing REST
D
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
Draft

Digital Staff Passport API standard

Allow Digital Staff Passport to access employee information in your system.

Workforce Hospital API standard Internet facing REST Uses OAS
In production

Directory of Healthcare Services (Service Search) API

Find information about NHS healthcare services, including lists of NHS organisation types, organisations, and coronavirus (COVID-19) walk-in sites.

Vaccination Reference data Patient-facing API Central Internet facing REST
In production

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-facing GP / primary care Urgent and emergency care NHS 111 API Central Internet facing REST
Draft

Dose Syntax API standards

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

Continuity of care Prescribing Dispensing Community health Hospital GP / primary care API standard FHIR STU3
E
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
Draft

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 API standard FHIR STU3
In production Under review for deprecation

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 API Central Internet facing REST
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
Beta In production

Electronic Prescription Service Tracker - REST API

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

Prescribing Pharmacy API Central Internet facing REST
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
In production Deprecated

e-Referral Service - FHIR API (HSCN)

Access the e-Referral Service (e-RS) - the national service for creating and managing paperless referrals in primary and secondary care via HSCN only.

Referrals and bookings Hospital GP / primary care API Central FHIR DSTU2 STU3
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
Draft

Eyecare Electronic Referral Service API standard

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

Referrals and bookings API standard REST Uses OAS
F
In production Deprecated

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 API Central FHIR DSTU2
Deprecated

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 API standard FHIR DSTU2
Active

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.

API standard FHIR R4
Active

FHIR Vital Signs profiles API standards

View mappings between LOINC codes ("magic values") to SNOMED CT values used in FHIR STU3 in the UK.

API standard FHIR STU3
G
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
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
I
In development

Immunisation FHIR API

Access and update a patient's immunisation record, including coronavirus, influenza and human papillomavirus immunisations.

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

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. 

API standard FHIR STU3 MESH
M
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
N
Beta In production Internal

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 API Central Internet facing FHIR STU3 REST
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
Draft

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 Hospital A&E / emergency department Inpatient GP / primary care Urgent and emergency care Ambulance services API standard FHIR STU3
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 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 API Central Internet facing FHIR STU3 R4 REST Uses digital onboarding
In production Deprecated

NHS Booking - FHIR API

Search for free slots and book appointments with this API formerly known as FHIR NHS Scheduling API

Referrals and bookings Urgent and emergency care NHS 111 API Intermediary Internet facing FHIR STU3
In production

NHSmail APIs

Integrate with NHSmail using these native Microsoft Exchange APIs.

Messaging Transport / infrastructure API Central Internet facing REST
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
O
In production

Ophthalmic Payments API

Submit General Ophthalmic Service (GOS) payment claims from Practice Management Systems (PMS) and Bulk Scanning facilities to Primary Care Support England (PCSE),

API Internet facing REST
In production

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. 

Community health Dentistry Hospital A&E / emergency department Outpatient Mental health Pharmacy GP / primary care Social care Ambulance services NHS 111 OOH GP API FHIR STU3 REST Uses OAS
In production

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) Organisation Reference Data (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 API Central Internet facing REST SOAP
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
P
In development

Pathology Messaging - FHIR

Share pathology results from a Laboratory Information Management System (LIMS) to the requestor in NHS primary or secondary care settings.

Tests and diagnostics Hospital GP / primary care Message integration Internet facing FHIR STU3 MESH
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
Draft

Patient Care Aggregator Get Appointments API standard

As a secondary care provider, provide a list of bookings for a patient to the Patient Care Aggregator.

Referrals and bookings API standard Internet facing FHIR R4 REST Uses OAS Uses digital onboarding
Beta In production

Patient Care Aggregator Record Service API

As a secondary care provider, let the Patient Care Aggregator know which patients you have bookings for.

Referrals and bookings API Central Internet facing REST Uses OAS Uses digital onboarding
In development

Patient Flags Service - FHIR API

This service provides access to flags associated with a patient.

Key care information GP / primary care Central FHIR R4 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
Beta In production Internal

Proxy Generator API

Create and manage resources on the NHS England API Platform as an API producer team. This API can be used to register new API definitions, publish specifications and manage API proxies within the platform.

Internet facing REST Uses OAS
R
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
T
In production

Technology Reference Update Distribution API

Automate the download of TRUD release files, including classification products, NHS data model and dictionary, and terminology products.

Reference data API Central Internet facing REST
In production

Terminology Server - FHIR APIs

Retrieve terminologies and classifications from the NHS England Terminology Server, such as SNOMED-CT or ICD-10.

Reference data API Central Internet facing FHIR R4 REST
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
Deprecated

Transfer of Care - pre-FHIR

Send transfer of care information from acute trusts to a GP practice using deprecated legacy pre-FHIR workflows.

Continuity of care GP / primary care Urgent and emergency care NHS 111 Message integration Internet facing MESH
U
In production

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.

Continuity of care Urgent and emergency care NHS 111 API Central Internet facing REST
V
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

Didn't find what you were looking for?

First time here? Check out getting started with our APIs.

Not sure which API fits your use case? See if we have a building healthcare software guide that helps.