API and integration catalogue

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

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 Uses digital onboarding

In production Beta

NHS Notify Supplier

Supplier API for printing and sending letters to patients.

Patient communication Messaging Central REST Has sandbox Uses OAS

Retired

Organisation Data Service - FHIR API

Access a reduced dataset of health and social care organisations in England and Wales, such as trusts or GP practices, using our Organisation Data Service (ODS) FHIR API. 

Community health Ambulance services NHS 111 Mental health Dentistry Social care Pharmacy REST OOH GP Hospital FHIR GP / primary care API Outpatient A&E / emergency department STU3 Uses OAS

In production

Organisation Data Terminology - FHIR API

Use this API to access a dataset of health and social care organisations and sites, such as trusts or GP practices, using the Organisation Data Service (ODS). 

Uses OAS FHIR REST Uses digital onboarding R4 Has sandbox Uses API platform Reference data

In development

Pathology and Laboratory Medicine Reporting – FHIR API

The Pathology and Laboratory Medicine Reporting API enables the sharing of structured pathology test results from laboratory middleware systems to the requesting general practice organisation.

R4 FHIR Tests and diagnostics Message integration Internet facing Uses API platform REST Uses OAS Hospital GP / primary care

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

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

Patient Care Aggregator Reporting API

Use this API to send events which happen within your service boundary to the Wayfinder Reporting Service.

Uses OAS