Integration guide¶
Connecting the service takes a few setup tasks in Epic and some details from you. You set up a non-production environment first, with test patients, and then production. Each has its own client ID, and we send you both.
Epic's steps can differ
The Epic steps below follow Epic's published guides for requesting an app and backend authentication, as of November 2026. Epic's screens and terms change between versions. If a step doesn't match what you see, follow Epic's guidance and email us.
Checklist¶
1. Before you start¶
- Have a Business Associate Agreement (BAA) with Abacus One Group in place. No production data is exchanged without one.
- Confirm your organization has signed Epic's open.epic API Subscription Agreement. Epic requires it before you can download an app from the Epic on FHIR website. It covers your whole organization, so you may already have it.
- Name your contacts: an Epic analyst or Epic Client Systems Administrator (ECSA), a security or privacy reviewer, and an HIM or coding lead.
- Start your security review. Authentication and network and Data handling answer the usual questions, and we complete questionnaires on request.
- Agree the scope with us. Your HIM or coding lead decides which visits you want us to load (ED visits, for example), when a chart is ready to code, and which documents our coders do and don't need.
2. Non-production¶
- Request the app on the Epic on FHIR website. Someone with the Purchase Apps security point searches the Downloads page for the client ID we send, and requests the download. We then activate it for your non-production environment, which copies the app's client record to your Epic system.
- Map the client ID to a background user. Your ECSA maps the non-production client ID to an Epic user account. The service can't connect until this is done, and Epic audits every request it makes under this user. The user needs no access beyond reading the data on Data accessed.
- Configure the JWK Set URL, if you are on Epic's May 2026 version or later. From that version, Epic has you enter the URL for a backend app in your own system. Use the non-production URL on Authentication and network.
- Build a system list of the patients whose visits you want us to load, and make it available to the background user. For example: "ED patients who arrived or were discharged in the last 5 days." Keep patients on the list for a few days after their visit, so that late documentation isn't missed. If the visits come from more than one department or site, build a list for each.
- Send us the environment's details:
- The FHIR R4 base URL and the OAuth 2.0 token endpoint.
- Each patient list's ID and identifier system (OID), and how long patients stay on the list.
- The identifier systems (OIDs) for the medical record number (MRN), the contact serial number (CSN) and the hospital account (HAR) or billing number.
- Any request limits on the client ID, including Epic's daily limit on document queries.
- Whether your FHIR endpoint requires IP allowlisting.
- Test with us, using test patients only. We run a connection check, retrieve a few test visits and review the results with you.
3. Production¶
- Ask us to activate production. We activate the production client ID for your organization on the Epic on FHIR website.
- Map the production client ID to a background user, with the same read-only access.
- Configure the production JWK Set URL, if you are on Epic's May 2026 version or later.
- Build the production system lists.
- Send us the production details. They are the same items as for non-production.
- Run in parallel. For an agreed period, the service runs alongside the current process, and our coders and auditors compare the two before anything changes.
- Agree a cutover date with us.
If you can't build a patient list¶
There are two other ways to tell us which visits to load. The rest of the checklist stays the same.
- Send a daily file of visits. It has one row per visit, with the MRN, CSN, HAR or billing number, arrival time and payer. You send it by secure file transfer, and we agree the format with you. You can also send the file as well as building a list, as a cross-check that no visit was missed.
- Use the visits you already send us. If your organization already sends its ED visits to Abacus One, through an ADT interface or visit files, you have nothing more to send. The service finds each of those visits in Epic by MRN and CSN.
After go-live¶
Tell us before you change anything the service depends on: the patient lists, the background user, your FHIR or token endpoints, request limits, or an Epic upgrade.