Understanding the IM1 Bulk API
The IM1 Bulk API facilitates the extraction of comprehensive datasets from primary care EHR systems, enabling healthcare organisations to access, analyse, and leverage patient data more effectively.
The IM1 Bulk API supports daily bulk data extraction from SystmOne and EMIS, offering a consistent and reliable method to obtain large volumes of data in a structured format. Accessing the IM1 Bulk API can be pivotal for organisations aiming to enhance data-driven decision-making and streamline reporting processes.
Extracting Data from SystmOne
To extract data in bulk from SystmOne via the IM1 Bulk API, there are several steps that a SystmOne organisation must complete.
Organisations must first configure SystmOne to enable Strategic Reporting, and configure a ‘reporting unit’ to act as the central hub for configuring extracts. The reporting unit can then configure a strategic reporting organisation group (which will include the units whose data will be extracted). Once the SystmOne organisation is configured, users can configure strategic reports to tailor the data extraction to their specific needs, including selecting specific tables and fields. Configuration parameters such as the file delimiter, text qualifier, extract frequency, root directory for downloads, and a technical contact for notifications can be defined during this process too.
Following configuration, the extracted data is delivered in CSV format, with each table exported as a separate CSV file. These files are usually securely downloaded to a designated ‘Gateway PC’ or a cloud server running SystmOne. The download process occurs over a secure TCP channel, usually with redundancy and retry mechanisms in place to ensure data completeness. To enhance data integrity, files are temporarily stored and renamed upon receipt of a complete dataset, allowing for validation. Additionally, an SRManifest file is created for each download, detailing the extracted information and enabling users to monitor the process.
Extracting Data from EMIS
EMIS Health supports bulk data extraction through its Extraction IM API. Similar to SystmOne, this API provides subsets of the clinical record in encrypted CSV files, delivered to a secure FTP site. The configuration process for EMIS involves ensuring sufficient Information Governance (IG) approval for each dataset being extracted, safeguarding personal confidential information. This ensures that data extraction complies with regulatory requirements and maintains patient confidentiality.
EMIS supports two different architectural solutions for data extraction:
The first is a single extract for multiple organisations, where the datasets for each consenting organisation are delivered in a series of encrypted CSV files to a single secure FTP site. This configuration is suited to subsidiary services that report on cross-organisational data from a centrally hosted system. Data is then most commonly downloaded from the secure FTP site directly to the subsidiary supplier’s data centre.
The second solution is an organisation-specific extract, where the datasets for each consenting organisation are delivered in individually encrypted CSVs to organisation-specific secure FTP sites. This configuration is suited to subsidiary suppliers who are providing end-user functionality at an organisational level. Data is most commonly downloaded from the secure FTP site directly into an application hosted by the organisation that is the data controller.
Each dataset from EMIS is protected by a pair of security keys, ensuring secure data transfer and storage. The subsidiary service, responsible for consuming the data, holds the private keys and provides public keys to EMIS Health during the extract setup process. Depending on the configuration, data can be downloaded directly to the subsidiary supplier’s data centre or an application hosted by the organisation.
Benefits of Integrating with the IM1 Bulk API
The IM1 Bulk API is a powerful interface for healthcare organisations seeking to leverage patient data for improved care and operational efficiency.
By facilitating the extraction of large datasets from SystmOne and EMIS EHR systems, the IM1 Bulk API enables detailed analysis, reporting, and data-driven decision-making. Through proper configuration and secure data handling practices, organisations can unlock the full potential of primary care EHR data, driving better outcomes for patients and the healthcare system as a whole.
