EXPLORE
By Interface Type HL7V2 HL7V3
. INTEROPERATE
. MY APPS
. CONTACT
LOG IN
HL7v2 Health Level 7 standardizes data interchanges within and across organizations. It's one of the most widely implemented standards for health-related data. You can learn more about this standard from HL7.
IHE PROFILES FHIR WEB SERVICES DICOM NCPDP ASC X12 COM FLAT FILES OTHER
Incoming Patient Administration
read the spec
In this scenario, patient identity and registration changes can be made in your system. This interface enables the Epic system to receive messages for new or changed demographic information, visits (ADT), registration information (guarantors and insurance coverages), allergies, and bed status updates. Current integrations include...
Incoming Bed Status
read the spec
The Standard HL7 Incoming Bed Status interface, which is a subset of the full Incoming Registration and ADT interface, processes bed status updates using the ADT^A20 message type.
Outgoing Patient Administration
read the spec
In this scenario, the Epic EMR is the system of record. It informs external systems of new patient creation, changes to patient demographic information, visits (ADT), registration information (guarantors and insurance coverages), allergies, and bed status updates. The ability to send allergy updates is only applicable if the organization is using Epic's Allergies feature and needs to send allergy updates to an external system. This interface does not send final coded diagnoses, procedures, or DRGs after a hospital account is coded. Current integrations include...
Outgoing Bed Status
read the spec
The Standard HL7 Outgoing Bed Status interface, which is a subset of the full Outgoing Registration and ADT interface, transmits bed status updates using the ADT^A20 message type.
Incoming MPI and Demographics Query
read the spec
In this scenario, the Epic EMR system is the Enterprise Master Patient Index. External systems can query the Epic system to find an existing patient and receive that patient's unique identifiers along with core demographics. Current integrations include...
Outgoing MPI and Demographics Query
read the spec
In this scenario, a user of the Epic EMR is attempting to search for a patient. First, a search is performed on the MPI local to the Epic system; then, the Epic system queries an external EMPI. The user can then select the correct patient from a list of candidates returned in the response message. This is not an HL7v3 PIX/PDQ query - see this section for more information. Current integrations include...
Outgoing Address Verification Query
read the spec
This interface allows you to query a third-party system to verify and validate patient-level and guarantor-level demographic data the time of registration. This interface works with Prelude - Epic's registration system. Current integrations include...
Outgoing Imaging Orders and Results
read the spec
Order information and textual result information available through Radiant and Cupid (Epic's radiology and cardiology modules) can be communicated to external systems such as a PACs or transcription system using HL7v2 interfaces. Information about the imaging order can be sent when it is scheduled or canceled, when the patient arrives, when the status of the order changes, and when the order is resulted. Current integrations include...
Outgoing Dietary Orders
read the spec
The inpatient clinician places an order to restrict the patient to a particular diet while he is in the hospital. This HL7v2 interface sends a message to an external nutrition system when dietary orders are created or canceled. Current integrations include...
Incoming Pharmacy to EpicCare Ambulatory
read the spec
When Epic's outpatient clinical software (EpicCare Ambulatory) is used with a third-party pharmacy system, this interface is used to integrate the two systems via HL7v2 interfaces. This interface receives medication order information from the system. It can encode and cancel orders, track and cancel dispenses, and update the originator of a refill order.
Outgoing Pharmacy Orders from EpicCare Ambulatory When Epic's outpatient clinical software (EpicCare Ambulatory) is used with a third-party pharmacy system, this HL7v2 interface is used to integrate the two systems. This interface sends new orders and order updates to the pharmacy.
Incoming Pharmacy Dispense and Load/Unload
read the spec
When a medication is removed (and either used or discarded) or returned to a medication cabinet or automated dispensing station, the system sends a message to the Epic pharmacy system in use. Messages are also sent when a drawer, pocket, or bin is emptied or stocked. This interface is used to keep track of medication inventory in Epic's pharmacy system. Current integrations include...
Outgoing Inpatient Pharmacy Orders and Console Management These HL7v2 interfaces send a message when a pharmacist verifies an
read the spec
order in Epic's inpatient pharmacy software. The Outgoing Inpatient Pharmacy Orders interface is typically used with cabinet, robotic, TPN, or carousel dispensing systems. It is sometimes used to transmit medication orders to an external medical record or surgery system. Messages are triggered from the inpatient pharmacy software when the user verifies, re-verifies, discontinues, or modifies an order, reverses a discharge, changes a patient's location such that the dispense location changes, or loads a medication into a station that did not previously contain that medication. The Console Management interface is used to populate the master medication list of an automated dispensing station when a medication is added or removed from your formulary. Current integrations include...
Outgoing Prescriptions to an Automated Fill System
read the spec
This Hl7v2 interface sends a message to an automated fill system when Epic's outpatient pharmacy software is used to verify a prescription fill. Current integrations include...
Incoming Prescription Status Updates from an Automated Fill read the spec System When an automated prescription fill system fills, dispenses, or cancels a prescription, this HL7 V2 interface is used to update the status of the prescription in Epic's outpatient pharmacy software. Current integrations include...
Incoming Ancillary Results
read the spec
The Epic EMR receives test results from a laboratory, cardiology, or similar information system for use in Epic. These results include general lab, microbiology, pathology, and blood bank results, results with a narrative/impression, and hyperlinks to results that are stored elsewhere. These results can include LIS data, RIS data, pacemaker data, ECG records, and hemodynamic data. The interface can accept incoming order messages that request order numbers, replace procedures, or cancel existing orders. This HL7v2 interface is specific to a clinical order and uses TCP/IP to exchange messages. Current integrations include... Test your implementation with our HL7 V2 Validator.
Incoming Lab Instrument Results
read the spec
This HL7v2 interface integrates resulting instruments into Epic's lab software, typically through a middle tier. This interface is also used for point-of-care testing integration, such as with docked glucometer systems. Current integrations include...
Outgoing Lab Instrument Orders
read the spec
This HL7v2 interface is used with Beaker, Epic's lab software, to send lab orders to resulting instruments. This interface is also used for point-of-care testing integration, such as with docked glucometer systems. It can trigger messages when the lab receives a new specimen, a test is reordered, an add-on is added onto an existing specimen, or a test is canceled. Current integrations include...
Incoming Orders from CPOE
read the spec
This HL7v2 interface is used to receive orders from an external order entry system, either to be performed within Epic (Beaker, Radiant, Cupid) or to pass on to external ancillary systems. It can create, update, or cancel orders. Current integrations include...
Outgoing Ancillary Orders
read the spec
This HL7v2 interface sends a message to external ancillary systems for new orders and order cancellations. It also is used when the EMR responds to number assignment requests for externally initiated orders. It can be used to send clinician-placed orders to external lab, radiology, or cardiology systems for organizations that are not using those Epic applications. It can also send orders from Epic's lab system to a blood bank system or to an external LIS if a test needs to be resulted at another lab. Epic's inpatient documentation system can use this interface to communicate diet orders to external nutrition systems. Current integrations include...
Outgoing Lab Orders and Results
read the spec
This HL7v2 interface is used to communicate lab test results from Beaker (Epic's laboratory information system) when Epic is the reference lab for another LIS or clinical system. It sends messages when the user accessions or cancels an order, or when a result is marked as preliminary or verified final. Current integrations include...
Incoming Transcriptions
read the spec
In this scenario, an external system has findings in a text or image format. These findings are either observations from a given contact with a patient (such as a visit or a hospitalization) or observations specific to a clinical order. Traditionally, this interface was used to match dictations with their eventual transcription (hence the name), but it can be used for a broader range of clinical findings. The EMR receives and files documents from a transcription system, scanned documents from an external document management system, or notes generated in another clinical system. This interface is often used for clinical findings that don't neatly fit into more specific data elements. Notes created or updated by the transcription interface can trigger deficiency updates. If your intent is to file findings against a specific order, please email us to learn more. Other interfaces may be more appropriate for your use case. Current integrations include...
Incoming Device Data
read the spec
In this scenario, the Epic EMR receives discrete measurements from patient monitoring and documentation devices. The messages file to an application where the data can be validated by the user and added to the patient's chart. This type of integration is usually done with device aggregators to file samples from continuous physiological monitoring. It is not typically used for consumer-initiated monitoring or home monitoring. Current integrations include... Test your implementation with our HL7 V2 Validator.
Incoming Documentation Flowsheet Data
read the spec
In this scenario, the Epic EMR receives discrete measurements documented and validated in another system. Unlike the Incoming Device Data interface, this data is filed without intervention and is typically documented by a human (not a device) in an external system. This data changes over time and the change is clinically relevant - for example, a cervical exam performed on a laboring patient. Current integrations include...
Incoming Procedure Log Data
read the spec
This interface is used for cardiac catheterization, electrophysiology, and interventional radiology procedures. When Epic's procedure log (Cupid) is used for intra-procedure documentation, this interface links data from a hemodynamic product that collects vitals and pressures during the procedure. This interface can file information to flowsheets and free-text events so that it appears on the Cupid procedure log. Current integrations include...
Incoming Problem List
read the spec
The incoming problem list interface is used to add, modify, or remove problems from the patient-level problem list. This interface works specifically with the longitudinal problem list, not problems specific to a particular hospitalization. At this point, this integration has been done only with our organization's in-house products.
Outgoing Documentation
read the spec
In this scenario, a user documents a note in the Epic EMR. This interface notifies external systems and sends notes and transcriptions as they are saved and modified. It can also send a document summary after an outpatient encounter is closed. This interface sends this content as an HL7 v2 MDM message. The content can be plain text, rich text, or an embedded PDF document. This interface sends text. Different interfaces can send Consolidated Clinical Document Architecture-built Continuity of Care (C-CDA) Documents. Current integrations include...
Outgoing Documentation Flowsheet Data
read the spec
In this scenario, a user documents in a flowsheet in the Epic EMR. This data is then sent to the external system. Typically, this data is recorded by a nurse during a hospitalization. Current integrations include...
Outgoing Problem List
read the spec
The outgoing problem list sends notification of added, modified, or deleted problems from the patient-level problem list in the EMR to an external system. This interface works specifically with the longitudinal problem list, not problems specific to a particular hospitalization. Current integrations include...
Patient Education
read the spec
This interface integrates Epic's Patient Education activity with a third-party education content management or content delivery system. The interface is used to send clinicianinitiated education assignments to the third-party system so the patient can view or act on the content there. It can also record if the patient has completed the educational assignment, and it can also be used torecord ad hoc educational activities that were not assigned by the clinician. You may implement the Incoming spec, the Outgoing spec, or both. Current integrations include...
Electronic Fetal Monitoring This family of HL7v2 and other interfaces is used to integrate electronic fetal monitoring systems more tightly with inpatient workflows in the Epic EMR. The interfaces control establishing a shared identity with the EFM system, transmitting monitor vitals information from the fetal monitor to Epic, and associated documentation done in Epic with the fetal strip. Current integrations include...
Home Monitoring Device Interfaces
read the spec
This family of HL7v2 interfaces is used to manage a home-monitoring program in which the clinician provides a home monitoring device to the patient and instructs him to record his findings over time. Typically, the device and its readings are managed by a device data concentrator, which collects data through a base station and then sends it to the EMR. Current integrations include...
Incoming Financial Transactions
read the spec
This HL7v2 interface is used to receive charges from external systems. These charges pass through the rules-based routing in the EMR to eventually be charged to the appropriate account (hospital billing, professional billing, or a different external system). Charges are subject to checks and can be routed to workqueues for further processing. Current integrations include...
Outgoing Financial Transactions
read the spec
This HL7v2 interface is used to send charges to an external billing system. Current integrations include...
Incoming EOB Image
read the spec
When a user scans an explanation of benefits (an EOB) in a third party system, this message notifies Epic's billing applications. Scanning an EOB will open a new payment batch in the appropriate billing application based on the type of the scan. Current integrations include...
Outgoing Claim Scrubber Query
read the spec
This family of APIs is used to scrub your professional charges and claims through a thirdparty system. Current integrations include...
Coding - Bidirectional
read the spec
This bidirectional interface is used to integrate with encoders and computer-assisted coding systems to exchange coded information for Hospital Coding workflows. Current integrations include...
Coding - Outgoing
read the spec
Separately, the outgoing interface can be used to send the final coded information to downstream systems such as care management products. Current integrations include...
Coding - Incoming Query and Response
read the spec
The incoming coding interface supports workflows in which coders are working entirely in your system. Coders in your system send messages to providers using Epic asking for more information to support their documentaiton (CDI or Coding Query). Responses are sent in return.
Outgoing Referral - HL7 This HL7v2 interface transmits patient referral information to an external system, such as when a primary care provider refers a patient to a specialist. Users initiate referrals either from Epic's referrals module or through clinical orders.
Incoming Location and Department Information
read the spec
This HL7v2 interface is used to automate synchronization of the logical facility structure within the EMR with an external system for facility management. Specifically, this interface updates records and contact information for hospital and clinic locations and departments. To this point, this integration has been completed only with custom in-house systems previously developed by our organizations.
Incoming Deficiency Tracking
read the spec
An HIM deficiency represents incomplete work by a provider. This interface will make an organization's deficiency tracking more robust by integrating information captured by external systems. Deficiencies can be created directly in the EMR for tracking, or they can be configured to run through native functionality to determine aging and delinquency statuses. Current integrations include...
Incoming Provider Information
read the spec
This HL7 interface is used to integrate more tightly with an external credentialing system. Specifically, it is used for those persons who will act as practicing clinicians or clinical care providers in the EMR. Messages are sent when the third-party credentialing system is used to create, update, inactivate, or delete providers. Current integrations include...
Outgoing Provider Information
read the spec
This interface sends a message to a third-party credentialing system or other system whenever the EMR is used to create, update, inactivate, or delete a record for a clinical care provider. Current integrations include...
Incoming Materials Management
read the spec
These messages are used to automate synchronization of supply definitions from an external materials management system to the EMR. The interface can add or modify properties of these items such as the supplier from whom they were purchased and the physical location in which they are stored. Current integrations include...
Incoming Pharmacy Dispense and Load/Unload
read the spec
When a medication is removed (and either used or discarded) or returned to a medication cabinet automated dispense system, the system sends a message to the Epic pharmacy system. Messages are also sent when a drawer, pocket, or bin is emptied or stocked. This interface is used to keep track of medication inventory in Epic's pharmacy system. Current integrations include...
Incoming Instrument Management
read the spec
These messages are used to automate synchronization of surgical instrument records from an external instrument management system to the EMR. Current integrations include...
Incoming Procedural Supply Usage
read the spec
When supplies or implements are used over the course of surgery, this HL7v2 interface updates the surgical procedure log in OpTime, Epic's surgical module. Current integrations include...
Outgoing Inventory Depletion
read the spec
This HL7v2 interface is used to inform an external materials management system of supplies that have been using during a procedure. It indicates which supply was used, from where the user picked the supply, and the number by which the external system should decrement the balance of the supply. These messages are triggered from within Epic's surgical, radiology, and cardiology software applications. Current integrations include...
Incoming Surgical Cart Tracking
read the spec
This interface files information to OpTime about OR cart assignment to a case. To this point, all integrations have been done with customer-specific homegrown systems.
Outgoing Clinical Results (Electronic Laboratory Reporting) This interface sends clinical results (lab, imaging, etc.) from Epic. It also
read the spec
allows organizations using Epic to meet the Meaningful Use objective to send reportable results to public health agencies. This interface uses TCP/IP to exchange messages. Current integrations include...
Incoming Vaccination Administration
read the spec
This interface is used to notify the EMR that a vaccination has been administered for a patient in the Epic system. It is typically sent by an external system used to administer vaccinations. Current integrations include...
Outgoing Vaccination Query
read the spec
This HL7v2 interface is used to query an immunization registry for information when a patient presents for care. The registry responds with historical immunization data. Some registries additionally supply immunization forecast data. This interface uses TCP/IP to exchange messages. Current integrations include...
Outgoing Vaccination Administration
read the spec
When a vaccine is administered to the patient and documented within the EMR, this interface sends information about the administration to either an immunization registry or another clinical system. Current integrations include...
Outgoing Syndromic Data
read the spec
This HL7v2 interface allows organizations using Epic to meet the Meaningful Use objective to send syndromic surveillance data to public health agencies. This interface uses TCP/IP to exchange messages. Current integrations include...
Incoming Appointment Scheduling
read the spec
In this scenario, an external system schedules an appointment that needs to be represented in Epic's scheduling system. The external system sends messages for new, rescheduled, updated, or canceled appointments, which are then reflected in the EMR. It can also receive information about appointment events, like check-in, check-out, or that a patient did not show for an appointment. Current integrations include...
Incoming Schedule Query
read the spec
In this scenario, the Epic EMR receives a request regarding a specific patient and responds with information about that patient's scheduled appointments.
Incoming Surgical Case Tracking
read the spec
This interface is used to keep Epic's surgical case tracking system in sync with external systems used for tracking surgical case events. Messages carry information about the timing and sequence of events for a surgical case. Current integrations include...
Outgoing Appointment Scheduling
read the spec
In this scenario, a user schedules or modifies an appointment in Epic's scheduling system. Messages are sent for new, rescheduled, updated, and canceled appointments, as well as appointments that are marked as arrived, complete, or no-shows. (This interface is not used to send surgical case schedules - see below.) Current integrations include...
Outgoing Surgical Case Scheduling
read the spec
When a user schedules or updates a surgical case in Epic, this interface communicates that information to downstream systems. Messages are sent for new, rescheduled, updated, and canceled cases. Current integrations include...
Incoming External Encounters The Incoming External Encounters Interface receives data about encounters that happen outside of your organization. These encounters can then be used by care managers to follow up with the patient or by Epic population health tools for analytics.
Incoming Scanned Document Link
read the spec
Receives and files scan pointers from an external document management system. This interface does not file textual data intended for use in Radiant or Cupid; those documents must be processed by the Incoming Ancillary Results and Orders interface set up as an Incoming Ancillary Results and Orders - Imaging interface. Messages must be in HL7 MDM format. Documents processed by this interface can satisfy deficiencies in the Health Information Module.
Outgoing Scanned Document Link Maintenance
read the spec
Sends updated document link keywords to a DBMS system when key information about where the content is located changes, for example, if a scan that originated in the DBMS is moved from one encounter to another by HIM Chart Correction processes.
Incoming Fill Status from Automated Fill System to Willow read the spec Ambulatory Processes Filled, Verified, Dispensed and Cancelled statuses from automated prescription fill systems. The status of the prescription can be viewed in Willow Ambulatory.
Outgoing Fills to Automated Fill System from Willow Ambulatory Transmits verified pharmacy fills to automated prescription fill systems.
read the spec
Outgoing Medication Stock Transfer Request and Response Initiates a fill in a dispensing system-such as robotic arm or carousel-to
read the spec
assist in sending medications from the pharmacy to a hospital floor. This interface also receives acknowledgments from the dispensing system, which updates stock counts in Willow Inventory Management accordingly. For example, if a user requests five bottles of a certain medicine, but only four exist in stock, the interface updates the stock count being sent to the floor to four. Note that the purpose of messages sent by the interface is to request stock for a hospital floor. For that reason, the messages aren't patient-specific.
Outgoing Medication Administration Notification
read the spec
Sends medication administration notification when a clinician marks a medication as administered on the MAR. This interface also sends updates regarding prior administrations, and change of status notifications for medications previously marked as administered. It does not send due times for medications that need to be administered in the future. The interface does not send messages when clinicians document the administration of blood products on the MAR or patient-controlled analgesia (PCA) medications on a documentation flowsheet.
Incoming Medication Administration Notification
read the spec
Files a report containing administration information to a medication order created and acted on in an external system. The read-only reports appear on the MAR for reference.
Incoming Medication Inventory Management
read the spec
Updates medication stocks in Willow Inventory with changes in medication stocks in an external inventory location.
Outgoing Medication Inventory Depletion Communicates changes in medication stock between Willow Ambulatory and an external inventory location.
Incoming IVR Account and Demographics Query
read the spec
Receives requests from an external integrated voice response system for hospital account summaries, recent statements, and recent payments. It can also queue requests for template letters.
Incoming Injectable Medication Documentation
read the spec
Files injectable medication administration information from intravenous drug delivery devices directly to a patient's medication administration record (MAR). This eliminates the need to manually enter medication and dosage information, which increases accuracy and enables clinicians to focus on patient care. A dedicated copy of the Outgoing Patient Administration interface is required to associate the external medication management system-usually a tablet computer linked to a specific medication administration device-to a patient and workstation. This linkage enables the Incoming Injectable Medication Documentation interface to file the medication administration information to the correct patient record. Requires Anesthesia or similar application license.
Incoming Infusion Documentation
read the spec
Receives discrete measurements from an infusion pump gateway associated with the administration of an infusion order. This is an advanced interface with a particular set of prerequisites for successful implementation.
Outgoing Infusion Orders
read the spec
Sends infusion order details to infusion pump gateways for the purposes of prepopulating infusion parameters on associated infusion pumps. When an infusion order message is sent on the Outgoing Infusion Orders interface, an immediate response is expected back from the infusion pump gateway via the Incoming Verification interface. These are advanced interfaces with a particular set of pre-requisites for successful implementation.
Incoming Blood Product Matching to BPAM
read the spec
This interface is included with the Blood Product Administration Module and facilitates matching (positive patient identification with blood) of blood products received from an external blood bank system.
Outgoing OCIO Medication Orders from EpicCare Ambulatory Sends outpatient and discharge medication orders to a pharmacy
read the spec
information system. This interface supports a subset of HL7 version 2.4 according to the specifications defined in the Clinical System Medication Management Interface Specification version 10.1 published by the Office of Chief Information (OCIO).
Outgoing Results Query to Ontario Lab Information System Sends a patient level query to the Ontario Laboratories Information System (OLIS) when a patient checks in for an appointment, and receives results OLIS returns in response to the query. The query can also be initiated on demand by a user at any time. Follows eHealthOntario OLIS Interface Specification R01.20. www.ehealthontario.on.ca.
Incoming WCTP Push Notifications and Patient Care Device Alerts Stores technical and physiological alert data from patient care devices such as physiological monitors and infusion pumps. This data is typically used for administratorlevel reporting.
Outgoing Patient Waiting Time from Patient Administration System Organizations in Ontario can collect information in diagnostic imaging and surgical workflows to report to Cancer Care Ontario's Wait Time Information System (WTIS) requirements.
Incoming Referral Notification Receives patient referral information from an external system. The interface can create, update, and cancel referrals in Epic.
Copyright © 2018 Epic Systems Corporation. All rights reserved. EU Privacy Policy Terms and Conditions (608) 271-9000 HL7, CDA, CCD, FHIR, and the FHIR [FLAME DESIGN] are the registered trademarks of Health Level Seven International. ONC CERTIFIED HIT® is a registered trademark of HHS.
