Skip to main content
Creating a new NHS England: Health Education England, NHS Digital and NHS England have merged. More about the merger.

API catalogue

These are the APIs which are currently available, or in development, from NHS Digital 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

46 results
A
In production Under review for deprecation

Access Control Service HL7 V3 API

Manage patient consent to share their information, including their Summary Care Record (SCR), with the Access Control Service.

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

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

C
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
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 Key care information Messaging Hospital A&E / emergency department GP / primary care Urgent and emergency care API

D
In production

Demographics Batch Service

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

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

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

Electronic Transmission of Prescriptions Web Services - REST 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 API Central Internet facing REST
In production Under review for deprecation

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 API Central Internet facing SOAP
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
Draft

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

F
In production

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
Draft

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

G
Beta In production

GP Connect Access Document - FHIR API

Retrieve unstructured documents from a patient’s GP practice record.

Access to records Continuity of care Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 API Intermediary FHIR STU3 REST
In production

GP Connect Access Record: HTML - FHIR API

View a patient's GP practice record, with read-only access.

Access to records Continuity of care Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 API Intermediary FHIR DSTU2 REST
In production

GP Connect Access Record: Structured - FHIR API

Retrieve structured information from a patient’s GP practice record.

Access to records Continuity of care Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 API Intermediary FHIR STU3 REST
In production

GP Connect Appointment Management - FHIR API

Manage GP practice appointments between different systems.

Continuity of care Referrals and bookings Hospital A&E / emergency department Inpatient Outpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 API Intermediary FHIR STU3 REST
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 Message integration Internet facing FHIR STU3 MESH

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

I
Active

Interface Mechanism 1 API standards

API standards to support the integration of your systems with any principal clinical GP system using IM1.

Access to records Hospital A&E / emergency department Patient-facing GP / primary care Urgent and emergency care API standard

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

National Population Failsafe Management - FHIR API

Raise failsafe alerts about children with the National Population Failsafe Management (NPFM) FHIR API.

Continuity of care Key care information Hospital A&E / emergency department Inpatient Mental health GP / primary care Urgent and emergency care API Intermediary Internet facing FHIR
Active

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

NHS CIS2 Care Identity Authentication API

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

O
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

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

Personal Demographics Service MESH

Search the Personal Demographics Service (PDS) for patient details using the MESH UI. Formerly known as Master Patient Trace.

Demographics Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Central Message integration Internet facing
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
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
Active Under review for deprecation

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

R
In development

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

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

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
Active

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 API standard HL7 V3

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

Transfer of Care - MESH

Send transfer of care information from an emergency care provider to a GP practice over MESH.

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

V
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