API and integration catalogue

In production

GP Connect (Patient Facing) User Permissions API

Manage a patient's permissions to access their medical records and services at their GP practice.

Continuity of care Security Patient-facing API Intermediary Internet facing Uses OAS REST GP / primary care

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 Registrations Management Information API

Send real-time management information about GP registrations to us at NHS Digital.

Central Uses API platform GP / primary care REST API Continuity of care Internet facing Uses OAS Uses digital onboarding

In production Under review for deprecation

GP2GP Management Information MESH

Provide information to us on the progress of the patient migration process between GP practices (GP2GP).

GP / primary care MESH REST Continuity of care Internet facing Message integration

In production

Health Research Data Catalogue API

Retrieve information suitable for publication in a health research data catalogue.

Access to records Key care information REST Has sandbox Uses API platform API Central Internet facing Uses OAS Uses digital onboarding

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 production

Hello World API

Teach yourself how to connect to our RESTful APIs.

REST Has sandbox Uses API platform API Central Internet facing Uses OAS CIS2 authentication