Configure PatientSecure Virtual Channel

Imprivata PatientSecure uses Virtual Channels to communicate between the Virtual Channel Driver (VCD) module residing on the client machine and the modules residing within the remote session on the server machine. After the initial connection is established both client and server sides can utilize request/response and one-way communication messages.

PatientSecure uses virtual channel communication to allow remote session PatientSecure Toolbar or Epic Integration applications to communicate to the PatientSecure Gateway on the client desktop.

Virtual Channel Support

  • Supports Citrix environments where you want to use Imprivata Virtual channel communications for PatientSecure Toolbar or Epic Integration as published applications on endpoints.

  • PatientSecure supports virtual channels over the ICA protocol on the Windows platform.

  • PatientSecure does not support launching the published Epic app multiple times from the same user on the same Citrix session.

Before You Begin

Before you begin, consider the following items:

Review the PatientSecure system requirements and Citrix supported components on the Imprivata Environment Reference portal.

Applies to Citrix Virtual Apps and Desktops 7 2109 or later.

In Citrix Virtual Apps and Desktops 7 2109 and later, the Virtual channel allow list policy setting is enabled by default. This causes the PatientSecure virtual channel to fail. For more information, see the Citrix documentation.

The Virtual channel allow list policy setting enables the use of an allow list that specifies which virtual channels are allowed to be opened in an ICA session. There are two ways to allow the Imprivata virtual channel to run in Citrix 7 2109 or later:

  • When disabled:

    • All virtual channels (including PatientSecure virtual channel) are allowed.

    • This is not recommended

  • When enabled:

    • Only Citrix virtual channels are allowed

    • The PatientSecure virtual channel must be added to this allow list.

To add a virtual channel to the list:

  • Enter the virtual channel name followed by a comma, and then the path to the process that accesses the virtual channel.

  • You can add additional executable paths, separating the paths by commas.

  • For Toolbar, add:

    IMP3388,C:\Program Files (x86)\Imprivata\PatientSecure\Toolbar\ImprivataPatientSecureToolbar.exe

  • For Epic Integration, add:

    IMP3388,pathToEpicInstallation

    where

    pathToEpicInstallation is the installation path to Epic, including the Epic executable (.exe).

Prerequisites

  • A supported release of Citrix Virtual Apps and Desktops must be running on the Citrix server before installing the PatientSecure client software.

  • A supported release of Citrix Workspace App must be installed on the endpoint before the PatientSecure client.

Install Software Dependencies

  • Install the required software dependencies on the Citrix server and endpoints.

  • Ensure that the necessary client communication ports are open.

Obtain the PatientSecure Client Installation Package

Download the client installation package provided by your Imprivata PatientSecure representative or from the PatientSecure software download package available on the Imprivata Support and Learning Center.

Install Epic Integration/Toolbar and Virtual Channel on the Citrix Server

On the Citrix server, install either the Epic Integration or Toolbar group of features and select Virtual Channel:

  1. Extract the software package and run ImprivataPatientSecureWebClient.exe.

  2. Click Next.

  3. Complete the wizard, including the following steps:

    1. If there are missing software prerequisites, such as Microsoft Visual C++ redistributables, the wizard prompts for you to install them.

    2. Accept the default destination folder for the installation files, or click Change to navigate to and select a different folder. Click Next.

    3. Enter the fully qualified domain name (FQDN) for the PatientSecure Web Services (PSWS) application server.

    4. Enter the port to use. The default is 7002.

    5. To verify the connection to the PSWS, click Test Connection. Click Next.

    6. On the Setup Type page, to choose from groups of features to install, click Custom and Next. The Custom Setup page presents you with pre-defined groups of features to be installed.

      install either the Epic Integration or Toolbar group of features.

    7. If you selected a group of features that includes the PatientSecure Toolbar, on the Toolbar Theme page, select the Toolbar is running as a published application checkbox to allow the Toolbar application to run as a published application. Click Next.

      1. On the Toolbar Buttons page, select the toolbar settings that will be available:

        • Show Authenticate Button on Toolbar

        • Show Enroll Button on Toolbar

        • or both

    8. On the Virtual Channel page, the PatientSecure installer detects Citrix on the server. To use Virtual Channel communication, select the Use Virtual Channel checkbox.

    9. The default is not selected. If Citrix is not detected on the server, this page is not displayed. Click Next.

    10. To review log entries for the installation when you exit the Installer, select Show the Windows Installer log.

Install PatientSecure Client on Endpoints

On the endpoints, install the Client, Hub, Gateway group of features:

  1. Extract the software package and run ImprivataPatientSecureWebClient.exe.

  2. Click Next.

  3. Complete the wizard, including the following steps:

    1. If there are missing software prerequisites, such as Microsoft Visual C++ redistributables, the wizard prompts for you to install them. In this case, the PatientSecure client installation will require a reboot of the endpoint.

    2. Accept the default destination folder for the installation files, or click Change to navigate to and select a different folder. Click Next.

    3. Enter the fully qualified domain name (FQDN) for the PatientSecure Web Services (PSWS) application server.

    4. Enter the port to use. The default is 7002.

    5. To verify the connection to the PSWS, click Test Connection.

    6. Click Next.

    7. On the Setup Type page, to install only the default components (PatientSecure Client, PatientSecure Client Hub and PatientSecure Client Gateway), click Typical and Next.

    8. Click Next.

    9. To review log entries for the installation when you exit the Installer, select Show the Windows Installer log.

Install from the Command Line

Alternately, you can install the PatientSecure Client from the command line with specific switches for Virtual Channel. For more information, see PatientSecure Client - Command Line.