API catalogue

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

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

---

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

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

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

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

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

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

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