Epic is moving the current primary end user application, Hyperspace, to a web-based framework. Hyperdrive, our new client application, is a secure, Epic-specific web browser and code-level changes are required for current web- and desktop-based Hyperspace integrations.
Many Epic workflows rely on integrations with other products for users to complete a task. Hyperdrive is essential for almost all end users largely because it includes a Windows-native plugin infrastructure that enables integrations with other products.
Existing products integrating with Epic via COM-based APIs will need to be updated to work with Hyperdrive. Web applications currently hosted within, or launched from, Hyperspace may require changes. HL7, Web Services, DICOM, XML file drop, SMART on FHIR, and outgoing command line integrations will not require changes.
We have an internal goal to complete our integration points in the calendar year 2021. Organizations expect to begin testing Hyperdrive and their integrations by September 2021, with the first end users using Hyperdrive as their primary mode of access to Epic in early 2022. These timelines are intended to provide a sense of our trajectory, but keep in mind that this is a goal and not a promise.
Additionally, integrations developed for Hyperdrive may not work with the current Hyperspace client. Many organizations will be able to take advantage of Hyperdrive-specific integrations by 2023, and some may not implement Hyperdrive until later.
Desktop Generic Authentication
read the spec
This interface allows external authentication software to implement authentication devices for use in Epic. The external authentication software can write installable devices that can be configured for use as devices to authenticate a user for login into Epic or to re-authenticate the user after login (for example, to sign off on medications).
Subspace Communication Framework
read the spec
The Subspace Communication Framework is a pattern for asynchronous, semi-event-driven integrations between Epic and external applications. This document outlines the steps that an external application must take to initiate and communicate with Epic via a Subspace integration.
Subspace User Session Management
read the spec
This API allows other applications to receive events about and request changes to be made to a user's session in Epic. This includes information about logging in, logging out, securing, and shutting down. The API uses the Subspace Communication Framework.
This API contains information about various requests that can be made using the Subspace Communication Framework that do not directly manipulate the user session state. These requests include launching activities and moving or resizing the Hyperspace window.
This API provides information about two workflows where e-signing functionality is used within Epic: Document Collection and Signature Authentication/Reconstruction. During Document Collection workflows, one or more individuals can sign an electronic document and their signatures will be stored into Epic. Signature Authentication workflows allow a user to authenticate the validity of a signature, and Signature Reconstruction workflows reconstruct signature images from discreetly stored data.
This API is used to integrate the workflow of a web-based criteria review application into the Epic criteria review workflow. The application is launched and hosted within Epic and at the conclusion of the workflow can file reviews into the Epic system for users to view, send to payers, and report on.
Epic has the ability to allow end users to acquire scanned documents via a Document Management System (DMS). This API specifies how to integrate an external desktop scan acquisition application with Epic to allow end users to perform the scanning work and file the documents’ metadata to Epic.
Epic provides ways for users to view scans acquired via a Document Management System (DMS). This API specifies how to integrate a web-based external scan viewing application with Epic for end users to view acquired scans.
XML Context Synchronization
This document contains APIs that can be used for single sign-on, patient context synchronization, study context synchronization, and real-time measurement exchange. These APIs are commonly used with PACS and CPACS vendors, but may have other uses as well. We additionally have an encryption utility
for use with our XML integration (identical to URL encryption). We expect this functionality to work identically with Hyperdrive as it does with Hyperspace
This API allows speech recognition systems to interact with controls and views within Epic. The speech recognition system can receive information about and make changes to the content of a control as well as execute commands on an activity.
FHIRcast is a web based integration method used for context synchronization between Epic and other applications. This API is used to ensure that all applications display the same patient or study.
Credit Card and Bank Account Integration
This interface communicates with payment gateways to integrate credit card and bank account payments directly into Epic. Payment methods can be saved and used for automatic payment plans.