API and integration catalogue

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

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

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

In production

Personal Demographics Service MESH

Search the Personal Demographics Service (PDS) for patient details using the MESH UI. Formerly known as Master Patient Trace.

Central Community health Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 Mental health OOH GP Pharmacy Demographics Internet facing Message integration

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 production

Pharmacy Contraception Claims - REST API

Submit or update payment claims to the NHS Business Services Authority (BSA) for contraception services provided by a community pharmacy.

REST Internet facing API NHS BSA

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

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 Deprecated

Radiology MESH

Send radiology messages from a radiology department to a GP system over MESH

GP / primary care Message integration Internet facing MESH Hospital

In production Under review for deprecation

Ratings and Reviews API

Get details of ratings and reviews for NHS organisations.

REST Patient-facing API Central Internet facing