Skip to main content
Creating a new NHS England: NHS England and NHS Digital merged on 1 February 2023. 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

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

Booking and Referral - FHIR API

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

Access to records Continuity of care Patient communication Referrals and bookings A&E / emergency department Ambulance services NHS 111 API Intermediary Internet facing FHIR R4 REST Has sandbox 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

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

Access child protection information from Child Protection - Information Sharing (CP-IS) 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 API Central HL7 V3 MESH Has adaptor Uses digital onboarding
Active

Child Protection - Information Sharing - SMSP API standards

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

Clinical Document Architecture API standards

API standards to send and receive Clinical Document Architecture (CDA) messages and share information in a clinically safe way.

Messaging API standard
In production Internal

COVID-19 Medical Exemptions - FHIR API

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

Vaccination Patient-facing API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS
Beta In production

COVID-19 Test Results - FHIR API

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

Tests and diagnostics Patient-facing API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS
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
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
Beta In production Under review for deprecation

Data Registers Service - REST API

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

Reference data API Central Internet facing REST
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
Retired

Digital Maternity API standards

API standards to enable sharing and updating of digital maternity records.

Access to records Continuity of care Community health Hospital Maternity GP / primary care API standard FHIR STU3
Beta In production

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

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
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
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
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
Beta 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 Under review for deprecation

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

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

FHIR Converter API

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

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

Gazetteer Service - SOAP API

Validate and retrieve UK-based postal addresses.

Demographics Reference data API Central SOAP
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
In production

GP2GP - HL7 V3

Transfer patients' electronic health records, securely and quickly, between their old and new practices when they change GPs.

Continuity of care GP / primary care Message integration HL7 V3 Has adaptor
In production Under review for deprecation

GP2GP Management Information MESH

Provide information to NHS Digital 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 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
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

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

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

Interoperability Toolkit 2 Messaging API standards

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

Messaging API standard
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

L
Retired

Legitimate Relationship Service - HL7 V3 API

Access patients' Legitimate Relationships (LR) using our HL7 V3 API.

Access to records Information governance Hospital API Central HL7 V3 Has adaptor
Deprecated

Logical Record Architecture API standards

API standards for a Logical Record Architecture (LRA) for use in health and social care.

Messaging API standard

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

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 Event 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 Internet facing FHIR STU3 MESH NEMS
In production

Manage GP registrations and other patient data in NHAIS.

Demographics GP / primary care Message integration Internet facing MESH Has adaptor
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
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
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
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
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

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

NHS CIS Authentication (Spine Security Broker) API

Verify the identity of healthcare workers in England, such as NHS staff, using the Spine Security Broker (SSB) component of the NHS Care Identity Service (CIS). CIS provides single sign-on across local and national digital services using physical and virtual smartcards.

Access to records Security API Central SOAP
In production

NHS login API

Access multiple digital health and social care services with a single login for patients and the public.

Security Patient-facing API Central Internet facing Uses digital onboarding
In production

NHSmail APIs

Integrate with NHSmail using these native Microsoft Exchange APIs.

Messaging Transport / infrastructure API Central Internet facing REST
In production

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

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

Ordnance Survey Places API

Identify UK addresses with the OS Places API. 

Demographics Reference data API Central Internet facing REST Ordnance Survey
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.

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

Outpatients - HL7 V3

Access an outpatient report.

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

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

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

Signing Service API

Generate an electronic signature using your smartcard.

Prescribing Security Outpatient API Central Internet facing REST Uses API platform Uses OAS
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

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 Digital Terminology Server, such as SNOMED-CT or ICD-10.

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

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 at NHS Digital relating to coronavirus (COVID-19) and seasonal flu vaccinations.

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

Vaccination Adverse Reactions COVID-19

Provide information to NHS Digital on adverse reactions relating to coronavirus (COVID-19) 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
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