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 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

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

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

Retired

Crisis Care Extract API

Send a CDA document containing Crisis Care Extract information supporting the sharing of care plans for urgent and emergency care.

Hospital GP / primary care Urgent and emergency care A&E / emergency department Key care information Continuity of care API Messaging

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 CIS2 authentication

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

In production

e-Referral Service - HL7 V3 API

Create paperless referrals or manage appointment slots in secondary care using the e-Referral Service (e-RS) HL7 V3 API.

Hospital HL7 V3 API Central Has adaptor Referrals and bookings

Internal In production Beta

e-Referral Service Patient Care – FHIR API

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

FHIR Patient-facing Hospital Central API Internet facing R4 REST Uses API platform Uses OAS Referrals and bookings

In production Deprecated

Female Genital Mutilation - Information Sharing - FHIR API

Share female genital mutilation (FGM) information for children under 18 with relevant NHS professionals across England using our Female Genital Mutilation (FGM) Information Sharing FHIR API.

FHIR Community health Hospital Mental health Pharmacy GP / primary care Urgent and emergency care Ambulance services NHS 111 OOH GP Key care information API Central DSTU2