API and integration catalogue

Pathology Messaging - FHIR

Share pathology results from a Laboratory Information Management System (LIMS) to the requestor in NHS primary or secondary care settings.

Hospital GP / primary care FHIR Tests and diagnostics MESH STU3 Internet facing Message integration

In production Beta Internal

Patient Care Aggregator - FHIR API

Get an aggregated list of referrals and bookings for a patient from secondary care providers.

Patient-facing API Intermediary R4 FHIR Uses API platform Internet facing REST Uses OAS Referrals and bookings

Draft

Patient Care Aggregator Get Appointments API standard

As a secondary care provider, provide a list of bookings for a patient to the Patient Care Aggregator.

Referrals and bookings API standard Internet facing FHIR R4 REST Uses OAS Uses digital onboarding

Patient flags change event

Use this document alongside the Create Subscriptions API documentation when you want to subscribe to this event..

NEMS Publish-subscribe events Patient-facing FHIR Uses API platform Access to records Messaging Demographics

Internal Beta In production

Patient Flags Service - FHIR API

This service provides access to flags associated with a patient.

Key care information GP / primary care Central FHIR R4 Uses OAS Has sandbox REST Uses API platform

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.

FHIR Community health Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 Mental health OOH GP Pharmacy Demographics API Central Has sandbox R4 Patient-facing Uses API platform Internet facing Uses OAS REST 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.

FHIR A&E / emergency department MESH Continuity of care Urgent and emergency care GP / primary care Mental health Hospital Inpatient Demographics NEMS STU3 Internet facing Publish-subscribe events

In development

Prescription Status Update - FHIR API

The Prescription Status Update API allows dispensing suppliers to push status information about electronic prescriptions to patients on a national scale via the NHS App. This includes letting patients know when their prescription is ready to collect.

REST Has sandbox Uses OAS Internet facing Uses API platform FHIR Dispensing

Internal Beta In production

Prescriptions for Patients FHIR API

Use this API to access the Patient Facing Services (PFS) capabilities of the Electronic Prescription Service (EPS).

Uses OAS FHIR REST Has sandbox Pharmacy API Uses API platform