API and integration catalogue

Retired

Ambulance Messaging - HL7 V3

Ambulance Messaging supports the Ambulance Service Summary Patient Report containing a summary of care events and care data.

Urgent and emergency care Ambulance services HL7 V3 Message integration Referrals and bookings

In production

Booking and Referral - FHIR API

Send booking and referral information between NHS service providers using our Booking and Referral FHIR API.

REST API Internet facing FHIR Referrals and bookings A&E / emergency department NHS 111 R4 Intermediary Ambulance services Uses API platform Uses digital onboarding Uses OAS

Deprecated In production

e-Referral Service - FHIR API (HSCN)

Access the e-Referral Service (e-RS) - the national service for creating and managing paperless referrals in primary and secondary care via HSCN only.

Hospital GP / primary care API Central FHIR STU3 DSTU2 Referrals and bookings

In production

e-Referral Service - HL7 V3 API

Create paperless referrals or manage appointment slots in secondary care using the e-Referral Service (e-RS) HL7 V3 API.

Hospital HL7 V3 API Central Has adaptor Referrals and bookings

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

In production

GP Connect Appointment Management - FHIR API

Manage GP practice appointments between different systems.

FHIR Hospital A&E / emergency department Outpatient Inpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Continuity of care REST API Intermediary STU3 Referrals and bookings

Deprecated In production

NHS Booking - FHIR API

Search for free slots and book appointments with this API formerly known as FHIR NHS Scheduling API

Urgent and emergency care NHS 111 FHIR API Intermediary STU3 Internet facing Referrals and bookings

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

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