API and integration catalogue

In production Beta

Directory of Services Search API

Use this API to access healthcare services details profiled in the Directory of Services. This API provides read-only access to the data held in the directory.

NHS 111 REST Central Internet facing Uses OAS Uses digital onboarding Urgent and emergency care

In production Beta

Eligibility Signposting API

Access the Patient Eligibility Signposting Data Product - the nationally curated single source of vaccination eligibility status and signposted actions for individuals.

Central Medication management Vaccination Patient-facing Internet facing REST Has sandbox Uses API platform Uses OAS Uses digital onboarding

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

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

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

Beta In production

Summary Care Record - FHIR API

Access a patient's Summary Care Record (SCR), an electronic record of important patient information, using our FHIR API.

Community health Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 Access to records Mental health FHIR OOH GP Pharmacy REST API Central Has sandbox R4 Uses API platform Internet facing Uses OAS Uses digital onboarding CIS authentication