IM1 - Interface Mechanism
ID | S47 |
Version | 2.1.2 |
Type | Standard |
Status | Effective |
Effective Date | Oct 6, 2026 |
Contracting Vehicle(s) |
Introduction
IM1 is a mechanism for accessing data held in GP Systems (Systems providing one or more Foundation Capabilities). The interface mechanism should facilitate the following use-cases:
Patient - real-time access to APIs exposed over the Internet supporting both read and limited write / transactional operations for the purposes of Patient/Citizen Facing Services (including registration and authentication of Citizens)
Bulk - Bulk data extracts of all data held by the GP System Supplier
Practice real-time APIs for integrating systems, which may operate locally
Provider Suppliers acting as consumers of their own interfaces must take note of requirements in the Interoperability Standard, particularly those relating to equitable access to functionality and data (Requirement: ISNFR07)
Please also note that suppliers must be compliant with the overarching Commercial Standard, and comply with the Model Interface Licence contained within.
Applicability
A system or application is required to provide IM1 interfaces if it offered IM1 interfaces under GP IT Futures and/or if implementing an IM1 interface is mandated within the Capabilities and Standards.
Where a GP Connect interface capability is available, Provider Suppliers would be expected to develop against that, rather than developing a new bespoke or proprietary interface.
A system or application may wish to consume IM1 interfaces where they have a requirement to access data held in GP Systems and the Provider Solution does not offer a GP Connect interface.
Requirements
This page describes integration requirements for systems which are required to be an IM1 interface provider and\or consumer.
The scope of this document includes:
Generic requirements which allude to best practices in Applications integration, Extract Transformation Loading & API Management
Requirements around some high level API Calls and its expected behaviour in generic terms
Requirements around System Context, Authentication & Version Management
The following are not in scope:
Low level Interface specifications and schema definitions. IM1 interfaces are not built to a standard specification and core system suppliers are currently free to implement in whatever way they see fit, however, suppliers should read the Principles section of the Interoperability Standard and ensure their approach is aligned accordingly. Where applicable they should be able to demonstrate adherence to Principles
Commercial arrangements and charging
Assurance and testing
Mechanisms to get a Consumer Supplier on board and giving access to test environments
Generic Integration Requirements
Monitoring & Response Times
This pertains to individual requests and responses for each message interaction and how these are monitored.
Consumer or Provider | ID | Requirement | IM1 Type | Level |
Provider | im1_resp_001 | The Provider Integration Architecture must be capable of monitoring requests received by various Consumers, including the capture of response times required for processing the request within the confines of the Supplier Data Centre / Cloud boundary | Practice & Patient | MUST |
Authentication and End Points
This refers to how Consumer Systems and Users are authenticated and mechanisms for Consumer systems to access the IM1 interfaces
Consumer or Provider | ID | Requirement | IM1 Type | Level |
Provider | im1_auth_001 | The Provider must provide a seamless process to authenticate Consumer systems and Users without any extra overhead or usability issues User of a Consumer Solution can refer to a patient in case of Citizen Facing capabilities or refer to a healthcare professional or NHS Staff | All | MUST |
Provider | im1_auth_002 | The access to Provider Endpoints should not be constrained by existence of a User Session on the Provider Solution | Practice | SHOULD |
Provider | im1_auth_003 | For the Practice IM1 where feasible, the access to Provider Endpoints should not be constrained by requiring the Consumer integration components to be present within a Practice or within the GP's workstation/PC | Practice | SHOULD |
Provider | im1_auth_004 | The access to Provider file Extracts must not be constrained by requiring the Consumer integration components to be present within a Practice or within the GP's workstation/PC for the Bulk IM | Bulk | SHOULD |
System Context & Invocation
This refers to the context of the User Session within a Provider Solution and its visibility to the Consumer
Consumer or Provider | ID | Requirement | IM1 Type | Level |
Provider | im1_context_001 | The Provider Solution must provide mechanism for Consumer to be kept aware/notified of context information. At the very minimum notification should include
Note: Providers will notify Consumers of state/context changes; Consumers will not be required to poll or repeatedly call the Provider system to establish if there has been a change | Practice | SHOULD |