API and integration catalogue

Internal In production Beta

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.

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

Internal Beta In production

Multicast Notification Service API

Publish and receive patient-related state changes from a single centralised system.

Uses OAS API Internet facing Central Has sandbox Publish-subscribe events REST STU3 MESH

In production Beta

NHS App API

Engage with users of the NHS App.

Hospital GP / primary care Patient-facing Patient communication REST API FHIR R4 Uses API platform Internet facing Central Uses OAS Uses digital onboarding

Beta In production

NHS Notify API

Send messages to patients via email, SMS, the NHS App or letter. Previously known as Communications Manager.

REST Uses OAS Uses API platform Has sandbox Internet facing

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

Beta In production

Patient Care Aggregator Record Service API

As a secondary care provider, let the Patient Care Aggregator know which patients you have bookings for.

Referrals and bookings API Central Uses OAS REST Internet facing Uses digital onboarding

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

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

Internal Beta In production

Proxy Generator API

Create and manage resources on the NHS England API Platform as an API producer team. This API can be used to register new API definitions, publish specifications and manage API proxies within the platform.

REST Internet facing Uses OAS

In production Beta

Spine Directory Service - FHIR API

Access accredited system information and messaging endpoint details in the Spine Directory Service (SDS) using our FHIR-conformant API.

Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 FHIR Reference data API Central Has sandbox R4 Uses API platform Internet facing Uses OAS REST