Using Zoom's Epic FHIR integration


The Zoom Epic FHIR integration enables health care organizations to integrate Zoom into Epic FHIR’s video visit workflow. Zoom video links are placed in video visit appointments. Physicians can access appointments and launch Zoom video visits directly in Hyperspace and document the visit in Epic. Patients can launch the Zoom video visit from their MyChart Patient portal on their personal computer or mobile device.

This integration provides the following features:

If you need more information on the non-FHIR version, refer to the Epic integration guide. 

Note: With the deprecation of JWT authentication in September 2023, an account admin should migrate to authenticating the Epic integration with OAuth. 

This article covers:

Prerequisites for Zoom's Epic FHIR integration

How to add from the Zoom App Marketplace

  1. Sign in to the Zoom App Marketplace as the account administrator.
  2. In the top right of your screen, enter Epic FHIR in the search box to find the app.
  3. In your search results, find the Epic FHIR app and click it.
  4. Click Add.
  5. Confirm the permissions the app requires, then click Allow.
    The installer will display the configuration page.

How to configure Epic FHIR

On the integration configuration page, complete the required information.
Notes:

  1. Sign in to the Zoom App Marketplace with your Zoom owner or admin account.
  2. In the top-right corner, click Manage.
  3. In the navigation menu, click Created Apps.
  4. Click your developer.zoom.us API (JWT).
  5. Click App credentials.
  6. Copy your API Key for use as Zoom API Key in a later step.

 

  1. Configure the following settings:
    • Zoom API Key: Zoom API Key should only be shared with Zoom or appropriate personnel within your company. They should never be shared with 3rd parties.
    • Zoom App Secret: The client secret provided by Zoom when enabling the Zoom app in App Orchard.
    • Zoom App Private Key: The value contained in the privatekey.pem file provided by Zoom when enabling the Zoom app in App Orchard.
    • Epic FHIR R4 Base URL: The base URL to your Epic instance where the Epic FHIR R4 endpoints can be reached.
    • Epic Telehealth Base URL: The base URL to your instance where the Epic 2020 telehealth endpoints can be reached.
    • Epic OAuth Base URL (Optional): The base URL of your instance of the Epic FHIR authorization server. This field is not necessary but can be included to make launches more efficient by bypassing the need to make a remote call to Epic to obtain this value.
    • Epic Environment:
      1. Set to Test for an Epic test environment.
      2. Set to Production for a live Epic production environment.
    • Patient Admittance Policy: Set according to your preference.
    • Provider User Type: When initiating telehealth meetings, the integration automatically creates user accounts for providers without existing Zoom accounts. Select the user type you want to assign to these accounts.
    • (Optional) Epic Device Test Endpoint URL: Enter the full URL where users can test the meetings feature prior to the video visit.
    • (Optional) Healthcare Provider Device Test Help URL: Enter the full URL where users can get help when testing the meetings feature.
  2. Click Save Changes.

Re-authenticating with OAuth

With OAuth support for the Epic FHIR Zoom App and the deprecation of JWT authentication in September 2023, Epic admins can follow these steps to migrate from JWT to OAuth authentication.

  1. Sign in to the Zoom App Marketplace as the account administrator.
  2. In the top right of the page, click Manage.
  3. In the navigation menu, click Added Apps.
  4. Click the Epic FHIR app. 
  5. Click Update. 
    You will be prompted to authenticate with your Epic account. 
  6. Provide access to the requested permissions. When authentication is complete, you will return to the Epic FHIR marketplace page. 

How to configure account-level settings

The Epic FHIR integration requires the following Zoom account-level settings to remain unlocked.

  1. Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
  2. In the navigation menu, click Account Management then Account Settings.
  3. Click the Meetings tab.
  4. Ensure that the following settings are not locked:
    • Under Schedule meeting, ensure that the Allow participants to join before host setting is unlocked.
    • Under Security, ensure that the Waiting Room setting is unlocked.

How to remove from the Zoom App Marketplace

  1. Sign in to the Zoom web portal as an administrator.
  2. In the navigation panel, click Advanced then App Marketplace.
  3. On the top right of the page, click Manage.
  4. On the left side of the page, click Added Apps.
  5. Next to the Epic FHIR app, click Remove.
  6. In the Remove app pop-up window, choose your reason, then click Remove.

Configuring Epic FDI records

The FHIR integration is used by configuring FDI records for each type of video visit launch that the integration supports. These records contain a URL string that corresponds to a particular API in the integration application, as well as parameters for identifying the participants and Epic appointment associated with the meeting.

Note : If you are an existing customer and have already configured your FDI records, you can continue using just the “org_id” url parameter. But if you “Regenerate” the Api Key field on EpicFhir app configuration page then you must add “acc_id” url param to your FDI records

The required URLs for each type of visit are listed below. These are entered in the “URL” field in “Installation Mnemonic Values”.

The parameters for identifying the launch context are listed below. These are entered in the “CONTEXT” field in “Installation Mnemonic Values”

Usage

Once a healthcare administrator configures FDI records for each type of meeting, providers may access the Hyperspace portal, locate their telehealth appointment, and launch their video visit. Providers will be set as the host of the meeting, and will automatically join the meeting as soon as it begins.

Patients may locate their appointment within the MyChart portal, and launch their visit from there. If the provider has not yet joined the meeting, patients will observe a loading screen that says “Please wait for the host to start this meeting”. Once the provider has joined the meeting, depending on the patient admittance policy configured by the administrator, the patient will either automatically join the meeting or must wait for the provider to manually admit them.

Troubleshooting for Zoom's Epic FHIR integration

Meeting Indicator

Epic’s Hyperspace client displays a green light to indicate when patients join the telehealth meetings. When the indicator is not working correctly, we can use notification records to help diagnose the cause.

To access the notification records screen:

  1. Sign in to the Zoom App Marketplace as the Zoom user account administrator.
  2. In the top right of the page, click Manage.
  3. For the Epic FHIR app, click Configure then Notification Records.
  4. Enter the Zoom meeting ID for the meeting or the Epic CSN of the encounter, that the indicator was not working properly.
  5. Click Search.
    The search will display a list of notification records. Each row corresponds to a notification sent from Zoom to Epic and contains the date and time when patients and providers joined and left the meeting.

The RespCode column indicates if the notification was successfully handled by Epic. Successful notifications display 200. A value other than “200” indicates there is a problem with the notifications reaching Epic which can cause the indicator to not work properly.

These are some things to check if there are problems:

For additional help, submit a request to Zoom Support.

Data Security

How your data is used

This integration accesses and uses the following information from your Zoom account:

This integration accesses and uses the following information from your Epic account: