Skip to main content

EPIC FHIR Integration

You can now integrate your app on Epic FHIR account with the Yellow.ai platform using OAuth. This will let your users access patient details, search for appointment slots, and book appointments.

1. Connect Yellow.ai with EPIC FHIR​

  1. Go to your Epic FHIR app and fetch the Client ID and Client Secret.

  1. Go to your Yellow.ai bot and click Integrations in the module switcher.

  1. Search for EPIC FHIR, fill in the Client ID and Client Secret and click Connect to EPIC FHIR.

  1. If you have multiple accounts, follow the above mentioned steps to add each of them.
note
  1. Enter a unique name for each account to easily identify them within the yellow.ai platform. It is recommended to use a name that aligns with its purpose for better usability.
  2. You can add a maximum of 5 merchant accounts.
  3. In a two-tier environment, such as bots with only Development/Live environments, you can add account names only in the development mode. Once added and flows have been built, in the Live mode, you can only choose the account names and not edit them.
  4. In a three-tier environment, such as bots with Staging/Sandbox/Production modes, in Staging and Sandbox modes, you can add and edit new accounts. However, in Production, only the account details added in Staging will be available. You can only map in the production environment.
note
  1. Yellow.ai does not store the client’s credentials. We use the OAuth 2.0 approach to integrate with the client’s Epic FHIR account.
  2. This integration supports the STU3 version of API, so the APIs based on the clients' use cases should be added while creating the Epic app.

2. Use-Case​

You can retrieve patient data with patient ID and demographics, view available appointment slots, book appointments and also fetch the appointment details of a patient.

  1. In the Studio flow builder, select the Integrations node and click EPIC FHIR from the list of integrations that have been enabled for that bot.

  1. After clicking EPIC FHIR,an Integration Action Node will be added to the flow builder. When you click that node, you will see all the use-cases of this integration in a drop-down. Choose the one you want to use.

The following table describes the use-case values in detail:

Node NameFunctionality
Fetch patient informationFetch patient information from patient ID
Fetch patient diagnostic informationFetch patient diagnostic information from patient ID
Fetch patient demographicsFetch patient information using the patient's date of birth and name
Fetch appointment slotsFetch available appointment slots
Book appointmentsBook appointments with the available appointment ID from fetch appointment slots use case
Fetch patient appointment detailsFetch the appointment details of a patient from the patient ID

Supported Version​

This integration will support STU3 version releases. For more information, click here.