Free checklist

    Epic integration planning checklist

    Use this Epic integration checklist before you write code. It covers the use case and sponsor, the access path, FHIR scopes, the work on the health system's side, testing and go-live, so your plan matches how Epic customers review and switch on integrations.

    For digital health founders and product teams whose first health system customer runs Epic.

    What does the Epic integration checklist help you decide?

    The Epic integration checklist helps a product team decide how their app should connect to a health system running Epic: which access path to use, which FHIR resources and scopes to request, what the customer's Epic team must do and what has to be tested before go-live. It turns Epic integration requirements into an ordered plan.

    Last reviewed by the Agnotic Technologies engineering team

    What needs to be in place at each phase?

    Six phases in the order they usually happen. Phases 1 and 2 decide whether the project can start; phases 3 to 6 are the build. Your ticks stay in this browser tab and are not sent anywhere.

    0 of 23 tasks ready

    1. Use case and sponsor

      0/4
    2. Access path and registration

      0/4
    3. Data and scopes

      0/4
    4. Build

      0/4
    5. Testing

      0/4
    6. Go-live and support

      0/3
    Access paths

    Which Epic access path fits your use case?

    Five common ways an app connects to a health system on Epic. Which ones a health system will enable is its decision, so confirm early with its Epic team.

    Epic integration access paths compared by who starts them, typical use and standard
    Access pathWho starts itTypical useStandard
    SMART on FHIR, EHR launchA clinician, from inside EpicAn app inside the clinician's workflow that opens on the current patientSMART App Launch, FHIR R4
    SMART on FHIR, standalone launchA patient or clinician, outside EpicA patient app that connects to the patient's record after they sign inSMART App Launch, FHIR R4
    Backend servicesYour server, with no user presentScheduled sync, population data or bulk exportSMART Backend Services, FHIR Bulk Data
    HL7 v2 interfaceThe health system's interface engineReal-time feeds such as admissions, orders and resultsHL7 v2 messages such as ADT, ORM and ORU
    CDS Hooks serviceThe EHR, at a workflow point such as opening a chartRecommendations shown as cards inside the workflowCDS Hooks

    Where do Epic integration projects stall?

    The points where we see plans slip, and the checklist item that prevents each one.

    1. Failure point 1

      No sponsor on the health system's side

      Without an owner who wants it live, the request waits behind internal projects.

      Prevented in Phase 1

    2. Failure point 2

      Scopes added late

      Asking for a new resource or for write access after the security review can reopen parts of that review.

      Prevented in Phase 3

    3. Failure point 3

      Testing only in the sandbox

      Example data does not match a customer's configuration, so mappings break in their test environment.

      Prevented in Phase 5

    4. Failure point 4

      PHI in logs and analytics

      Debug logs and analytics events are an easy place for PHI to leak while an integration is being built.

      Prevented in Phase 4

    5. Failure point 5

      Nobody owns it after launch

      Upgrades on Epic's side or yours need regression tests and a named owner.

      Prevented in Phase 6

    What should you do with the result?

    1. Step 1

      Unticked items in phases 1 and 2 are blockers

      Resolve them with the customer before you estimate the build.

    2. Step 2

      Unticked items in phases 3 and 4 are scope

      They drive Epic integration cost: the number of resources, write access, launch types and how many customer environments you support.

    3. Step 3

      Phases 5 and 6 belong in the project plan

      Give each item an owner on your side and on the health system's side.

    What can the checklist not tell you?

    • Whether a specific health system will approve your app, or which APIs it has enabled.
    • Epic's current program terms, fees or listing requirements. Check open.epic.com and Showroom directly.
    • A price or a timeline. Both depend on the customer's configuration and team, and we work them out on a scoping call.
    Facts and sources

    What do Epic and the standards bodies say?

    Short facts behind the checklist, each linked to its source.

    • Open@Epic describes itself as a resource for anyone looking to connect a healthcare app or service to providers using Epic software.

      Source: Open@Epic
    • Epic's FHIR developer site offers a testing sandbox for trying its APIs against example data, along with app registration and client ID management.

      Source: Epic on FHIR
    • The HL7 SMART App Launch guide defines how apps launch from inside an EHR or standalone, and its Backend Services profile authorizes automated clients with no user present.

      Source: HL7 SMART App Launch
    • The ONC (ASTP) certification criterion for standardized APIs, 45 CFR 170.315(g)(10), references FHIR R4, the US Core implementation guide and the SMART App Launch guide.

      Source: ONC (ASTP), HealthIT.gov
    • CDS Hooks is an HL7 specification for invoking decision support from within a clinician's workflow at points called hooks, such as patient-view and order-select.

      Source: HL7 CDS Hooks
    Related services

    Which Agnotic services pick up from here?

    Agnotic Technologies builds Epic and EHR integrations for digital health teams. These pages cover the build behind each phase.

    Frequently Asked Questions

    In practice, yes. A health system's Epic team decides what is enabled in its environment, and a clinical or operational sponsor who wants the integration is what moves it through their review and build queue. Find the sponsor before you invest in the build.