API and integration catalogue

In development Internal

Address Quality Service API

Add a Unique Property Reference Number (UPRN) to addresses before they are updated in the Personal Demographics Service (PDS) database.

REST API standard Uses OAS API

Internal In development

Connecting Party Manager API

Register and manage details of systems and applications that connect to our APIs.

Uses OAS Has sandbox REST Uses API platform

Internal Retired

COVID-19 Medical Exemptions - FHIR API

Access a patient’s coronavirus (COVID-19) medical exemption status.

Vaccination Patient-facing FHIR R4 REST Has sandbox API Central Uses API platform Internet facing Uses OAS

Internal

Demographics Workspace Application Adaptor - HL7 V3 API

Use this API to enable interactions between Service Now and PDS Spine. The API performs compression/decompression depending on request type.

Uses OAS HL7 V3 Uses API platform

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

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.

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

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

Internal In development

Patient Data Manager FHIR API

The Patient Data Manager (PDM) API enables NHS products to store, retrieve, and manage patient healthcare data in a standardised, interoperable format.

Uses OAS APIs FHIR R4 Uses digital onboarding Uses API platform

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