Interact for Epic. Installation Guide. Version: 6.7.x

Transcription

1 Interact for Epic Installation Guide Version: 6.7.x Written by: Product Knowledge, R&D Date: March 2017

2 Lexmark. All rights reserved. Lexmark is a trademark of Lexmark International Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Lexmark.

3 Table of Contents Perceptive Interact for Epic... 4 Prerequisites... 4 Install Interact for Epic Server... 5 Download the Interact for Epic files... 5 Obtain the license files... 5 Install ImageNow product licenses... 5 Run the Interact for Epic attended installation... 6 Install Interact for Epic Server... 6 Share web applications on Apache Tomcat... 7 About web application installation... 7 Configure Apache Tomcat to run multiple web applications... 8 Configure Interact for Epic... 8 Set up single sign-on for Interact for Epic... 8 Configure the SSO settings... 8 Customize the Document Properties pane... 9 Create a basic view... 9 Add custom properties to a view Set a view for Interact for Epic Viewer Create a view for a specific document type Create a document review process Create an ImageNow workflow process Enable the Flag for Review button Update Epic with document IDs or descriptions Modify the Epic Scan capture profile Configure ImageNow for an image description Create an update Epic view Configure the update Epic settings

4 Perceptive Interact for Epic Perceptive Interact for Epic provides embedded access to your ImageNow documents from within Epic s health information system. This tight integration allows you to scan and retrieve ImageNow documents based upon the currently viewed patient chart without leaving the Epic environment. When ImageNow receives new documents, it notifies Epic of the arrival of relevant medical information. From Epic, users can open the documents for viewing within the embedded Interact for Epic Viewer. With the enhanced chart printing functionality, users can print entire patient charts, including both ImageNow documents and Epic chart information, from within Epic. This document explains how to install the Interact for Epic Server, Interact for Epic Client, and Interact for Epic Release of Information (ROI) plug-in with both attended and unattended installation methods. The guide also explains how to configure Apache Tomcat. For product technical specifications and system requirements, refer to the ImageNow Technical Specifications 6.7.x. Prerequisites You must install and have access to the following programs before installing Interact for Epic. ImageNow Server, version 6.7.x For compatibility, the ImageNow Server build number must be equal to, or higher than, the Interact for Epic Server build. You must have an ImageNow user login with management privileges, a manager login, or the owner login. Apache Tomcat, version 7.x or higher 4

5 Install Interact for Epic Server This guide assumes you are installing Interact for Epic for the first time, or that you have no earlier versions running on your computer. However, you can update Interact for Epic using the same steps. The installation wizard detects the update and installs the product accordingly. For information about enhancements and changes that might apply to Interact for Epic, refer to the ImageNow 6.7.x Release Notes. Download the Interact for Epic files To download the Interact for Epic files, complete the following steps. 1. Go to the Perceptive Software website at and log in to the Customer Portal. 2. On the Downloads page, download the following files to a temporary directory on your computer. The latest 32- or 64-bit build of Interact for Epic Server, as shown by the highest build number. 3. Complete the installation on a computer that has the following access. Internet access Network access to ImageNow Server Obtain the license files To obtain the hardware information for ImageNow Server, you must be the admin user on Windows. To obtain the license files, complete the following steps. 1. To generate a system fingerprint, complete the following substeps. 1. On the ImageNow Login page, click License Manager. 2. In the License Management dialog box, select Save system fingerprint and click OK. 3. In the Save As dialog box, name the report and click Save. 2. Contact your Perceptive Software representative for instructions on where to send the system fingerprint file to obtain your license. The system fingerprint file has a SYSFP extension. 3. When you receive the license files, store the license files in a temporary directory on the ImageNow Server computer. Install ImageNow product licenses Before entering your licenses, you must have installed the ImageNow Server and at least one ImageNow Client. You must have Service Administrator privileges to install ImageNow licenses. The ImageNow Client must be available on a Windows machine in order to install the ImageNow product licenses. 1. When you receive the license files from your Perceptive Software representative, copy them to a temporary folder where you can access them with an ImageNow Client. 2. To upload licenses, complete the following substeps. 1. On the ImageNow Login page, click License Manager. 2. In the License Management dialog box, select Upload Licenses and click OK. 3. Navigate to the folder where you stored the ImageNow license files, select the LIC files to upload, and click Open. 5

6 4. Type the User Name, Password, and Server Location and click OK. 5. Optional. The License Upload dialog box lets you view the type name, actual license code, and status of each license upload. To display detailed information for a specific license, select the appropriate row. 3. Click OK. Run the Interact for Epic attended installation To run the Interact for Epic Server, complete the following procedures. Install Interact for Epic Server 1. Double-click the Interact for Epic Server file you downloaded. 2. On the Welcome to the Installation Wizard for ImageNow Interact for Epic Server page, click Next. 3. On the License Agreement page, read the agreement, click I accept the terms in the license agreement, and then click Next. 4. On the Destination Folder page, verify the location of, or click Change to select, your web application server and click Next. For example, [drive:]\program Files\Apache Software Foundation\Tomcat {version}\webapps\interactforepic\. 5. On the Interact for Epic Environment Configuration page, complete the following substeps. In the ImageNow server name field, type the server name. In the ImageNow server port number field, type the port number. In the Native application viewing list, select Enabled and click Next. 6. On the Ready to Install the Program page, click Install. 7. Stop your Apache Tomcat server. In the Interact for Epic Server dialog box, click OK. 8. When the installation is complete, click Finish, and start Apache Tomcat server. Argument Description Default Example L*V If you use this argument, setup does not create directories. The path for the log file generation must be a valid, existing path. This argument is typically used to diagnose installation errors. If the command line argument is removed, it defaults to %TEMP%. L*V \"C:\logs\Server_Unattended Install.txt\" INSTALLDIR The location of the Interact for Epic Server files. [drive:]\program Files\Apache Software Foundation\ Tomcat\7.0\ webapps\ interactforepic INSTALLDIR= \"C:\Epic\ImageNow\Server\" ES_PORT ImageNow Server port ES_PORT_VAL=6000 6

7 Argument Description Default Example ES_HOST ImageNow Server host. blank ES_HOST_VAL=jdoe XML_NATIVE. VIEWER Specifies whether to view documents in the native application. TRUE XML_NATIVE.VIEWER_VAL=TR UE Enter the following command using one of these methods. A command in the Command Prompt window A command line script you create for your deployment software, for example: Interact for Epic Server 32-bit <build>.exe /s /V"/qb <argument list>" The following example shows the command format using argument values. Interact for Epic Server 32-bit <build>.exe /s /V"/qb /L*V \"%LOGFILE%\" INSTALLDIR=\"%INSTALLDIR_VAL%\"ES_PORT=%ES_PORT_VAL% ES_HOST=%ES_HOST_VAL% XML_NATIVE.VIEWER=%XML_NATIVE.VIEWER_VAL%" Share web applications on Apache Tomcat You can configure your Apache Tomcat server to run multiple web applications simultaneously. Any web application that authenticates with ImageNow Server must share the encryption.jar file to run an additional web application on the same web application server. For information on configuring a shared encryption.jar file, refer to the following sections. About web application installation When you install multiple web applications on the same Apache Tomcat server, you store each web application in its own directory. The default file location can vary according to your customized installation. The following table shows sample locations. Web Application Server Apache Tomcat Apache Tomcat Sample Web Application WebNow Interact for Epic Default Installed Directory [drive:]\{path}\apache Software Foundation\Tomcat 7.0\webapps\webnow [drive:]\{path}\apache Software Foundation\Tomcat 7.0\webapps\interactforepic 7

8 Configure Apache Tomcat to run multiple web applications To run multiple web applications simultaneously on Apache Tomcat, you must configure the server to share a single encryption.jar file between all of the web apps. Complete the following steps: When running Integration Server and one or more Perceptive web products on the same instance of Apache Tomcat, you must share one encryption file between all of the Perceptive web products. Important You must complete the following steps for all Perceptive web applications that share a web server instance such as ImageNow Forms Server or WebNow on the same instance of Apache Tomcat. 1. Stop the Apache Tomcat server. 2. Navigate to [path]\${tomcat_home}\webapps\integrationserver\web-inf\lib directory, locate the encryption.jar file, and move it to [path]\${tomcat_home}\tomcat\lib. 3. Start the web application server. Configure Interact for Epic Use any of the following procedures as a guide to configure Interact for Epic s features. Set up single sign-on for Interact for Epic After you install Interact for Epic, you can set up single sign-on (SSO). SSO allows your users to log on to Interact for Epic Viewer, CDV, Scan, the ROI plug-in and ImageNow Client using your SSO provider logon. To enable SSO fully, follow the procedures below to configure the SSO settings. Then perform one of the following procedures. Configure the SSO settings To set up SSO for Interact for Epic, use the following procedures to configure the SSO settings in the Epic.settings and inow.ini files. Configure the Epic.settings file Complete the following steps to configure SSO in the Epic.settings file. 1. On the Apache Tomcat server, navigate to the [drive:]\{path}\apache Software Foundation\Tomcat {version}\webapps\interactforepic\web-inf folder. 2. Using a text editor, open the Epic.settings file. 3. Under [Login], set sso to TRUE. 4. Save and close the Epic.settings file. 8

9 Configure the inow.ini file To enable SSO between Interact for Epic and ImageNow, complete the following steps. 1. On the ImageNow Server computer, navigate to the [drive:]\{path}\inserver6\etc folder. 2. Using a text editor, open the inow.ini file. 3. Under [Logon Control], add the following settings. Create the setting epic.sso and set to TRUE. Create the setting epic.sso.key and specify a value for the token sent from ImageNow. The value can be any valid string. Note Use this value for the sso.key setting in the INEpicViewer.ini, INEpicCDV.ini, and INEpicScan.ini files. 4. Save and close the inow.ini file. Customize the Document Properties pane Using Management Console, you can create custom document views. In the ImageNow Explorer, document views allow you to: Filter search results. Select which document properties appear as columns. Create custom document property labels. In Interact for Epic Viewer, custom document property labels for your view appear in the Document Properties pane. To configure Interact for Epic Viewer with a view to display and label specific document properties, use the following procedures in order. Create a basic view. Set a view for Interact for Epic Viewer. Optional. Create a view for a specific document type. Create a basic view The following steps explain how to create a new document view in Management Console and define the view components in View Designer. To complete this procedure, you must have document view management privileges. 1. In Management Console, in the left pane, click Views. In the right pane, on the Document tab, click New. 2. In the New View dialog box, complete the following substeps. 1. In the Name box, type a name. For example, Epic. 2. In the Description box, type the description of the view that will appear in the ToolTip for the view. 3. Click OK. 3. Select the view and click Modify. 9

10 4. In View Designer, in the Preview pane, click the Columns button, complete any of the following actions, and then click OK. To display a column in the view, select the check box next to the document property. To create a custom label for a document key, click the document key row, type the new name, and press ENTER. Note You can only create custom labels for the following document properties: Drawer, Field1, Field2, Field3, Field4, Field5, and Type. To rearrange the order of the columns, select a document property and click the Move Up or Move Down button. Add custom properties to the view. For more information on adding custom properties to a view, refer to the Add custom properties to a view section. 5. In the View Designer window, click the Properties button and complete the following substeps. 1. On the View Properties window, on the Security tab, under Users and Groups, click Add. 2. In the Select Users and Groups window, on the Groups tab, under Search results, click All Users, click the Add button, and then click OK. Note Rather than adding the group All Users, you can create or add a specific group. For example, Epic Users. Any user not included in the group is not able to access any document in Interact for Epic. 3. In the View Properties window, click OK. 6. Click the Run button to view your changes. 7. Save and close View Designer. 8. In the View Designer dialog box, perform one of the following actions. If you want the view to appear in ImageNow Explorer as an active view in addition to applying labels and restricting fields in Interact for Epic, click Yes to activate the new view. If you want to use the view only to apply labels to fields in Interact for Epic, click No. Add custom properties to a view To add a custom property to a view, complete the following steps. 1. In Management Console, in the left pane, click Views. In the right pane, on the Document tab, double-click the view you want to modify. 2. In View Designer, in the Preview pane, click the Columns button and click Add. 3. In the Custom Property dialog box, under Select a custom property, select a custom property and click OK. 4. In the Columns dialog box, select the check box next to the custom property and click OK. 5. Click the Run button to view your changes. 6. Save and close View Designer. 10

11 Set a view for Interact for Epic Viewer The following steps explain how to configure Interact for Epic to use a view. With a view, Interact for Epic Viewer displays the specified document properties and labels in the Document Properties pane. 1. On the web application server, navigate to the [drive:]\{path}\interactforepic\web-inf folder. For example, [drive:]\program Files\Apache Software Foundation\Tomcat {version}\webapps\interactforepic\web-inf. 2. Using a text editor, open the Epic.settings file. 3. Under [Display settings] section, set properties.view.name to the name of the view you created in Management Console. For example, properties.view.name=epic 4. Save and close the Epic.settings file. Create a view for a specific document type After you create and set a basic view for Interact for Epic Viewer, you have the option to create additional views for individual document types. For example, if you had a document type Digital Photos, you could create a document type-specific view and label Field1 with "Date & Time Photo Captured." By making a specific view for your Digital Photos documents, the label "Date & Time Photo Captured" only appears on your Digital Photos document types. You do not need to create a separate view for every document type. Interact for Epic Viewer uses the basic view you set in properties.view.name, such as "Epic," for any document type without its own, specific view. 1. In Management Console, in the left pane, click Views. In the right pane, on the Document tab, click New. In the New View dialog box, complete the following substeps. 1. In the Name box, type a name in the format {basic view name} - {document type}. For example, for a basic view named "Epic" and the document type of "Digital Photos", name the view Epic Digital Photos. 2. In the Description box, type a description of the view that will appear in the ToolTip for the view. 3. Click OK. 2. Select the view and click Modify. 3. In the View Designer window, in the Preview pane, click the Columns button, complete any of the following substeps, and then click OK. To display a column in the view, select the check box next to the document property. To create a custom label for a document property, click the document property row, type the new name, and press ENTER. Note You can only create custom labels for the following document properties: Drawer, Field1, Field2, Field3, Field4, Field5, and Type. Add custom properties to the view. For more information on adding custom properties to a view, refer to the Add custom properties to a view section. To rearrange the order of the columns, select a document property and click the Move Up or Move Down button. 4. In View Designer, click the Properties button and complete the following substeps. 11

12 1. In the View Properties dialog, on the Security tab, under Users and Groups, click Add. 2. In the Select Users and Groups dialog, on the Groups tab, under Search results, click All Users, click the Add button, and then click OK. Note Interact for Epic blocks any user not given permission to access this view from accessing the document. If you created a special user group in the Create a basic view procedure, such as Epic Users, you must give the group permission to access this view. 3. In the View Properties window, click OK. 5. Optional. If you want the view to appear in ImageNow Explorer as an active view, you need to constrain the view to the document type. Otherwise, the view returns all document types in ImageNow. 1. On the View tab, click the Add button. In the Add Condition dialog box, complete the following substeps. 1. In the Constrain By list, select Document key. 2. In the Type list, select Normal. 3. In the Field list, select Type. Note If you applied a custom label to Type, the custom label appears instead of Type. 4. In the Operator list, select is equal to. 5. In the Value list, select the document type you specified in the view name. For example, you might select the Digital Photos document type. 2. Click OK. 6. Save and close View Designer. 7. In the View Designer dialog box, perform one of the following actions. If you want the view to appear in ImageNow Explorer as an active view in addition to being able to apply labels and restrict fields in Interact for Epic, click Yes to activate the new view. If you want to use the view only to apply labels and restrict fields in Interact for Epic, click No. Tip Keep properties.view.name in Epic.settings set to the name of the basic view, such as "Epic." Interact for Epic Viewer automatically displays either the basic view, such as "Epic," or a document type-specific view, such as "Epic Digital Photos," based on the active document s type. Create a document review process With Interact for Epic version or higher, you can enable your Interact for Epic users to flag documents that may have inaccurate or missing information. For example, a patient MRN that does not correctly match the patient name. To enable this feature, complete the following procedures. Create an ImageNow workflow process with queues that correspond to possible error reasons. Enable the Flag for Review button. 12

13 Create an ImageNow workflow process To create a new workflow for the document review process, complete the following procedures. Create the workflow process Complete the following steps. 1. In Management Console, in the left pane, click Workflow. 2. In the right pane, on the Workflow tab, click New. 3. In the Add Process dialog box, in the Name box, type a name for the document review process. For example, EpicReviewDocs. Create the review-reason queues Complete the following steps. 1. To open the workflow process, double-click the name. 2. In Workflow Designer, in the left pane, under Queues, drag a Work queue to the process diagram. 3. To modify its properties, double-click the queue. 4. In the Queue Properties dialog box, in the left pane, click Properties. Then, in the right pane, under General, in the Name box, name the queue with a document-review reason. For example, Incorrect MRN. 5. Repeat the process to add a queue for each potential document-review reason. Example queues include: Incorrect MRN, Incorrect CSN, Incorrect Order, and Delete Document. 6. Close Workflow Designer. Enable the Flag for Review button To enable the Flag this document for review complete the following steps. 1. Open the epic.settings file with a text editor. 2. Under [Review Reason Settings], set enable.flag.for.review to TRUE. button on the Interact for Epic Viewer toolbar, 3. Set review.reason.process to the name of the ImageNow workflow process you created in the previous section for flagging documents. For example, review.reason.process=epicreviewdocs. 4. Save and exit the configuration file. 13

14 Update Epic with document IDs or descriptions You can configure Epic Scan to pass ImageNow information to Epic, such as document IDs or specific image descriptions, immediately at the time of capture. By default, Epic Scan sends the general description "ImageNow Scan" to Epic for each scanned image. Epic uses this description in the text of the link to the ImageNow document. To provide Epic with a specific image description, you can configure Epic Scan to send the value of an ImageNow Field or custom property. To update Epic with ImageNow document IDs complete the following procedure. Modify the Epic Scan capture profile. To update Epic with user-typed image descriptions, complete the following procedure. Configure ImageNow for an image description. Then, complete the following procedures. Create an update Epic view. Configure the update Epic settings. Modify the Epic Scan capture profile To update Epic immediately with document IDs, you must reserve a document key for the Epic Unique ID in the Epic Scan capture profile. To modify the Epic Scan capture profile, complete the following steps. Prerequisite To create an Epic Scan capture profile, refer to the Create an Epic Scan capture profile section. 1. On the ImageNow toolbar, click the arrow next to Capture and click Manage Capture Profiles. 2. In the Capture Profiles dialog box, double-click the capture profile you created in Create an Epic Scan capture profile to modify it, such as Epic Scan. 3. To assign a Field for the Epic Unique ID, in the capture profile dialog box, on the Document Keys tab, double-click a Field. For example, Field5. 4. In the Key Definition dialog box, in the Type list, select COM Value. 5. Clear the Allow user updates to this value check box and click OK. 6. Click OK and Close. Configure ImageNow for an image description To update Epic with image descriptions, you must configure ImageNow by reserving a document key or creating a custom property. You can set a default description or allow users to add a description during the scan process. The following example describes how to create a user entry description. Complete one of the following steps. To assign a Field for the image description, complete the following substeps. 1. On the ImageNow toolbar, click the arrow next to Capture and click Manage Capture Profiles. 2. In the Capture Profiles dialog box, double-click the capture profile you created in Create an Epic Scan capture profile to modify it, such as Epic Scan. 14

15 3. In the capture profile dialog box, on the Document Keys tab, double-click a Field. For example, Field3. 4. In the Key Definition dialog box, in the Type list, select User entry, and click OK. 5. Click OK and Close. To create a custom property for the image description, complete the following steps. 1. In Management Console, create a string custom property, such as Image_Description. For more information on creating custom properties, refer to "Create a custom property" in Management Console Help. 2. Assign the custom property to all applicable document types. For more information on assigning custom properties, refer to "Assign a custom property to a document type" in Management Console Help. Create an update Epic view Create a view to retrieve ImageNow document IDs or specific image descriptions and send them to Epic through the Epic Scan API. Complete the following steps. 1. In Management Console, in the left pane, click Views. In the right pane, on the Document tab, click New. 2. In the New View dialog box, in the Name box, type a name and click OK. 3. Double-click the new view. 4. In ImageNow View Designer, in the Preview pane, click the Columns button. In the Columns dialog box, complete the following substeps. 1. Select the following check boxes. Drawer Field1 through Field5 Type Document ID The custom property for an image description. For more information on adding a custom property to a view, refer to the Add custom properties to a view section. 2. Clear the Name check box and click OK. 5. For each drawer that stores Epic Scan documents, on the View tab, click the Add button and create the following conditions. In the Constrain by list, select Document key. In the Type list, select Normal. In the Field list, select Drawer. In the Operator list, select is equal to. In the Value list, select a valid drawer. 6. Create a condition to return each document type available to Epic Scan. Tip To return all document types, in the Operator list, select is not blank. 15

16 7. Grant the Access privilege to all users of this view. 8. Save and close View Designer. Configure the update Epic settings To configure the update Epic settings, complete the following steps. 1. Open the INEpicScan.ini file with a text editor. 2. Under [Capture], set capture.profile.name to the name of the capture profile you created in Create an Epic Scan capture profile. For example, EPIC SCAN. 3. Under [Key Mapping], set the Field you designated for the Epic Unique ID in Create an Epic Scan capture profile to a blank value. For example, FIELD5. 4. Under [General], complete the following substeps. Set update.epic to TRUE. Set update.epic.view to the name of the view you created in the Create an update Epic view section. Set update.epic.unique.id.field to the Field you designated for the Epic Unique ID. For example, FIELD5. Set update.epic.description.field to the Field or custom property you designated for the scan description. For example, FIELD3 or IMAGE_DESCRIPTION. 5. Save and close INEpicScan.ini. 16