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

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

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

---

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

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

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

---

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

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

---

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

---

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

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

---

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

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

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

Retired

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

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

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

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