API and integration catalogue

In development Draft

Genomic Data Access and Management API specification

The Genomic Data Access and Management (GDAM) Service provides secure API access to genomic data, such as CRAM and VCF files, and genomic test results. It facilitates integration into NHS Genomic Medicine Service (GMS) systems.

R4 REST Internet facing Has sandbox Uses OAS Uses API platform FHIR

In development

Genomic Order Management Service FHIR API

Access the Genomic Order Management Service - the national service used to send electronic orders from NHS organisations to Genomic Services.

Internet facing Uses API platform R4 REST Uses OAS FHIR Has sandbox Central

In production

GP Connect (Patient Facing) Prescriptions - FHIR API

Manage a patient's prescriptions.

Continuity of care GP / primary care Patient-facing API Intermediary REST Internet facing Uses OAS FHIR R4 Prescribing

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

In production

National Record Locator - FHIR API

Locate and access patient information shared by other healthcare organisations using the National Record Locator (NRL) FHIR API.

REST API Central Internet facing Access to records Transport / infrastructure FHIR R4 STU3 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

In production

Organisation Data Terminology - FHIR API

Use this API to access a dataset of health and social care organisations and sites, such as trusts or GP practices, using the Organisation Data Service (ODS). 

Uses OAS FHIR REST Uses digital onboarding R4 Has sandbox Uses API platform Reference data

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