Partners Blog Contact Us

Vidyo and Epic Integration with VidyoConnect Context-Aware Linking (CAL) for On-Premises and Cloud


The Epic Context-Aware Linking integration feature for Vidyo enables healthcare providers to access VidyoConnect™ meetings from within their Epic EHR (Electronic Health Record) system.

This article consists of the following sections: 

  • Configuring Epic CAL Integration (Cloud)
  • Configuring Epic CAL via the Super Admin Portal (On-Premises)
  • Important Tips when Configuring  Epic (On-Premises)
  • Demonstration of CAL

If you need to enable context aware linking on Epic, select this link!68!50!1621949,3769901, and then login with your credentials.

If you want to use the Epic integration feature, you can enable it in the Super Admin portal and then configure it for each tenant that's going to use the feature. Alternatively, you can enable it via REST APIs. This article describes how to configure it via the Super Admin portal. For information about how to configure it via the REST APIs, refer to version 18.2.1 of the Vidyo Web Services API User Guide

Before using the Epic integration feature, you must first ensure that you've applied Security Update 18 to both the VidyoPortal™ and VidyoRouter™ and that you're using VidyoPortal and VidyoRouter version 18.2.1 or later. Also, you can use this feature only with VidyoConnect for Desktop 18.2.0 or later and VidyoConnect for Mobile 18.1.0 or later.


Configuring Epic CAL Integration (Cloud)

To enable Epic integration in the VidyoPortal (Cloud): 

To enable Epic integration for cloud customers, please contact the VidyoCloud Support Team at 1-844-488-2227 or +1-201-620-6955 or and include the following information: user names and passwords, crypt/shared secret key, "Notification URL", "Notification User", and "Notification Password".  The 16-digit alphanumeric crypt/shared secret key can be manually created or use a key generator. Refer to the screen shot below: 



Configuring Epic CAL via the Super Admin Portal (On-Premises)

In order for this configuration to work, the "Scheduled Room" feature must be enabled on the VidyoPortal. If you do not have this feature enabled; you will receive a 404 error message stating, "This is not a valid room link". 

To enable Epic integration in the VidyoPortal (On-Premises):

  1. Log in to the Super Admin portal using your Super Admin account.

    For more information, see Logging in to the Super Admin Portal.

    The Components page displays by default.

  2. Click the Settings tab.

    The Upload System License page displays by default.

  3. Click  to the left of Feature Settings on the left menu.

  4. Click Epic Integration from the submenu.

    The Epic Integration page displays.


  5. Select the Enable Epic Integration check box.

  6. Click Save.

  7. Click the Tenants tab.
    The Tenants page displays.


  8. Select the tenant for which you want to enable Epic integration.

  9. Select the Enable EPIC Integration check box.

  10. You can configure the Epic integration for the tenant by entering the following information. (Vidyo support EPIC set external connection status through a web service which allows Hyperspace to properly reflect the video visit status of the Vidyo system in the provider schedule and connect visit navigator sections):  
    • Enter a 16-digit alphanumeric Crypt Key in the Shared Secret field.  The 16-digit  crypt/shared secret key can be manually created or use a key generator.
      Please note that you must enter the same Shared Secret in your Epic database. This secret will be used for encrypting and decrypting the URL strings. 


    • Enter the Epic Interconnect/SetExternalConnectionStatus URL in the Notification URL field.
    • Enter the Epic Interconnect/SetExternalConnectionStatus user name in the Notification user field.
    • Enter the Epic Interconnect/SetExternalConnectionStatuspassword in the Notification password field.
  11. Click Save.  


Important Tips When Configuring Epic Integration (On-Premises)

The following information will assist you in your configuration of Epic.

  • Vidyo supports the AES encryption for the crypt algorithm.
  • The format for the crypturl which is configured on the Epic system should have the following format: https://<vidyo portal tenant fqdn>/join/?extDataType=1&extData=%CRYPTSTR%. You will need to replace the <vidyo portal tenant fqdn> with the actual portal FQDN.
  • The Crypt Key is the same as the Shared Secret and is a 16 digit alphanumeric number.


Demonstration from Epic of CAL 

To view a demonstration of CAL in action hosted on Epic's galaxy site, select this link: You may need to obtain special login permissions to view this demo.

Was this article helpful?
0 out of 0 found this helpful



Please sign in to leave a comment.