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

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

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

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

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

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

---

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

In development Internal

GP Connect (Patient Facing) Access Record - FHIR API

Access a patient's GP records.

Access to records Continuity of care Patient-facing Pharmacy GP / primary care OOH GP API Intermediary Internet facing FHIR STU3 REST Uses OAS

---

In development Internal

GP Connect (Patient Facing) Prescriptions - FHIR API

Manage a patient's prescriptions.

Continuity of care Prescribing Patient-facing GP / primary care API Intermediary Internet facing FHIR R4 REST Uses OAS

---

In development Internal

GP Connect (Patient Facing) User Permissions API

Manage a patient's permissions to access their medical records and services at their GP practice.

Continuity of care Security Patient-facing GP / primary care API Intermediary Internet facing REST Uses OAS

---

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

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

---

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

National Care Records Service integration

Integrate point-of-care applications with the National Care Records Service (NCRS) to quickly and easily view patient records.

Access to records Demographics Key care information Community health Dentistry Hospital A&E / emergency department Inpatient Outpatient Maternity Mental health Patient-facing Pharmacy GP / primary care Transport / infrastructure Social care Urgent and emergency care Ambulance services NHS 111 OOH GP UI integration Internet facing

---

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

---

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

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

---

In production

NHS login

Access multiple digital health and social care services with a single login for patients and the public. NHS login uses the OpenID Connect (OIDC) standard.

Security Patient-facing API Central UI integration Internet facing Uses digital onboarding

---

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

NHS Website Content Widgets

Embed content from the NHS.UK website about health conditions, A-Z and more, using our free NHS Website Content widgets.

Patient-facing UI integration Internet facing

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

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

Ratings and Reviews API

Get details of ratings and reviews for NHS organisations.

Patient-facing API Central Internet facing REST

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

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

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