API and integration catalogue

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: HTML - FHIR API

View a patient's GP practice record, with read-only access.

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 DSTU2

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

In production

GP Connect Send Document - FHIR

Send a PDF consultation summary to a registered GP practice.

FHIR Hospital A&E / emergency department Outpatient Inpatient GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Continuity of care MESH STU3 Internet facing Message integration

In production

GP Connect Update Record

Use this integration to update a patient's GP record from a community pharmacy with structured data.

Continuity of care Message integration MESH Pharmacy FHIR STU3 Internet facing

In development

Healthcare Worker - FHIR API

Healthcare worker (HCW) API enables systems to search, retrieve and display healthcare worker data from NHS employees with a health care profile.

Uses OAS Internet facing REST FHIR Uses digital onboarding

In development

Immunisation FHIR API

Access and update a patient's immunisation record, including coronavirus, influenza and human papillomavirus immunisations.

Vaccination Patient-facing API Central Internet facing FHIR R4 REST Has sandbox Uses API platform Uses OAS Uses digital onboarding

In production Deprecated

Immunisation History - FHIR API

Access a patient’s coronavirus (COVID-19) immunisation history.

Central REST Vaccination FHIR Patient-facing API Has sandbox R4 Uses API platform Internet facing Uses OAS Uses digital onboarding

Active

Interoperability Toolkit 3 Messaging Distribution FHIR API standards

API standards for a set of generic messaging components using FHIR STU3 to create a unified approach to NHS message and document flows across England. 

FHIR API standard MESH STU3