What is the IM1 Transaction API?
The IM1 Transaction API is part of a broader set of interface mechanisms under the NHS Digital Care Services Framework. These mechanisms enable third-party systems to interact with GP systems such as Cegedim Vision, EMIS Web (and EMIS X GP), and TPP SystmOne. The primary goal of the IM1 Transaction API is to support real-time transactions between consumer systems (applications designed for patient care) and provider systems (the GP’s core IT systems). It enables consumer applications to access, retrieve, and update patient data, manage appointments, and store clinical records securely.
As healthcare increasingly adopts digital tools, such integrations are vital for streamlining administrative processes, reducing redundancy, and ensuring that healthcare providers have the most up-to-date patient information at their fingertips. The IM1 Transaction API allows systems to search for patients, retrieve medical records, manage consultations, and file documentation, among other tasks, enabling more efficient workflows for GPs and better care for patients.
Key Capabilities of the IM1 Transaction API
1. Patient Information Maintenance: One of the fundamental features of the IM1 Transaction API is its ability to manage patient information. This includes:
- Search Patient: The API allows systems to search for patients using various demographic details such as the patient’s name, date of birth, and NHS number. The ability to search for patients by different parameters ensures that clinicians can quickly find the correct patient’s records, even when incomplete data is available.
- Get Patient Demographics: Once a patient is located, the API can retrieve the full set of demographic information, which includes essential details like contact information and next of kin. This capability ensures that clinical teams can verify and update patient details, ensuring accuracy in patient identification and communication.
- Update Patient: The IM1 API also allows external systems to request updates to patient data, which can be confirmed and processed within the GP system. This keeps the records current and reduces the administrative burden on clinical staff.
2. Consultation Management: Efficient consultation management is crucial in primary care, where GPs handle large volumes of patient interactions daily. The IM1 Transaction API supports the following functions:
- Get Consultation Records for a Patient: The API enables systems to retrieve previous consultation records, providing clinicians with the context they need to understand a patient’s history before any interaction.
- Create New Consultation Record: The API allows third-party systems to create new consultation records, ensuring that all relevant information from a patient encounter is captured digitally and stored within the GP’s system.
- Add a Document or Attachment to a Consultation Record: External systems can add important documents, such as diagnostic reports or specialist referrals, directly into the consultation record. This reduces paperwork and ensures that all relevant data is centralized within the patient’s record.
3. Appointments Management: Appointment management is a key area where digital integration can significantly improve efficiency. The IM1 Transaction API offers several functions in this area:
- Get Bookable Slots: Systems can retrieve available appointment slots from the GP system, enabling patients or administrative staff to book appointments based on real-time availability.
- Book Appointment: Once an available slot is identified, the API supports the booking of appointments through external systems, ensuring seamless coordination between the patient-facing system and the GP’s appointment book.
- Cancel Appointment: If a patient needs to cancel or reschedule, the API allows external systems to cancel appointments, keeping the GP’s scheduling system updated without requiring manual intervention from practice staff.
4. Documents and Prescriptions Management: Document and prescription management are vital components of a patient’s medical record. The IM1 API allows third-party systems to:
- File Documents into Patient Record: External systems can file important documents, such as referral letters or scanned images, directly into the patient’s record, ensuring that GPs have all necessary information at their fingertips during consultations.
- Retrieve Documents for a Patient: The API allows systems to retrieve documents already filed within a patient’s record, ensuring that clinicians can access historical records quickly.
- Get All Current Medications: The API enables systems to retrieve a list of a patient’s active medications, providing a clear and up-to-date view of their current treatment plan.
- Prescribe a Drug for a Patient: The API supports the digital prescription of medications, allowing GPs to issue new prescriptions or renew existing ones directly from integrated systems.
5. Real-Time Data Access and Updates: The real-time nature of the IM1 Transaction API ensures that changes made in either the GP system or a connected third-party application are instantly reflected across systems. This reduces the risk of outdated or incomplete information being used for patient care, making healthcare delivery more responsive and accurate.
How to Integrate with the IM1 Transaction API
To integrate with the IM1 Transaction API, third-party providers must go through an onboarding process managed by NHS England. This process involves:
- Completing the IM1 prerequisites form: This ensures that the application meets all clinical and information governance requirements – https://digital.nhs.uk/services/gp-it-futures-systems/im1-pairing-integration/im1-prerequisites-form
- Compatibility Assessment: The consumer system is assessed to ensure it is compatible with the provider’s APIs.
- Model Interface Licence: Once compatibility is confirmed, both parties must execute a Model Interface Licence, giving the third-party provider access to the API.
- Development and Testing: After gaining access to a test environment, the third-party provider can begin development, followed by testing in collaboration with the GP system provider.
- Assurance and Live Rollout: Upon successful testing, the solution is assured by NHS England and rolled out to live GP practices.
Conclusion
The IM1 Transaction API is an essential tool for ensuring integration between GP systems and third-party healthcare applications. By providing real-time access to patient records, appointment management, consultation documentation, and prescription information, the IM1 API supports efficient, patient-centered care. For healthcare providers looking to enhance their digital capabilities, integrating with the IM1 Transaction API offers a pathway to better patient outcomes and streamlined administrative processes.