Guide to NHS APIs

NHS

API	Access Route	Patient Information available	Implementation	Notes	Time	Assurance Complexity
IM1 - Patient	Internet via either NHS Login or Linkage Codes	Appointments, prescriptions, and medical records	EMIS=REST; TPP=REST; INPS Vision=SOAP	IM1 patient allows patients to access their own medical records and prescriptions through patient care applications outside of an NHS practice	4 months	Moderate
IM1 - Transaction	Within GP practice with direct integration with partner system	Patient medical records Patient prescriptions	EMIS=REST; TPP=REST; INPS Vision=SOAP	IM1 transaction allows medical personal within a practice to access most patient information and to modify patient records and prescriptions	4 months	Moderate
IM1 - Bulk	Within GP practice with direct integration with partnet system.	Daily, weekly or monthly extracts of bulk patient data	EMIS=REST; TPP=REST; INPS Vision=SOAP	IM1 Bulk allows a GP practice to get frequent updates on bulk clinical data. Data retrieved can be up to 24 hours old and is therefore not recommended for direct patient care.	4 months	Moderate
GP Connect - Access Record	HSCN line	Clinical information including, current and past prescriptions, repeat prescriptions, current and past medical issues, allergies and more.	FHIR via SSP (Not RESTful)	Access records allows medical personal within a GP to view patient medical but does not allow modification of records. The API can only currently be accessed from within the PCN, usually within a medical practice.	2 Months	High
GP Connect - Appointment Management	HSCN line	Patient appointments and GP appointment availability.	FHIR via SSP (Not RESTful)	Appointment management allows medical personal to book and manage patient appointments. A medical practice can allocate appointment slots to be managed by GP Connect. The API can only currently be accessed from within the PCN, usually within a medical practice.	2 Months	High
GP Connect - Send Document	HSCN via authorised application	None	FHIR over MESH (MESH is RESTful)	Send document allows medical personal within a care facility to send a PDF to a patients registered GP system.	2 Months	High
MESH	HSCN line	None	RESTful API	This is a prerequisite for GP Connect.	4 Weeks	Moderate
PDS FHIR (Application restricted)	Internet	Demographic information available, Restricted information flag, replaced NHS id of a single patient	RESTful API	Does not require HSCN line.	4 Weeks	Moderate
PDS FHIR (Health worker access)	HSCN or internet with strong authentication	Demographic information available, multiple results on wild card allowed	RESTful API	Allows a health care worker to search for, retrieve, and update the demographic information for patients.	4-6 weeks	High
PDS FHIR (Patient Access)	Internet via NHS Login	Summary Care record of the authenticated patient	RESTful API	Allows individiual patients to retrieve and update their own demographic information.	2 Weeks	Not known*
SCR FHIR	Requires strong authentication either via Smart card on HSCN or modern alternative via the internet	Summary Care record of the patient available	RESTful API	Allows a strongly authenticated health care worker to view and update a patients summary care record.	2 weeks	Not known*

NHS API Related Terms

General Terms	Description	Notes
IM1	IM1 is not a single API but an integration standard defining how clinical system providers should allow access to clinical data. The standard defines 3 primary APIs, Patient, Bulk and Transaction, each of which we can include distinctly. HSCN is not needed to access to GP systems, as they each have their own secure access mechanisms.	There are three different APIs, one for each GP Clinical System: TPP, EMIS and INPS Vision.
GP Connect	GP Connect is not a single API but a collection of APIs. Uses HSCN and ODS code as the access route.	GP Connect allows authorised clinical staff to share and view GP practice clinical information and data between IT systems.
HL7 CDA	HL7 CDA is a data exchange standard rather than an NHS API.	Requires HSCN as the access route. A Clinical Document Architecture (CDA) can contain any type of clinical content - e.g., Discharge Summary, Imaging Report, Admission & Physical, Pathology Report etc.
HL7 V3	HL7 V3 is a global standard for health care data exchange. HL7 V3 is the predecessor to FHIR	This API will be retired on 31 March 2023. Not available for new onboardings. Requires HSCN as the access route.
DM+D Database	The NHS Dictionary of Medicines and Devices (dm+d) is the NHS standard dictionary for medicines licensed in the UK, and is a cornerstone of the Electronic Prescription Service, since Pharmacy and GP system suppliers adopt or map to the information included within it.	Need to create your own login (free). Access route is Internet.

We're Easy To Talk To - Tell Us What You Need

enquiries@blueberry-health.co.uk