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

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

In production Deprecated Retired

Electronic Prescription Service - FHIR API

Access the Electronic Prescription Service (EPS) - the national service used to send electronic prescriptions from GP surgeries to pharmacies.

FHIR Outpatient Prescribing Dispensing REST API Central Has sandbox R4 Uses API platform Internet facing GP / primary care Uses OAS CIS authentication

In production

EPS FHIR Dispensing API

Use this API to access the Electronic Prescription Service (EPS). EPS is the national service used to send electronic prescription messages between prescribers and community dispensers.

FHIR Outpatient Dispensing REST API Central Has sandbox R4 Uses API platform Internet facing Uses OAS CIS authentication

In production

EPS FHIR Prescribing API

Use this API to access the Electronic Prescription Service (EPS). EPS is the national service used to send electronic prescription messages between prescribers and community dispensers.

FHIR Outpatient REST Central Has sandbox R4 Uses API platform Internet facing GP / primary care Uses OAS API CIS authentication

Internal In production

EPS Prescription Tracker FHIR API

Provides real-time tracking of prescriptions within the Electronic Prescription Service (EPS) and enables authorised users to retrieve details about prescription status and dispensation progress.

Pharmacy Hospital FHIR REST Internet facing CIS authentication Dispensing Prescribing Uses API platform Urgent and emergency care Community health API GP / primary care

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

Retired

Legitimate Relationship Service - HL7 V3 API

Access patients' Legitimate Relationships (LR) using our HL7 V3 API.

Hospital Access to records Information governance HL7 V3 API Central Has adaptor CIS authentication