API and integration catalogue

In production Under review for deprecation

Access Control Service HL7 V3 API

Manage patient consent to share their information, including their Summary Care Record (SCR), with the Access Control Service.

Community health Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 Access to records Mental health OOH GP Pharmacy HL7 V3 API Central CIS2 authentication

In development Internal

Address Quality Service API

Add a Unique Property Reference Number (UPRN) to addresses before they are updated in the Personal Demographics Service (PDS) database.

REST API standard Uses OAS API

In production

Alerts - HL7 V3 API

Send an alert to a Privacy Officer so they can audit whether access to a patient’s data was appropriate.

Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Information governance HL7 V3 API Central Has adaptor CIS2 authentication

In production

Ambulance Data Submission - FHIR API

Submit ambulance data to our Data Processing Service (DPS) for analysis and review by NHS England and ambulance trusts, using our Ambulance Data Submission - FHIR API (formerly Ambulance Analytics).

MESH Urgent and emergency care Ambulance services FHIR API Central Has sandbox R4 Uses API platform Internet facing Uses OAS REST

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

In production

Child Protection - Information Sharing - HL7 V3 API

Access child protection information from Child Protection - Information Sharing (CP-IS) from a healthcare setting.

Community health Hospital A&E / emergency department Inpatient Social care Urgent and emergency care Ambulance services OOH GP Access to records Key care information HL7 V3 API Central Has adaptor MESH Uses digital onboarding CIS2 authentication

Retired

Child Screening API

The Child Screening Domain Message Specification supports the Child Screening Report - A CDA document containing child screening information. 

Messaging Key care information Tests and diagnostics API Intermediary

Deprecated In production

CIS1 Authentication (Spine Security Broker)

Verify the identity of healthcare workers in England, such as NHS staff, using the Spine Security Broker (SSB) component of Care Identity Service (CIS). CIS provides sign-on across local and national digital services using physical and virtual smartcards.

API Central Access to records Security SOAP UI integration

In production

CIS2 Authentication

Verify the identity of healthcare workers in England, such as NHS staff, using Care Identity Service (CIS). CIS2 Authentication uses the OpenID Connect (OIDC) standard to provide sign-on across local and national digital services using smartcards or modern alternatives.

Hospital GP / primary care Urgent and emergency care Ambulance services NHS 111 Security API Central Internet facing Uses digital onboarding UI integration

Internal Retired

COVID-19 Medical Exemptions - FHIR API

Access a patient’s coronavirus (COVID-19) medical exemption status.

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