Install the Patient Access Software

Assumptions

This topic assumes your knowledge in the following areas:

  • Your experience installing enterprise software

  • Your familiarity with MSI installation controls.

    For standard msiexec options, you may want to run "msiexec /?" on the endpoint device's operating system (these can vary by Windows Installer version). If that is not an option, you can find good references by searching for command-line switches for the Microsoft Windows Installer Tool at http://msdn2.microsoft.com.

  • Your familiarity with your environment's topology and how it works.

Before You Begin

Review the Registration Desktop and Kiosk System Requirements

Working with the Installation Key

The installation key is the privileged credentials that allow your endpoints to connect to your Patient Access tenant. It is used during installation to connect endpoints to the Imprivata cloud.

IMPORTANT:

The installation key contains data that is specific to your Imprivata tenant and therefore should not be shared with anyone outside of your organization.

Virtual Channel Prerequisites

In Citrix virtual desktop infrastructure (VDI) environments where you deliver Epic1 as a published application to endpoints:

  • A supported release of Citrix Virtual Apps must be running on the server before installing the Imprivata Patient Access software.

  • A supported release of Citrix Workspace App for Windows must be installed on the endpoint before the Imprivata Patient Access software.

  • The Imprivata Patient Access Virtual Channel component requires the installation of the following Microsoft Visual C++ Redistributables on the endpoint and on the Citrix server:

    This only applies to customers using Citrix Virtual Apps.

  • Configure the Citrix server to allow the Imprivata Patient Access Virtual Channel by creating a policy with the Virtual channel allow list setting that includes "IMP2266" or is disabled.

Imprivata Patient Access Epic Connector Prerequisites

Patient Access requires that Microsoft .NET Framework 4.7.2 or later installed wherever the Imprivata Patient Access Epic Connector component is installed.

  • For Citrix, this will be on the Citrix server.

  • For a full Imprivata Patient Access client install of Epic, this will be on the endpoint.

Obtain the Software and Installation Key

The Imprivata Patient Access installation program is an MSI file that can be deployed using standard MSI installation commands.

  1. Log in to the Patient Access Admin Console and navigate to the Installers tab.

  2. To obtain the endpoint installer, click Download endpoint installer. The endpoint installer software downloads.

    Save the endpoint installer software to your machine for later use.

  3. To obtain the required installation key for use with the endpoint installer, click Copy installation key.

    Save the installation key for a later task.

  4. (Optional) Click Copy example command line syntax with installation key to obtain the sample command line syntax that includes your installation key. Save the example for a later task.

Run the Installation Program

To install the endpoint on registration desktops:

  1. Run the Imprivata Patient Access Installer program.

  2. On the Installation key screen, paste the installation key you saved in the previous task.

  3. On the Component selection page, select the components to install:

    1. Imprivata Patient Access Registrar Client.

      Install on the endpoint machine. Do not install this component on the host server in a virtual desktop environment.

    2. Imprivata Patient Access Epic Connector.

      Install on the machine where Epic is installed.

      For virtual desktop environments, the Epic Connector component must be installed on the host server.

    3. Imprivata Virtual Channel.

      Install only in virtual desktop environments. Imprivata Virtual Channel must be installed on the host server and the endpoint machine to facilitate communication between the Imprivata Patient Access Epic Connector and Imprivata Patient Access Registrar Client.

    4. Imprivata Patient Access Kiosk Client.

      Install on the kiosk endpoint machine.

      Requires the installation of the Imprivata Patient Access Epic Connector component on the machine where Epic is installed.

      IMPORTANT:

      The Patient Access Registrar Client and Kiosk Client components cannot be installed on the same endpoint.

  4. Click Next and then Install.

    The endpoint installs successfully.

Install the Software from the Command Line

To install the Imprivata Patient Access software using the command line, use the syntax:

Syntax

Copy 
msiexec.exe /i "Imprivata Patient Access Installer (<build>).msi" /qn /L*V \"<logFilePath>\" INSTALLDIR="C:\Program Files\Imprivata\PatientAccess" INSTALLATIONKEY="<INSTALL_KEY>" INSTALL_VIRTUAL_CHANNEL="0|1" INSTALL_EPIC_CONNECTOR="0|1" INSTALL_REGISTRAR_CLIENT="0|1" INSTALL_KIOSK_CLIENT="0|1"
IMPORTANT:

In your script, the command-line parameters must be a single line.

Parameters

Parameter Required Function
/i Required Specifies normal installation.
/qn Required

Runs the embedded MSI in quiet mode with no UI.
/L*V Required

Logs all output to a file and saves log to the path specified in <logFilePath>.

NOTE: The path is quoted, and the quotes are escaped. The path must already exist and be accessible. The command line will not create the path.
INSTALLDIR Optional

The base location for installing Imprivata Patient Access.

If not defined, it defaults to the following location:

 

  • "C:\Program Files\Imprivata\PatientAccess\" and it respects the %programfiles% in Windows.

NOTE: If the path contains spaces, the INSTALLDIR value must be quoted and the quotes escaped.

INSTALLATIONKEY Required

The installation key for the client software in your Imprivata Patient Access tenant.

Required for Registrar Client installation.

Required for Epic Connector installation.

Note: Upgrades to Patient Access 2024.13 (and later) will need to pass INSTALLATIONKEY as a command line parameter since it may not be in the registry, if the Registrar Client was omitted on the previous installation.
INSTALL_ENDPOINT CLIENT Required

Indicates whether the Imprivata Patient Access Registrar Client component should be installed on the endpoint.

Defaults to "1", meaning it will be installed without this flag present.

Valid values: 1 and 0.

NOTE: Do not install this component on the host server in a virtual desktop environment.
INSTALL_EPIC_CONNECTOR Optional

Indicates whether the Imprivata Patient Access Epic Connector component should be installed.

Defaults to "1", meaning it will be installed without this flag present.

Valid values: 1 and 0.

  • Install the Epic Connector on the machine where Epic is installed.

  • For virtual desktop environments, the Epic Connector component must be installed on the host server.
INSTALL_VIRTUAL_CHANNEL Optional

Indicates whether the Imprivata Virtual Channel component should be installed.

Defaults to "0", meaning it will not be installed without this flag present.

Valid values: 1 and 0.

  • Install only in virtual desktop environments.

  • Imprivata Virtual Channel must be installed on the host server and the endpoint machine to facilitate communication between the Imprivata Patient Access Epic Connector and the Imprivata Patient Access Registrar Client.

NOTE:

The Imprivata Virtual Channel component does not support a custom installation directory.

Imprivata Virtual Channel will always be installed to C:\Program Files\Imprivata\Common\Virtual Channel, regardless of whether the Client component is installed to another drive or directory.
INSTALL_KIOSK_CLIENT Optional

Indicates whether the Imprivata Patient Access Kiosk Client component should be installed on the kiosk endpoint.

Defaults to "0", meaning it will not be installed without this flag present.

Valid values: 1 and 0.

By default, the Kiosk Client component will be installed to C:\Program Files\Imprivata\PatientAccess\KioskClient.

  • Requires the installation of the Imprivata Patient Access Epic Connector component on the machine where Epic is installed.

    IMPORTANT:

    The Patient Access Registrar Client and Kiosk Client components cannot be installed on the same endpoint.

Examples

The following examples illustrate the combinations for installing the Patient Access components.

Installation of the Patient Access software with only the Patient Access Registrar Client component selected.

Copy 
msiexec.exe /i "Imprivata Patient Access Installer (2.10.7).msi" /qn INSTALLDIR="C:\Program Files\Imprivata\PatientAccess" INSTALLATIONKEY="eyJ0ZW5hbn1203015bc==" INSTALL_REGISTRAR_CLIENT="1" INSTALL_EPIC_CONNECTOR="0" INSTALL_VIRTUAL_CHANNEL="0"

Installation of the Patient Access Kiosk Client and Epic Connector on the local endpoint.

Copy 
msiexec.exe /i "Imprivata Patient Access Installer (2.10.7).msi" /qn INSTALLDIR="C:\Program Files\Imprivata\PatientAccess" INSTALLATIONKEY="eyJ0ZW5hbn1203015bc==" INSTALL_REGISTRAR_CLIENT="0" INSTALL_EPIC_CONNECTOR="1" INSTALL_KIOSK_CLIENT="1" INSTALL_VIRTUAL_CHANNEL="0"

Installation of the Patient Access Registrar Client and Epic Connector on the local endpoint.

Copy 
msiexec.exe /i "Imprivata Patient Access Installer (2.10.7).msi" /qn INSTALLDIR="C:\Program Files\Imprivata\PatientAccess" INSTALLATIONKEY="eyJ0ZW5hbn1203015bc==" INSTALL_REGISTRAR_CLIENT="0" INSTALL_EPIC_CONNECTOR="1" INSTALL_KIOSK_CLIENT="1" INSTALL_VIRTUAL_CHANNEL="0"

Installation of the Patient Access Registrar Client on the endpoint in a VDI environment.

Copy 
msiexec.exe /i "Imprivata Patient Access Installer (2.10.7).msi" /qn INSTALLDIR="C:\Program Files\Imprivata\PatientAccess" INSTALLATIONKEY="eyJ0ZW5hbn1203015bc==" INSTALL_REGISTRAR_CLIENT="1" INSTALL_EPIC_CONNECTOR="0" INSTALL_KIOSK_CLIENT="0" INSTALL_VIRTUAL_CHANNEL="1"

Installation of the Patient Access Virtual Channel and Epic Connector on the Citrix application server.

Copy 
msiexec.exe /i "Imprivata Patient Access Installer (2.10.7).msi" /qn INSTALLDIR="C:\Program Files\Imprivata\PatientAccess" INSTALLATIONKEY="eyJ0ZW5hbn1203015bc==" INSTALL_REGISTRAR_CLIENT="0" INSTALL_EPIC_CONNECTOR="1" INSTALL_KIOSK_CLIENT="0" INSTALL_VIRTUAL_CHANNEL="1"