API and integration catalogue

In production

e-Referral Service - FHIR API

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

Hospital GP / primary care FHIR API Central STU3 Uses API platform Internet facing Has sandbox Uses OAS REST Referrals and bookings

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

Retired

FHIR Converter API

Convert FHIR resources from FHIR STU3 to FHIR R4 and vice versa.

API Central REST FHIR STU3 R4 Uses API platform Internet facing Uses OAS

Internal In development

GP Connect (Patient Facing) Access Record - FHIR API

Access a patient's GP records.

Access to records Continuity of care Patient-facing GP / primary care Pharmacy OOH GP Intermediary REST Internet facing Uses OAS FHIR STU3 API

In production Beta

GP Connect Access Document - FHIR API

Retrieve unstructured documents from a patient’s GP practice record.

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

In production

GP Connect Access Record: Structured - FHIR API

Retrieve structured information from a patient's GP practice record.

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

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

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

National Data Opt-out - FHIR API

Capture patients' preferences and control sharing of their data by healthcare organisations for planning and research purposes with our National Data Opt-out (NDOP) FHIR API.

FHIR Community health Hospital GP / primary care Ambulance services NHS 111 Mental health A&E / emergency department Outpatient Inpatient OOH GP Urgent and emergency care Information governance API Central Access to records Social care REST STU3 Internet facing

In production

National Events Management Service - FHIR API

Publish and subscribe to patient-centric healthcare event messages with the National Events Management Service (NEMS) FHIR API. This national service is implemented on the NHS Spine. 

FHIR Continuity of care MESH API Central Transport / infrastructure NEMS STU3 Internet facing Publish-subscribe events Uses digital onboarding