By Interface Type

FHIR

FHIR, or Fast Healthcare Interoperability Resources, provides a lightweight REST-based access layer for standard HL7-defined data models. If you're looking for more than specs, check out FHIR development sandbox for how you can get client IDs and testing support.

AdverseEvent

The AdverseEvent resource returns data about an event that caused unintended physical injury resulting from or contributed to by medical care, a research study, or other healthcare setting factors. These events might require additional monitoring, treatment, or hospitalization, or might result in the death of a patient.

AllergyIntolerance

The AllergyIntolerance data models describe a patient's intolerance to a foreign substance and an associated reaction that occurs from exposure.

Appointment, Schedule, Slot

Appointment describes a patient's scheduled visit with a health care provider. The slot resource provides time-slots that can be booked using an appointment. They do not provide any information about appointments that are available, just the time, and optionally what the time can be used for. The Schedule resource is the link from a slot to a practitioner and location for an appointment.

Authentication and Single Sign-On (SSO) explore the specAuthentication and Single Sign-On (SSO) technical specification

Epic recommends and supports the HL7 SMART on FHIR profile of OAuth 2.0, including the EHR launch and standalone launch for both patients and providers, as well as backend services. Epic also supports basic authentication.

Binary

BodyStructure

BodyStructure describes anatomical details about a specimen or body part, including patient information, descriptions, and images. For example, this resource can return tooth information from the patient record.

Bulk Data Access

FHIR Bulk Data Access, also known as Flat FHIR, is a framework for efficiently accessing large volumes of information about a group of individuals. For more information, refer to the HL7 specification, or Epic's FHIR Bulk Data Access Tutorial.

CarePlan, Goal

CareTeam

The CareTeam resource returns information about a patient’s care team and care team members. The care team includes longitudinal care team assignments as well as providers who have had recent visits with the patient. The patient's inpatient treatment team is not included in this resource. Inpatient treatment team members are instead included as participants in the relevant Encounter resource.

CDS Hooks read the specCDS Hooks technical specification

CDS Hooks is an HL7 standard for in-workflow, real-time, provider-facing decision support integration between Electronic Health Record systems and external Decision Support Services. A summary understanding of the specification is necessary for the discussion of state of Epic support for CDS Hooks, so check out the HL7 published specification and current draft specification. Epic recommends against using this feature for other purposes; if you need only a notification, we instead recommend using an event based interface.

Communication

The Communication resource represents a record of communication. This resource can convey details about messages between health systems and community-based organizations about referral requests made through continued care and services workflows in Epic, such as a post-discharge service request for durable medical equipment (DME) or social services.

Condition

The FHIR Consent resource defines a concept around collected consent for some action. Consent resources correspond to Documents in Epic. The Consent.Search interaction returns only metadata about the patient consent document(s) on file, such as the type of consent and the effective period. This resource does not return the consent document itself. Typically this resource is used to check whether a consent document is on file for a particular patient. The Consent resource is intended only for provider-facing applications. Patient-facing applications cannot use this resource.

Coverage

Coverage resources represent an insurance coverage associated with the patient. A patient might have a long list of possible coverages, some of which are applicable only for specific services. Examples include third party liability, worker's comp, black lung insurance, Medicaid for ESRD, Medicare, commercial, etc.

Provides an Epic implementation of the SMART Scheduling Links standard, a lightweight appointment availability publishing API designed to make it easy for organizations to publish COVID vaccine appointment slot availability in cooperation with outside websites, vendors, or government programs.

Technical Specifications:

Device, DeviceRequest, DeviceUseStatement

DiagnosticReport

Document & Image Management read the specDocument & Image Management technical specification

Manage the ability to retrieve and view images and documents that are stored in a third-party Document Management System (DMS). Through these integrations, users can more easily view documents from Epic without separately opening the DMS.

DocumentReference

Encounter

The Encounter resource defines the setting where patient care takes place. This includes ambulatory, inpatient, emergency, home health, and virtual encounters. If you want to store upcoming appointment information, use the Appointment resource instead of Encounter.

Endpoint

The FHIR Endpoint resource describes the technical details of a location that can be connected for the delivery or retrieval of information. The resource contains information on how to connect and for what purposes. This endpoint does not need to be the current system, it can describe locally hosted services, regional services, or national services. Talk to the target organization for their supported protocols when using this resource.

Technical Specifications:

EpisodeOfCare

The EpisodeOfCare resource returns information about a patient's episode of care, including the episode type, care team members, diagnoses, and start and end dates.

ExplanationOfBenefit

ExplanationOfBenefit resources represent claims data received and processed by health plans, including services rendered to a patient and the cost information associated with those services.

FamilyMemberHistory

FamilyMemberHistory describes the conditions, history, and relationship information of a patient's family members.

Flag

Immunization, ImmunizationRecommendation

Immunization describes the details of a vaccine administered to a patient. ImmunizationRecommendation is available only to organizations in the Netherlands, and describes which immunizations are recommended for a patient.

Introspect

The Introspect web service allows an application using OAuth2 secured services to get data associated with an OAuth2 token. One useful function of this service is to allow the client application to determine the user associated with the OAuth2 token.

Technical Specifications:

List

Location

The FHIR Location resource defines details and position information for a physical place where resources and participants can be found.

Medication, MedicationOrder, MedicationRequest, MedicationStatement, MedicationDispense

The Medication, MedicationOrder, MedicationRequest and MedicationStatement data models combine to model a patient's reported and prescribed medication orders and instructions. Medication provides information about each medication, independent of a patient. The MedicationOrder and MedicationRequest resources give a summary of the medication orders placed for the patient along with their status. The MedicationStatement resource gives a full-picture summary of all medications a patient may be taking, whether they are prescriptions or patient-reported medications. The MedicationDispense resource is available only to organizations in the Netherlands, and indicates how a medication product is to be or has been dispensed for a patient.

NutritionOrder

NutritionOrder describes diet order data including oral diets, oral nutrition supplements, enteral nutrition (tube feedings), and infant formula. It can also include details about a patient's food allergies, intolerances, and personal/cultural requirements or preferences.

Observation

This implementation of the Observation resource supports querying for vital signs, lab results, lines drains and airways (LDA-W), obstetric details, core characteristics, and smoking history.

Technical Specifications:

Organization

The read interaction of the Organization resource allows you to look up an organization using a constant server ID. The read interaction allows clients to store only the server ID, and with a single request, retrieve the most up-to-date information about an organization. Read interactions typically begin with a client having previously established a relationship, often through querying for Organization or PractitionerRoles through the search interaction.

Patient

This basic FHIR service covers data about persons receiving care or other health-related services. It focuses on the demographic information necessary to support administrative, financial, or logistic purposes.

Practitioner, PractitionerRole

Procedure, ProcedureRequest, ServiceRequest

Provenance

Provenance returns contextual metadata about the origin of a different resource, such as who authored the data for the target resource, who transmitted it, or which organization such actions were performed on behalf of.

Technical Specifications:

Questionnaire, QuestionnaireResponse

The Questionnaire resource is an organized collection of questions intended to solicit information from patients, providers or other individuals involved in the healthcare domain. The QuestionnaireResponse resource provides a complete or partial list of answers to a set of questions filled when responding to a questionnaire.

RelatedPerson

The FHIR RelatedPerson resource is typically an entity with a personal or professional relationship to the patient. RelatedPersons are often a source of information about the patient. For integrations with Epic, the RelatedPerson is represented by a MyChart account record ID and their link to a Patient record ID. Typically the RelatedPerson represents a MyChart proxy for the patient.

Technical Specifications:

RequestGroup

A RequestGroup represents a group of related requests, such as MedicationRequest or ServiceRequest resources, that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".

ResearchStudy

The ResearchStudy resource includes general information about the research studies tracked in Epic, including the title, status, identifier, and principal investigator. These studies focus on the safety, efficacy, comparative effectiveness, and other information about medications, devices, therapies, and other intervention and investigative techniques intended to increase the field of healthcare-related knowledge.

ResearchSubject

The ResearchSubject resource includes general information about a research subject tracked in Epic, including the study, study arm, consent status, and other key items. Epic tracks human beings only for research associations.

Specimen

The specimen resource covers substances used for diagnostic and environmental testing. The specimen resource focuses on the process for gathering, maintaining and processing the specimen as well as where the specimen originated.

Substance

Substance returns basic information about a substance, such as the code or set of codes that identify the substance. For example, this resource can describe an electrolyte ion component of a total parenteral nutrition (TPN) medication.

Task

The Task resource describes activities and tracks the completion state of those activities. It includes details such as the description of the task, the patient to whom it applies, who is expected to perform the task, and the task’s status. This resource can be used to track tasks associated with referral requests made through continued care and services workflows in Epic, such as a post-discharge service request for durable medical equipment (DME) or social services.

ValueSet

The ValueSet resource represents a subset of the codes in a code system that is supported by a given server. The $expand operation of the ValueSet resource can be used by a FHIR API consumer to determine what values to expect back from the server as a result of a Read or Search operation and what values they can pass in to the server when performing a Create or Update operation.

Technical Specifications: