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

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

Ambulance Messaging - HL7 V3

Ambulance Messaging supports the Ambulance Service Summary Patient Report containing a summary of care events and care data.

Referrals and bookings Urgent and emergency care Ambulance services Message integration HL7 V3
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

B
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

D
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
In production

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

Discharge - HL7 V3

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

Continuity of care Hospital Inpatient GP / primary care Message integration HL7 V3

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

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. This is now deprecated.

Prescribing Dispensing Community health A&E / emergency department GP / primary care Urgent and emergency care OOH GP API Central HL7 V3 Has adaptor
Retired

Emergency Department - HL7 V3

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

Continuity of care Hospital A&E / emergency department GP / primary care Urgent and emergency care Message integration HL7 V3
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
In production

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.

Referrals and bookings Hospital API Central HL7 V3 Has adaptor
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

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

G
Retired

General Practice Extraction Service - HL7 V3

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 SOAP HL7 V3 Has adaptor
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

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

NHS CIS2 Care Identity Authentication

Verify the identity of healthcare workers in England, such as NHS staff, using the NHS Care Identity Service 2 (CIS2). CIS2 uses the OpenID Connect (OIDC) standard to provide single sign-on across local and national digital services using smartcards or modern alternatives.

Security Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 API Central UI integration Internet facing Uses digital onboarding

O
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
In production Under review for deprecation

Pathology Messaging - HL7 V3

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 Message integration HL7 V3 Has adaptor
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 Under review for deprecation

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 API Central SOAP HL7 V3 Has adaptor
In production 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 Central

Q
In production Deprecated

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 API Central SOAP

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

S
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
In production

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 Central
In production

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 API Central HL7 V3 Has adaptor

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

Vaccination Adverse Reactions COVID-19

Provide information to NHS England on adverse reactions relating to coronavirus (COVID-19) vaccinations.

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

Visitors and Migrants - FHIR API

Identify overseas visitors and migrants liable for charging for their healthcare with the Visitors and Migrants FHIR API.

Continuity of care Key care information Hospital A&E / emergency department Inpatient Mental health GP / primary care Urgent and emergency care API Central FHIR DSTU2

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.