Perceptive XML Integration for Epic

Transcription

1 Perceptive XML Integration for Epic Installation and Setup Guide Version: 2.0.x Written by: Product Knowledge, R&D Date: May 2018

2 Hyland Software, Inc. and its affiliates.

3 Table of Contents About Perceptive XML Integration for Epic... 4 Prerequisites... 4 Install PXIE... 4 Download the PXIE file... 4 Attended installation... 4 Unattended installation... 5 Install PXIE unattended... 5 Uninstall PXIE unattended... 5 Installation arguments... 5 Configure PXIE... 6 About configuring PXIE to start... 6 About PXIE settings and logging... 6 About the Epic XML directory... 7 Events to process... 7 About Epic encrypted authentication... 7 About configuring PXIE to start... 7 Configure the XML directory and events to process... 8 Verify PXIE installation... 8 Configure LearnMode... 8 Create a LearnMode application plan... 8 Modify the LearnMode plan... 9 Configure the LearnMode plan security

4 About Perceptive XML Integration for Epic Perceptive XML Integration for Epic (PXIE) allows Interact Desktop to display the relevant documents for an Epic patient record, automatically and securely. It pairs Epic-created XML data with LearnMode to update the patient documents available to users. This prevents patient information mismatches between Epic and Interact Desktop. To install and configure PXIE, review and complete the following tasks. Download the PXIE file Complete an Attended installation or Unattended installation Configure PXIE Configure LearnMode Prerequisites Before you install PXIE, verify that you have these required software components. Interact for Epic Client, version 6.7 or higher Interact for Epic must have SSO enabled Interact Desktop, version 6.7 or higher One of the following versions of Epic Epic 2012 (v79) Epic 2014 (v81) Epic 2015 (v82) Microsoft.NET Framework, version 4 Install PXIE Download the PXIE file To download the PXIE files, complete the following steps. Go to and log in to the Customer Portal. On the Downloads page, download the latest PerceptiveXMLIntegrationForEpic<version>.msi file to a temporary directory on your computer. Attended installation To install PXIE with the installation wizard, complete the following steps. 1. Double-click the downloaded PXIE file. 2. On the Welcome page, click Next. 3. Accept the terms of the License Agreement and click Next. 4. On the Destination Folder page, verify or change the installation directory and click Next. 4

5 5. Click Install and then click Finish Unattended installation Install PXIE unattended Installing PXIE silently is an automatic installation method that does not use the installation wizard. With this method, you can complete a custom installation or use a combination of default and customized settings. To install PXIE unattended, complete the following step. Use a Command Prompt window or a deployment script to run a command in the following format. msiexec /quiet /i PerceptiveXMLIntegrationForEpic<version>.msi <argument list> Example: msiexec /quiet /i PerceptiveXMLIntegrationForEpic2.0.0.msi /L*V pxieinstall.log INSTALLDIR="C:\Program Files (x86)\imagenow\pxie" Uninstall PXIE unattended To uninstall PXIE unattended, complete the following step. Use a Command Prompt window or a deployment script to run a command in the following format. msiexec /quiet /x PerceptiveXMLIntegrationForEpic<version>.msi <argument list> Example: msiexec /quiet /x PerceptiveXMLIntegrationForEpic2.0.0.msi /L*V pxieuninstall.log Installation arguments This table contains the arguments you can use when you install PXIE unattended. If you do not manually set argument values, then the silent installer uses the default values. For strings, use escaped quotation marks when setting the argument. Argument Description Default Example L*V Name of the log file and an optional path. If you define a path, it must be a valid, existing path. This argument is typically used to diagnose installation errors. If you do not define a directory, it defaults to the current MSI directory. L*V \"C:\logs\pxieinstall.log\" INSTALLDIR The location of the PXIE files [drive:]\program Files\ImageNow\ Epic INSTALLDIR="C:\Program Files (x86)\imagenow\pxie" 5

6 Configure PXIE To configure PXIE, review the following topics. About PXIE settings and logging About PXIE settings and logging The PXIE configuration file, InteractEpicXML.ini, defines PXIE s basic functionality, logging, directory paths, and the Epic events that you want PXIE to process. You can find this file in the PXIE installation directory. For more information about each of the available settings, refer to the configuration file comments. About the Epic XML directory Events to process About Epic encrypted authentication About Epic encrypted authentication If your Epic instance uses encrypted authentication, you must contact your Epic representative for a plain-text key and the encryption type. Encryption types include 3DES or AES. You configure the PXIE configuration file with the plain-text key and encryption type. If your Epic instance does not use encrypted authentication, you can leave the Epic encryption settings in the configuration files blank. About configuring PXIE to start Then, complete the following tasks. About Epic encrypted authentication If your Epic instance uses encrypted authentication, you must contact your Epic representative for a plain-text key and the encryption type. Encryption types include 3DES or AES. You configure the PXIE configuration file with the plain-text key and encryption type. If your Epic instance does not use encrypted authentication, you can leave the Epic encryption settings in the configuration files blank. About configuring PXIE to start You must configure the PXIE executable, InteractEpicXML.exe, to launch at the start of each user s Windows session before the user logs in to Epic. For best practices on how to configure PXIE to launch on startup, contact your Lexmark Enterprise Software representative. Configure the XML directory and events to process Verify PXIE installation About PXIE settings and logging The PXIE configuration file, InteractEpicXML.ini, defines PXIE s basic functionality, logging, directory paths, and the Epic events that you want PXIE to process. You can find this file in the PXIE installation directory. For more information about each of the available settings, refer to the configuration file comments. 6

7 About the Epic XML directory PXIE consumes XML files created by Epic. When certain actions occur in Epic, such as a user opening or closing a patient record, Epic drops an XML file in a network directory. PXIE continuously monitors this directory and reads the file contents to retrieve the patient ID. Interact Desktop uses LearnMode to monitor the patient ID held by PXIE. When the patient ID changes, Interact Desktop updates the patient documents available to the user. You specify the Epic XML directory location in the PXIE configuration file. The directory must be userand session-specific, and it must exist. For example, you might use a folder in the %appdata% directory. For information on how to configure the XML directory location in Epic, refer to your Epic documentation or contact your Epic representative. Events to process Interact Desktop can respond to these Epic user-initiated events. You configure which of these events you want Interact Desktop to act on with the PXIE configuration file. Epic event Action in Epic Interact Desktop action Login The user logs in to Epic. PXIE launches Interact Desktop and logs in with Epic SSO. Patient open The user opens a new patient record. Interact Desktop closes any previously opened documents, and then loads the new patient s Patient switch The user switches the patient record. documents. Patient close The user closes a patient record. Interact Desktop closes the patient s documents. Logout The user logs out of Epic. Interact Desktop closes. Destroy Timeout Epic stops running. Epic reaches its timeout limit and logs the user out. About Epic encrypted authentication If your Epic instance uses encrypted authentication, you must contact your Epic representative for a plaintext key and the encryption type. Encryption types include 3DES or AES. You configure the PXIE configuration file with the plain-text key and encryption type. If your Epic instance does not use encrypted authentication, you can leave the Epic encryption settings in the configuration files blank. About configuring PXIE to start You must configure the PXIE executable, InteractEpicXML.exe, to launch at the start of each user s Windows session before the user logs in to Epic. For best practices on how to configure PXIE to launch on startup, contact your Lexmark Enterprise Software representative. 7

8 Configure the XML directory and events to process Before you use PXIE for the first time, you must specify the Epic XML directory and events to process in the PXIE configuration file. To configure these and other optional settings, complete the following steps. 1. Navigate to the PXIE installation directory and open InteractEpicXML.ini with a text editor. 2. Set epic.xml.directory to a user- and session-specific directory that already exists. Example epic.xml.directory = %appdata%\imagenow\xml Set events.to.process with a comma-separated list of Epic events on which you want PXIE to act. Example events.to.process = PatientOpen, PatientSwitch, PatientClose 4. Optional. Configure any other settings as needed, such as logging or the Epic encryption settings. 5. Save and close the file. Verify PXIE installation To verify the PXIE is installed and runs correctly, complete the following steps. 1. Start the InteractEpicXML.exe file. 2. In Windows, start Task Manager. 3. On the Processes tab, verify that InteractEpicXML.exe appears. Configure LearnMode Create a LearnMode application plan PXIE requires a LearnMode application plan in ImageNow or Perceptive Content. The application plan monitors and reads data from the PXIE COM interface. To create the application plan, complete the following steps. Prerequisite Start Epic or verify that it is running Start the PXIE file InteractEpicXML.exe, or verify that it is running 1. Open the ImageNow or Perceptive Content Management Console. 2. For Perceptive Content only, in the left pane, under Select Department, select a department from the list. 3. In the left pane, expand Application Plans > LearnMode, then on the Applications tab, click New. 4. In the Plan Settings dialog box, on the General tab, complete the following substeps. 1. In the Name field, type a unique name for the plan. 2. Optional. Type a description for your application plan. 3. Under Application, in the Method list, select Window Title and click Identify. 8

9 4. Verify that the Epic window is visible, and then in the Window Selector Starter dialog box, click Start. 5. Click within your Epic window to identify the application. Result In the Plan Settings window, the Value field populates with the name of your Epic app. 6. Optional. If an Epic username appears in the window title, replace it with wildcards as necessary to ensure that the application plan will work for all of your Epic users. To test that it correctly identified Epic, click Test and verify that the Status is Application found. 5. In the Plan Settings dialog box, click OK. Result The LearnMode Application Plan Designer window opens and launches a Screen Properties dialog box. To complete the process, continue to the Modify the LearnMode plan topic. Modify the LearnMode plan To finish configuring LearnMode for PXIE, modify the application plan to map Epic values to Interact Desktop. To modify the plan, complete the following steps. Prerequisite Open the LearnMode application plan for PXIE 1. In the Screen Properties dialog box, complete the following substeps. 1. In the Name field, type a name for the screen, such as Patient Information. 2. Under Identification Method, select Script. 3. From the Name list, select Manage Scripts. 2. To add the Get Screen script, in the Scripts dialog box, complete the following substeps. 1. Click Create, name the script Get Screen, and then click Modify. 2. In the Script dialog box, in the Script field, enter the following Visual Basic script. Set controlpanel = CreateObject("Perceptive.Epic.Xml") id = controlpanel.getvalue("patientid") If (id = "") Then ScreenFound = False Else ScreenFound = True End If 3. Click the Test icon. If the script runs correctly, the label after Test is empty. 4. Click OK in the Script dialog box. 3. To add the Get Value script, in the Scripts dialog box, complete the following substeps. 1. Click Create, name the script Get Value, and then click Modify. 2. In the Script dialog box, in the Script field, enter the following Visual Basic script. Set controlpanel = CreateObject("Perceptive.Epic.Xml") WorkingValue = controlpanel.getvalue("patientid") 3. Click the Test icon. If the script runs correctly, the label after Test is empty. 4. Click OK in the Script, Scripts, and Screen Properties dialog boxes to return to the application plan designer. 9

10 4. In the Dictionary pane, complete the following steps. 1. Click the New Field icon. 2. In the Dictionary Field dialog box, in the name field, type Patient ID. 3. Click Add > Script. 4. In the Scripts dialog box, select the Get Value script. 5. Click OK in the Scripts and Dictionary Field dialog boxes to return to the application plan designer. To map the Patient ID value, on the Map tab, drag Patient ID from the dictionary to a property in the Document level, such as Field1. Note You can assign Patient ID to Field1, Field2, Field3, Field4, Field5, or Document Type. On the View Action tab, complete the following substeps. 1. In the Type list, select Document. 2. Click the first column next to Patient ID to add the binoculars icon. Save and close the application plan. Configure the LearnMode plan security To configure the security settings for your LearnMode plan, complete the following steps. 1. Open the ImageNow or Perceptive Content Management Console. 2. For Perceptive Content only, in the left pane, under Select Department, select a department from the list. 3. In the left pane, expand Application Plans > LearnMode, click your PXIE LearnMode plan and click Settings. 4. On the Security tab, complete the following substeps. 1. Under Users and Groups, click Add. 2. In the Select Users and Groups dialog box, select each Interact Desktop user or group of users, click Add, and then click OK. 3. Under Privileges, grant the View privilege and any other privilege you want the user or groups to have. 5. Click OK to save and exit the plan security settings. 10