EMC Documentum Connector for EPIC

Transcription

1 EMC Documentum Connector for EPIC Version 1.8 Installation Guide EMC Corporation Corporate Headquarters Hopkinton, MA

2 Legal Notice Copyright EMC Corporation. All Rights Reserved. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDF Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks used herein are the property of their respective owners. Documentation Feedback Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we can make our documentation better or easier to use, please send us your feedback directly at ECD.Documentation.Feedback@emc.com

3 Table of Contents Revision History... 7 Chapter 1 Before You Install... 9 Chapter 2 Security Configuration Access Control Settings Authentication for C4E Components Default Accounts Authentication Configuration User Authorization for C4E Documents Communication Security Settings Port Usage Network Encryption Secure Deployment and Usage Settings Chapter 3 Pre-installation Tasks Preparing the Installation Environment Deploying Object Types Chapter 4 Installing the Epic Integrator Configuration Utility Chapter 5 Configuring C4E Configuring the Epic Integrator Configuration Utility Configuring the Login Settings Configuring the DCTM Server Settings Configuring the Mime Type Settings Configuring the Scan Settings Configuring the EOB Settings Configuring the Document Types Configuring the Metadata for XDS Registration Chapter 6 Configuring Epic Hyperspace Configuring C4E for Third-party Scanner Integration FDI Record Settings LWP Record Settings SDF Settings EAF/HSD Settings Configuring the Program ID in Epic Hyperspace Chapter 7 Installing Epic ROI Installing the Epic ROI Module Configuring the Epic ROI Module

4 Table of Contents Chapter 8 Installing EpicCare Integrator Installing EpicCare Integrator Configuring EpicCare Integrator Configuring the Program ID for EpicCare Integrator Chapter 9 Installing Thumbnail Services Installing Thumbnail Services Configuring Thumbnail Services Creating WCF Service for Thumbnail Verifying the WCF Service Chapter 10 Installing Welcome Kiosk Utility Installing the Welcome Kiosk Configuration Utility Configuring the Welcome Kiosk Configuration Utility Creating WCF Service for Welcome Kiosk Verifying the WCF Services Configuring the Metadata for XDS Registration Chapter 11 Troubleshooting Log Settings Log Description C4E Issues and Resolutions C4E Connection Issues C4E Screen not Loading Cause Resolution Error in Retrieving the Document Cause Resolution Unhandled Exception when Clicking Scan Cause Resolution C4E Installation Issues Error in Initializing TWAIN Cause Resolution Unable to find the AX Viewer Cause Resolution Epic Reports an Error with ActiveX Cause Resolution C4E General Issues Content Transfer fails with the Image Retrieval (Thumbnail) Service Cause Resolution System.OutOfMemoryException when Scanning Pages with 600 DPI Double-sided and 24-bit Color Cause Resolution Unable to Import a File Format Cause Resolution

5 Table of Contents Creation of Document Fails Cause Resolution New Documents not Created in Patient Folder Cause Resolution Document gets a Unique ACL Cause Resolution C4E Scanner Screen does not Load Cause Resolution C4E ROI Issues and Resolutions C4E ROI Connection Issues Unable to Connect to the Repository Server Cause Resolution C4E ROI Installation Issues Error During Installation Cause Resolution Epic is Unable to Locate the Plug-in Cause Resolution C4E ROI General Issues EPIC Fails to Print the Documents Cause Resolution Unable to Access Document Cause Resolution Content Server Error when Finding Object Types Cause Resolution Error Received when Trying to Render Document Cause Resolution Appendix A Sample Configuration Files AppSettings.xml DCTMSettings.xml MimeTypes.xml ScanSettings.xml EobSettings.xml ROI Module AppSettings.xml ROI Module DCTMSettings.xml

6 Table of Contents 6

7 Revision History Revision Date November 2015 October 2015 August 2015 Description Updated the Program ID of EpicCare Integrator in FDI settings and Configuring the Program ID for EpicCare Integrator. Added Program ID of EpicCare Integrator in FDI settings. Added a section for configuring the Program ID for EpicCare Integrator in the chapter C4E EpicCare Integrator Installation. Initial publication. 7

8 Preface 8

9 Before You Install Chapter 1 Before beginning installation, ensure that your system meets the requirements. The EMC Documentum Connector for Epic Release Notes provides information on system requirements supported for this release. The documentation is available at EMC Online Support ( 9

10 Before You Install 10

11 Chapter 2 Security Configuration This chapter contains the following topics: Access Control Settings, page 11 Communication Security Settings, page 12 Secure Deployment and Usage Settings, page 13 Access Control Settings Access control settings enable the protection of resources against unauthorized access. Authentication for C4E Components You can use the Epic Hyperspace to access Connector for Epic (C4E). The Epic Hyperspace application administrator controls all access to C4E. C4E uses a single Documentum account for all operations. Login prompt is not provided to users because this single account is configured in the configuration tool and shared by all users. Default Accounts There are no specific default accounts. The customer s Documentum Administrator must determine and configure the account to be used for all C4E client installations. Authentication Configuration C4E contains a configuration utility to configure the authentication information. You must specify the repository name, user name, and password in the utility (this information is encrypted in the configuration files). This account can be any type of Documentum account as long as the authentication information required above can be provided. 11

12 Security Configuration User Authorization for C4E Documents C4E does not provide any authorization on users. A single user performs all C4E operations to access the documents in Documentum. This user must have Access Control List (ACL) permissions to access these documents. All content created by C4E is configured with an ACL. ACL can be configured in the configuration tool. The default ACL is hip_repository_acl. If the configuration is left blank, it indicates that the Documentum runtime ACL is generated. Communication Security Settings The communication security settings enable the establishment of secure communication channels between the product components and between product components and external systems or components. Port Usage Component Service Protocol Port Description C4E Viewer/Scanner NA http 80 NA C4E EpicCare Integrator C4E ROI NA http 80 NA C4E Viewer/Scanner NA http 9080 ACS C4E EpicCare Integrator C4E ROI NA http 9080 NA Network Encryption You can use SSL if it is configured on the web services application server. In the configuration URL, you can designate the HTTPS protocol in the URL string. 12

13 Security Configuration Secure Deployment and Usage Settings The following figure illustrates the C4E layers: Documentum Foundation Services product documentation provides more information about the security settings for deployment of the web services layer. 13

14 Security Configuration 14

15 Chapter 3 Pre-installation Tasks This chapter contains the following topics: Preparing the Installation Environment, page 15 Deploying Object Types, page 17 Preparing the Installation Environment Component C4E Installation Files Task Download the following files from EMC Download Center: Content Server hip-dctm dar hip-xds dar c4e-scannerandviewer msi c4e-epicareviewer msi c4e-eps-painter-plug-in msi c4e-thumbnailservice msi c4e-welcomekioskinstaller msi Content Server 7.1 or 7.2 is installed. ComposerHeadless The dardeployer.exe file located in C: \Documentum\product\6.7\install\composer \ComposerHeadless is installed. Documentum Content Transformation Services (CTS) The HIP DAR files contain the data models that are required to perform operations using C4E. Documentum CTS 7.1 or 7.2 is installed. EMC Documentum Content Transformation Services Installation Guide provides detailed instructions to install CTS. 15

16 Pre-installation Tasks Component Documentum Advanced Document Transformation Services (ADTS) Documentum Media Transformation Services (MTS) Documentum Thumbnail Server Desktop Experience HIP Repository Server HL7.properties AX Viewer Epic Hyperspace Client Epic Print Server (EPS) Scanner Citrix Microsoft Visual C++ Microsoft.NET Framework Datalogics PDF2Image Task Documentum ADTS 7.1 or 7.2 is installed. EMC Documentum Advanced Document Transformation Services Installation Guide provides detailed instructions to install ADTS. Documentum MTS 7.1 or 7.2 is installed. Documentum Media Transformation Services Installation Guide provides detailed instructions to install ADTS. Documentum Thumbnail Server 7.1 or 7.2 is installed. EMC Documentum Thumbnail Server Release Notes, Installation and Administration Guide provides detailed instructions to install and configure Thumbnail Server. Desktop Experience on Windows Server machines is enabled. HIP Repository Server 1.8 is installed and tested. HL7.properties file is deployed and configured. This is required for batch scanning integration with Epic. AX Viewer is installed. Epic Hyperspace 2010, 2012 or 2014 client is installed on all required workstations. EPS 2010, 2012 or 2014 is installed and tested. Scanner is connected to your network and is functioning properly. Citrix XenApp Server 6.5 or 7.5 is installed, if Epic Hyperspace is published via Citrix to the Epic Workstation machine, where the scanner is connected and the respective scanner driver is installed. Microsoft Visual C redistributable installer (vcredist_x86.exe) is present in the Windows server where C4E needs to be installed. If not present, download it from and install it. Microsoft.NET Framework 4.5 is downloaded from and installed. Microsoft.NET Framework Features is enabled. Datalogics PDF2Image (PDF2IMG.msi) present in the c4e_prerequisites folder is installed. 16

17 Pre-installation Tasks Component Documentum User Account Documentum Foundation Services (DFS) Task Documentum user account is created for the use of Epic Integration solution components. Do not share the information about this account with other administrative functions. DFS 7.1 or 7.2 web service is functioning properly. Deploying Object Types The HIP DAR files must be deployed before you can perform any operation such as import, scan, and so on using C4E. The following DAR files contain the data models that are required to complete the operations: hip-dctm dar: Stores the HIP Healthcare Information Model for Documentum object types. hip-xds dar: Stores the XDS object types. 1. Go to <DCTM_install_dir>\product\7.1\install\composer\ComposerHeadless\. 2. Double-click dardeployer.exe. 3. Configure the following settings in the DAR Details and Docbroker Details panel: DAR: Browse and select the DAR file. Docbroker Host: Select your Docbroker host. Docbroker Port: Define the port number for your Docbroker host. 4. Click Connect. 5. Configure the following settings in the Repository Details panel: Repository: Select the Documentum repository from the list. User Name: Type the Documentum Content Server user name. Password: Type the password for the Documentum Content Server user name. 6. Click Install. The DAR Installer shows a message when the DAR files are successfully installed. Deploy both the DAR files as mentioned above. 17

18 Pre-installation Tasks 18

19 Chapter 4 Installing the Epic Integrator Configuration Utility 1. Uninstall the existing version, if any. 2. Delete the config files, temp files and temp folders from the installation directory. 3. Download the c4e-scannerandviewer msi file to a local folder. For example: C:\c4escannerandviewer\c4e-scannerandviewer msi 4. Double-click c4e-scannerandviewer msi. 5. Select I accept the terms in the License Agreement. 6. Click Install to start the installation process. 7. Click Finish. Note: If you do not uninstall the current version and remove the config files from the installation directory, you will receive an XML error and the configuration tool will crash when it attempts to load one of the previous XML files. 19

20 Installing the Epic Integrator Configuration Utility 20

21 Chapter 5 Configuring C4E This chapter contains the following topics: Configuring the Epic Integrator Configuration Utility, page 21 Configuring the Document Types, page 36 Configuring the Metadata for XDS Registration, page 38 Configuring the Epic Integrator Configuration Utility 1. Go to the C4E installation directory. For example: C:\Program Files (x86)\emc\c4escannerandviewer 2. Double-click DCTM_EpicIntegratorConfig.exe. 3. Configure the following tabs: Login: Contains basic information about your Documentum repository. Configuring the Login Settings, page 22 provides more information on login configuration. DCTM Server: Contains the DFS URL and the format of DOCUID. Configuring the DCTM Server Settings, page 23 provides more information on DCTM server configuration. Mime Types: Contains the media types in your repository that C4E supports. For each mime type, you can decide whether the integrated Documentum Viewer or any another application allows you to view the file. If the viewer encounters an unsupported media format, the application uses the default Windows viewer for the file type. Configuring the Mime Type Settings, page 25 provides more information on mime type configuration. Scanning: Contains the settings required for scanning operations. Configuring the Scan Settings, page 27 provides more information on scanning configuration. EOB: Contains the settings for EOB scanning. Configuring the EOB Settings, page 32 provides more information on EOB configuration. 21

22 Configuring C4E 4. Click Save. You must click Save after you configure each tab. The configuration settings in each tab in the configuration utility are saved in the corresponding XML file. You can copy and deploy these files to other locations that require the same settings. Appendix A, Sample Configuration Files provides a sample of the above files. 5. Click Exit to close the utility. Configuring the Login Settings 1. Click Login. 2. Configure the login properties as described in the following table: Field Default DCTM Repository Name DCTM Repository User Name DCTM Repository Password Admin User Name Description Type the name of the Documentum repository to which C4E is connected. Type the Documentum user name that C4E uses for all Documentum operations. This user account must be exclusive to the Epic EMR Integration solution. Type the password for the Documentum user name. Type the name of the admin user. By default, the admin user name is EpicAdmin. Log Output Epic must pass this user account to C4E to enable the admin user interface. Select the type of information required in the C4E log file. 3. Click Save. For example: Debug (All): All messages, errors, and warnings are written to the log file. Warnings & Errors: All errors and warnings are written to the log file. Errors Only: Critical errors are written to the log file. None: Disables logging. The AppSettings.xml file stores the settings you defined in the Login tab. 22

23 Configuring C4E The schema for this file is <installation_dir>/appsettingsschema.xsd. Configuring the DCTM Server Settings 1. Click DCTM Server. 2. Configure the DCTM server properties as described in the following table: Field DCTM Base URL Description Type the Documentum Web Services Server URL. For example: Check URL Document ID (DOCUID) Format Mask Builder Default Document Type The server name indicates the hostname of the machine where the application server is installed. Click to validate the URL. An error message appears if the URL is not valid. Shows the syntax that C4E uses to create the Epic Document Unique Identifier (DOCUID). You can create the syntax using Document ID (DOCUID) Format Mask Builder. Click to define the syntax that C4E uses when it creates the Epic DOCUID. Select the document type that you want to set as default. The list of options shows all document object types that you have created under a specific document object. Default Folder Type The default document object is dmh_document. Select the folder type that you want to set as default. The list of options shows all folder types that you have created under a specific folder object. The default folder type is dmh_patient_folder. 23

24 Configuring C4E The following figure shows the DOCUID Format Mask Builder: 3. To create a Document ID Format using Document ID (DOCUID) Format Mask Builder: a. Configure the DOCUID Format Mask Builder as described in the following table: Field Document ID (DOCUID) Delimiter Fields/Formulas Description Type a delimiter to separate the values in DOCUID. For example, /. You cannot use the reserved characters such as %, [], *, and " as delimiters. Contains the following data fields and variables that you can use to construct the DOCUID syntax. DCTM_objectId: A variable that provides the value of the object ID from the Documentum repository. DCTM_Repository: A variable that provides the name of the default Documentum repository. This is the name that you defined in the Login tab. %DATETIME%: The current date and timestamp in the YYYYMMDDHHMMSSA format. %DATE%: The current date in the YYYYMMDD format. %TIME%: The current time in the HHMMSSA format. b. From Fields/Formulas, select DCTM_objectId and click to add the field/formula to the Display Order list. 24

25 Configuring C4E Note: DCTM_objectId is mandatory to create a Document ID Format Mask. c. Select other required Fields/Formulas and click to add the field/formula to the Display Order list. To add a Literal Value to the Document ID Format Mask: i. Select Literal Value from the Type options. ii. Type the value in the Value field and click to add the field/formula to the Display Order list. To delete a Field/Formula from the Display Order list: a. Select the Field/Formula you want to delete. b. Click. d. Click OK. 4. Select View PDF Renditions (when available) to view the scanned documents in PDF. During the view operation, C4E shows documents in PDF only if PDF rendition exists for the selected document in Content Server and if you have selected the View PDF Renditions option. If you are importing and rendering a JPEG file to PDF, you can view the PDF file only if you have selected the Viewer Support option in the Mime Types tab. Configuring the Mime Type Settings, page 25 provides more details about configuring mime type settings. 5. Select View the CURRENT version of a document if you want to view the latest version of a document. 6. Clear XDS Registration Enabled if you do not want to register the documents. By default, this option is enabled to register the documents in XDS Registry whenever they are created in Documentum. If enabled, it is mandatory that you configure the metadata for registration. Configuring the Metadata for XDS Registration, page 38 describes the procedure for metadata configuration. 7. Click Save. The DCTMSettings.xml file stores the settings you defined in the DCTM Server tab. The schema for this file is <installation_dir>/dctmsettingsschema.xsd. Configuring the Mime Type Settings 1. Click Mime Types. 2. Configure the mime type properties as described in the following table: Field Mime Type Description Type the mime type. 25

26 Configuring C4E Field Extension Description Type the file extension of the mime type. DCTM Format Name Viewer Support Type the Documentum format name of the mime type. To enter a new format name, which is not currently supported by DCTM, the Administrator must first create an entry for the new format name in Documentum as a Documentum format. Select this option if you want to open the mime type in the C4E Documentum viewer or to view the JPEG files rendered in PDF. All mime types are not supported by the Documentum viewer. Epic interface allows Windows to select the default application to open the mime types that are not supported by the Documentum viewer. TIFF Support If you want to disable Viewer Support for a mime type that has multiple format extensions, for example.jpg,.jpeg, then you must disable Viewer Support for all entries belonging to that mime type. Select the TIFF Support option to enable C4E to convert images to the TIFF format. When using your Epic workstation to upload multiple images for one patient record, this option enables C4E to convert the multiple images into a single, multi-page TIFF image. For example, if TIFF Support is enabled for the JPEG mime type, and if you upload three JPEG files, C4E converts all three images into a single multi-page TIFF image. If TIFF Support is enabled for both the BMP and JPEG mime types, and if you upload a bitmap image and a JPEG image, C4E will convert both the images to a single multi-page TIFF image. If one of the files cannot be converted (for example, an audio file) or if TIFF Support is not enabled for it, C4E will upload both files in their existing format. When you import multiple image files, you receive only one Object ID in response. However, when you import or scan multiple documents, each document and page will be added as separate objects in the docbase. Note: You can enable TIFF Support ONLY for image files. 3. Click. 26

27 Configuring C4E The defined mime type appears in the list as a tilde (~) separated expression as follows: Mime Type ~ File Extension ~ Documentum Format Name ~ Viewer Support (True/False), TIFF support (True/False) Note: You cannot add more than one mime type with the same values for Mime Type, Extension and DCTM Format Name. The mime types created with same values for Mime Type, Extension and DCTM Format Name, but with different values for Viewer Support and TIFF Support are considered as duplicate entries. The configuration utility shows an error message if you attempt to create a mime type with same values for Mime Type, Extension and DCTM Format Name. 4. To delete a mime type: a. Select the mime type to be deleted from the list. b. Click. A message "Are you sure you wish to remove the selected Mime Type" appears. c. Click Yes. The mime types that you delete from the configuration utility will not be available later for importing. 5. To edit a mime type: a. Select the mime type to be edited from the list. b. Edit the required fields. c. Click. A message "Are you sure you wish to edit the selected Mime Type" appears. d. Click Yes. 6. Click Save. The MimeTypes.xml file stores the settings you defined in the Mime Types tab. Because there are multiple configuration options for a single mime type, each grouping is contained within a separate mime type node. The schema for this file is <installation_dir>/mimetypeschema.xsd. Configuring the Scan Settings 1. Click Scanning. 2. Configure the scan properties as described in the following table: Field Configure Paper Sizes Description Click to open the Configure Paper Sizes dialog box. Select the paper sizes that must be visible to the users. The Default Paper Size list shows only the paper sizes that you select from this list. 27

28 Configuring C4E Field Default Paper Size Default Scan Mode Configure DPI Default DPI Default Page Sides Default Height Description Select the default paper size for scanning. By default, the paper size is US Legal. You can change this setting during scanning. Select the default scanning mode. Click to open the Configure DPI dialog box. Select the DPI that must be visible to the users. The Default DPI list shows only the DPIs that you select from this list. Select the default Dots Per Inch (DPI) setting for scanning. Select the default page sides for scanning Double sided or Single sided. Type the default height of the C4E scan and import application window. Default Height: 792 When a user launches the C4E scan and import application for the first time, the application window appears with the default height and width that you configured. When the user later changes the default window size by resizing it, an EpicUserSettings.xml file is created in the C4E installation directory and the modified size is saved in it. From then onwards, whenever the user launches the C4E scan import application, it takes the window size configuration from the EpicUserSettings.xml file and not from the C4E configuration utility. Default Width You can reduce the window height to minimum 477. Type the default width of the C4E scan and import application window. Default Width: 1029 Root Cabinet Group Context Name You can reduce the window width to minimum 897. Type the Documentum cabinet where C4E stores all the scanned and imported content. The cabinet name must be preceded by a / and must already exist in Documentum. Type the Epic context parameter name. C4E groups the documents based on this context parameter name. 28

29 Configuring C4E Field ACL Name Max. Import Size (MB) Description Type the ACL name that C4E applies to the scanned and imported documents. This name must already exist in Documentum. Type the maximum size of a file that C4E can import. C4E does not permit importing a file, if the file size is greater than the configured size. The maximum size of a file that C4E permits you to scan or import is 200 MB. The size of a scanned file is greatly increased if you choose: a high value for DPI Scan Mode as color Page Sides as double-sided Also, because the Max. Import Size permitted by C4E is 200MB, the larger the file size, the lesser the number of files you can scan or import at a time. Therefore, when scanning, ensure that the Scan Mode, Paper Size, Page Sides and DPI are selected in such a way that the size of the scanned file does not exceed 200MB. DPI has maximum effect on the file size, therefore reducing DPI can drastically reduce the file size. For example, EMC has tested the use of high quality full color scans of ophthalmology reports including optic disc cube color analysis. If the C4E users choose to scan the report double-sided in color mode with 600 DPI, C4E permits you to scan only maximum three pages. However, the same report scanned double-sided in color mode, with only 300 DPI, C4E permits you to scan maximum 14 pages. At 300 DPI the quality of the scanned report is still high and all data on the report can be easily interpreted. If you want to scan large quantity of files: split the files into loads less than 200MB or scan the files directly using a scanning software and then import using C4E in batches less than 200MB per scan 29

30 Configuring C4E Field Description Mode Description For very large batches, EMC recommends the use of a scanning engine or a direct load into HIP (using a custom bulk-loading tool). Select the mode in which you want to specify the document description when you scan or import a document. Based on your selection, the C4E user interface allows you to either select a description from the list of options or type a description for the scanned/imported document. Categorized: If selected, the C4E user interface shows a list of descriptions for the imported/scanned document. This description is saved as the Title of the document in the Documentum. Free Text: If selected, the C4E user interface allows you to type a description for the scanned/imported document in the Description field. Select Scanner Basic Scan Settings Advanced Scan Print Button By default, the description field shows <documenttype.file extension>. Select Show to show the Scan > Choose Scanner option in the C4E UI. Select Hide to hide the Scan > Choose Scanner option in the C4E UI. Select Show to show the Scan > Basic Scan Settings option in the C4E UI. Select Hide to hide the Scan > Basic Scan Settings option in the C4E UI. Select Show to show the Scan > Advanced Scan option in the C4E UI. Select Hide to hide the Scan > Advanced Scan option in the C4E UI. Select Admin Only if you want to grant permission to print the documents only to the administrators. Select All if you want to grant permission to print the documents to all users. 30

31 Configuring C4E Field Working Folder Description Click and select the folder where C4E stores the scanned documents or the documents selected for viewing. You must have full permissions to this folder. In addition, ensure that the working folder path ends with a \" This setting does not accept environment variables. By default, the configuration utility uses the C4E installation location. 3rd party application always on top On top Timeout (sec) The working folder is accessible by both Epic Hyperspace and Workstation machines, even if they are on different machines. Select this option if you want the third-party application window to appear on top of other windows. For example, if you select this option, the PDF Viewer appears on top of other windows. Type the time in seconds taken by the third-party application to load the window. The default value is 10 seconds. Note: The size of the documents that users can scan depends on the Java heap size of the application server. Therefore, when you scan the documents that occupy large memory size, for example, documents with high DPI, or documents with large number of pages or documents that need to be color scanned, you must ensure that the document size does not exceed the size permitted by the web services of the application server. A document that is successfully imported is stored in the Documentum server. When the imported document is added to Documentum, a dmh_patient_folder folder is created and the name of the patient is stored in the folder with the patient_name attribute. When adding a document to the repository, the Connector stores the following metadata to indicate if the document was scanned or imported: source_id = c4e_import source_id = c4e_scan When the import/scan operation is completed, you receive a message prompting you to confirm whether the scanned/imported document must be uploaded in the repository. When the documents are processed, the scanning interface shows a message indicating whether the operation was a success or a failure. If the scan or import operation is performed on a tiff file, the status of the c4e_scan or c4e_import input flag depends on the operation (scan or import) that is performed first. That is, if you perform a scan first, the input flag is c4e_scan and if you perform an import first, the input flag status is c4e_import. 3. Click Save. Configuring C4E for Third-party Scanner Integration, page 39 provides more information on C4E configuration for integration with a third-party scanning product. 31

32 Configuring C4E The ScanSettings.xml file stores the settings you defined in the Scanning tab. The schema for this file is <installation_dir>/scansettingsschema.xsd. Configuring the EOB Settings 1. Click EOB. 2. Configure the EOB properties as described in the following table: Field Payer Cabinet EOB ACL Mime Types Description Type the file cabinet in which the scanned/imported document is saved in the Documentum. The cabinet name must be preceded by a "/" and must already exist in the Documentum. Type the ACL name that C4E applies to the scanned and imported EOB documents. This name must already exist in the Documentum. All EOB documents must be saved using a single ACL. Select the mime types that must be available to the user while importing/scanning an EOB document. C4E supports only TIFF, JPG and PDF mime types for EOB documents. It is mandatory to select the supported mime types from this list. If you do not select a mime type, C4E displays a message prompting you to select at least one mime type. Configure Scan Type a. Click to open Scan Type Configuration Utility. b. From the list of scan types, select the scan types that must be available to the user in the EOB scan and import user interface. c. Click. The selected scan types are added to the Configure Scan Type list in the EOB tab. 32

33 Configuring C4E Field Description To add a new scan type: a. In the Add/Edit Scan Types below field, type the name of the scan type. You must specify the scan type in the following format: <digit>-<name of the scan type> For example: 0 Professional Billing Note: You must not add blank values in this field as this field is mandatory to create EOB ZBI messages. b. Click. To delete a scan type: a. From the list of scan types, select the scan type that you want to delete. b. Click. To edit a scan type: a. From the list of scan types, select the scan type you want to edit. b. In the Add/Edit Scan Types below field, make the required changes. You must not specify blank values in this field as this field is mandatory to create EOB ZBI messages. c. Click. Click Cancel to discard the changes and close the Scan Type dialog box. Configure Mode a. Click to open Mode Type Configuration Utility. b. From the list of batch modes, select the modes that must be available to the user in the EOB scan and import user interface. c. Click. The selected batch modes are added to the Configure Mode list in the EOB tab. 33

34 Configuring C4E Field Description To add a new batch mode: a. In the Add/Edit Batch Modes below field, type the name of the batch mode in the following format: <digit>-<name of the batch mode> For example: 1 Insurance You must not add blank values in this field as this field is mandatory to create EOB ZBI messages. b. Click. To delete a batch mode: a. From the list of batch modes, select the batch mode that you want to delete. b. Click. To edit a batch mode: a. From the list of batch modes, select the batch mode you want to edit. b. In the Add/Edit Batch Modes below field, make the required changes. You must not specify blank values in this field as this field is mandatory to create EOB ZBI messages. c. Click. Click Cancel to discard the changes and close the Mode dialog box. Configure Posting Department a. Click to open Posting Department Configuration Utility. b. From the list of posting departments, select the posting departments that must be available to the user in the EOB scan and import user interface. c. Click. The selected posting departments are added to the Configure Posting Department list in the EOB tab. 34

35 Configuring C4E Field Description To add a new posting department: a. In the Add/Edit Posting Department below field, type the name of the posting department. Note: You must not add blank values in this field as this field is mandatory to create EOB ZBI messages. b. Click. To delete a posting department: a. From the list of posting departments, select the posting department that you want to delete. b. Click. To edit a posting department: a. From the list of posting departments, select the posting department you want to edit. b. In the Add/Edit posting department below field, make the required changes. You must not specify blank values in this field as this field is mandatory to create EOB ZBI messages. Note: c. Click. Click Cancel to discard the changes and close the Posting Department dialog box. The values configured for Scan Type, Mode and Posting Department must be recognized by Epic and confirmed by the Epic implementation team. If you do not configure any value for Scan Type, Mode, and Posting Department, you get an error message when you attempt to launch the EOB scan and import user interface. When you open the Scan Type, Mode or Posting Department dialog box, all options in the list are selected by default. You cannot edit or delete multiple options at a time by clicking the edit or delete buttons. To edit or delete an option, you must select the option and click the respective buttons. 3. Click Save. The EobSettings.xml stores the settings you defined in the EOB tab. The schema for this file is <installation_dir>/eobsettingsschema.xsd. 35

36 Configuring C4E Configuring the Document Types 1. Go to the C4E installation directory. For example: C:\Program Files (x86)\epic\emc\c4escannerandviewer 2. Double-click DocTypeImportApp.exe. 3. Configure the fields as described in the following table: Field Server Url Repository UserName Password Select file Description Type the URL of the Documentum Web Services Server. This is the same URL you provided for DCTM Base URL in Configuring the Epic Integrator Configuration Utility, page 21. Type the name of the primary Documentum repository. This is the same repository name you provided for Default DCTM Repository Name in Configuring the Epic Integrator Configuration Utility, page 21. Type the Documentum user name. Type the password for the Documentum user name. Click and select the configuration file that contains your document types. Your configuration file should describe your document types in the following format: <record_type>,<description>,<record_type _level>,<enabled>,<subtype>,<type_id> document type: The document type value to be imported. For example, ABR. This is the value of record_type in the dmh_record_type table in Documentum. description: A description of the document type value. For example, ABR REPORT. document levels: The applicable document level for the document type. This is the value of record_type_level in the dmh_record_type table in Documentum. The acceptable values are single character values P, E, and O where P indicates Patient level, E indicates Encounter level and O indicates Order level. Each document type can have only one value for the document level. If a document type is available at 36

37 Configuring C4E Field Description multiple levels, a document type entry for each level should be created, each with a unique type_id. enabled: Indicates if the imported document type is enabled for use or not. Set to 1 to enable it for use. Set to 0 to disable the document type. subtype: The subtype of a record_type. type_id: The unique identifier to find a document type. 37

38 Configuring C4E Field Description Sample document type description: Diagnostic Voice Analysis,Diagnostic Voice Analysis,E,1,Voice Analysis, Click Import. 5. Click Close. Configuring the Metadata for XDS Registration C4E supports automatic registration of documents in XDS Registry whenever they are created in Documentum. C4E provides a lookup utility called Look uptable.exe that enables you to: Configure the Assigning Authority The value of Assigning Authority that you provide in the Lookup Table must already be present in the registry-config.xml of Registry. Import all the other mandatory metadata configurations required for document registration, from a.csv file. View all metadata configurations in read-only mode. For successful registration, you must: Enable the XDS Registration option in the DCTM Settings tab of C4E configuration utility. Configure all metadata attributes in the.csv file appropriately. Import the.csv file by using the Lookup Table. Ensure that the Department ID and DocTypes combination in the.csv file for the imported document is correct. If the combination of Department ID and DocTypes in the.csv file for the imported document is incorrect, the queue item for registration will not be created and the registration will fail showing an error message. However, the import operation will be successful. After you import the.csv file containing the configured metadata, whenever a document is imported or scanned, C4E creates a Registration XML file (automatic_registration.xml) with the configured metadata fields and attaches it to the registration queue for document registration. 38

39 Configuring Epic Hyperspace Chapter 6 This chapter contains the following topics: Configuring C4E for Third-party Scanner Integration, page 39 Configuring the Program ID in Epic Hyperspace, page 41 Configuring C4E for Third-party Scanner Integration This topic describes the following configurations to be performed in Epic Hyperspace for integration with a third-party scanning product: FDI Record Settings, page 39 LWP Record Settings, page 40 SDF Settings, page 41 EAF/HSD Settings, page 41 FDI Record Settings Attribute MEDIAHANDLER_PROGID SCANACQ_PROGID NEEDS_AUTHENTICATION 0 GENERIC_USERID GENERIC_PASSWORD SCANACQ_INITPARAMS SCANVIEWER_PROGID SCANVIEWER_LIC_KEY IMAGE_PLUGIN_NAME Value EACCMEDIAHANDLER81.ACCUSTOMSCANHANDLER DCTM_EpicIntegration.EpicScan EpicAdmin EpicAdmin NA DCTM_EpicIntegratorViewer.Viewer NA dctmimg 39

40 Configuring Epic Hyperspace Attribute IMAGE_PLUGIN_XML_PP EXTAPP_STRING WEB_ACQ_URL_PROGPT WEB_VIEW_URL_PROGPT WEB_ACQ_PROGID SCANACQ_ADDL_CTX SCANACQ_ADDL_INFO SCANACQ_ADDL_STATIC DEFICIENCY_URL_PROG EPICWEB_MEDIAHANDLER EPICWEB_VIEWERURL EPICWEB_VIEWERURL Value NA NA NA NA NA NA NA NA NA DCTM_EpicIntegration.EpicCareViewer NA NA LWP Record Settings Attribute File Format LWP1 Path Value NA NA LWP2 ProgID of Scan Acquisition Server LWP3 ProgID of Scan Viewer LWP4 Use BlobServer LWP5 Use Scan Acquisition System LWP6 Default workstation settings > Media Handlers > Scan DCTM_EpicIntegration.EpicScan DCTM_EpicIntegratorViewer.Viewer No Yes EACCMEDIAHANDLER81.ACCUSTOMSCANHANDLER 40

41 Configuring Epic Hyperspace SDF Settings Attribute ProgID of Scan Analyst Module SDF1 ProgID of Scan Provider Signature Module Value DCTM_EpicIntegration.ScanAnalysis DCTM_EpicIntegration.ScanSig SDF2 EAF/HSD Settings Attribute Application Path EAF 1 Display Title EAF 2 Payment Posting HSD 1 Denial/Correspondence Follow-up Value NA NA NA NA HSD 2 Configuring the Program ID in Epic Hyperspace You must configure the Program ID of all C4E components in Epic Hyperspace before you can use those components. 1. Log in to Epic Hyperspace. 2. View the Workstation Settings and open a Workstation Profile. 3. To configure the Media Handler settings: a. From the Sections list, select Media Handlers. b. Select the Scans attribute and type the following value: EACCMEDIAHANDLER81.ACCUSTOMSCANHANDLER. 4. To configure the Scan settings: a. From the Sections list, select Scans. b. Select the ProgID of Scan Acquisition Server attribute and type the following value: 41

42 Configuring Epic Hyperspace DCTM_EpicIntegration.EpicScan. c. Select the ProgID of Scan Viewer attribute and type the following value: DCTM_EpicIntegratorViewer.Viewer. 5. To configure the Deficiency Tracking settings: a. From the Sections list, select Deficiency Tracking. b. Select the ProgID of Scan Analyst Module attribute and type the following value: DCTM_EpicIntegration.ScanAnalysis. c. Select the ProgID of Scan Provider Signature Module attribute and type the following value: DCTM_EpicIntegration.ScanSig. 6. Click Accept to accept the changes. 7. Restart Epic Hyperspace. 42

43 Chapter 7 Installing Epic ROI This chapter contains the following topics: Installing the Epic ROI Module, page 43 Configuring the Epic ROI Module, page 44 Installing the Epic ROI Module 1. Extract the c4e-eps-painter-plug-in msi file to a temporary location on your Epic Hyperspace workstation or network drive. 2. Double-click setup.exe. 3. Click Next. 4. Click Browse and select the installation folder for the HIP Epic ROI module. For example, C:\EPIC\sdk\8.1\Epic Print Service\bin\plug-ins\painters Do not use the default installation location. To enable logging and temporary file storage, users need full permission to this folder. 5. For Install Documentum EPS Plug-in for yourself, or anyone who uses this computer, select the option appropriately. Select Just me if you want to restrict access to the current user. Select Everyone to enable access to all users on the local system. 6. Click Next. 7. Click Next to start the installation. 8. Click Close when the installation is completed. 43

44 Installing Epic ROI Configuring the Epic ROI Module 1. Go to the Epic ROI installation directory. 2. Double-click DCTM Epic Print Service Painter Config.exe. 3. Type the configuration details in the following tabs as given in the following steps: DCTM Settings: Contains connection settings for your Documentum repository. General: Contains settings that control the general operation of the HIP Epic ROI module. Epic DOCUID: Defines the syntax that the HIP Epic ROI module uses when creating an Epic Document Unique Identifier (DOCUID). 4. To configure the DCTM Settings: a. Click DCTM Settings. b. Configure the fields as described in the following table: Field DCTM Base URL Description Type the URL of the Documentum web services server. When using Tomcat, you must include the webapp name in the URL. For Tomcat: -dfs/ Click to ensure that the URL is valid. DCTM Default Repository DCTM User Name DCTM password Type the name of the Documentum repository to which C4E is connected. Type the Documentum user name that the HIP Epic ROI module will use to access Documentum. This user account must be exclusive to the Epic EMR Integration solution. Type the password for the Documentum user name. c. Click Save. 5. To configure the General details: a. Click General. b. Configure the fields as described in the following table: 44

45 Installing Epic ROI Field Working Folder Description Click and select the folder where the HIP Epic ROI module keeps the temporary files when Epic requests for documents. The user must have full permissions to this folder. Working Folder Purge Log Output This setting does not accept environment variables. By default, the utility uses the installation location of the HIP Epic ROI module. Type a value to define the duration after which the HIP Epic ROI module will delete temporary files from the working folder. The module deletes temporary files when the files are older than the value specified here. Values are defined in minutes. To disable this feature, set the value to 0. Select the type of information required in the C4E log file. Debug (All): All messages, errors, and warnings are written to the log file. Warnings & Errors: All errors and warnings are written to the log file. Errors Only: Critical errors are written to the log file. Log Location None: Logging is disabled. Select the location of the HIP Epic ROI module log file. Select one of the following values: Default: The installation directory of the HIP Epic ROI module. Application Data: The Windows Application Data folder. Desktop: The Windows Desktop folder. Documents: The Windows Documents folder. Temp: The Windows Temp folder. 45

46 Installing Epic ROI c. Click Save. 6. To configure the Epic DOCUID details: a. Click Epic DOCUID. b. Configure the fields as described in the following table: Field Document ID (DOCUID) Delimiter Document ID (DOCUID) Format Mask Builder Description Displays the delimiter to separate the values in the DOCUID. The value that you specified using Builder appears here. Displays the syntax that C4E uses when it creates the Epic Document Unique Identifier (DOCUID). The format that you define using Builder appears here. Click to define the syntax that C4E uses when it creates a DOCUID. The Document ID (DOCUID) Format Mask Builder dialog box shown in the following figure allows you to define the DOCUID Format. c. To create a Document ID Format of Field/ Formula type using Document ID (DOCUID) Format Mask Builder: i. From the Type options, select Field/Formula. ii. Configure the fields as described in the following table: 46

47 Installing Epic ROI Field Document ID (DOCUID) Delimiter Description Type a delimiter to separate the values in the DOCUID. For example, /. Fields/Formulas You cannot use the characters such as %, [], *, and " as delimiters because they are reserved characters. Contains data fields and variables that you can use to construct the DOCUID syntax. The available fields and formulas are: DCTM_objectId: A variable that supplies the value of the object ID from the Documentum repository. DCTM_Repository: A variable that supplies the name of the default Documentum repository. You defined this name on the Login tab. %DATETIME% : The current date and timestamp in the following format: YYYYMMDDHHMMSSA %DATE%: The current date in the following format: YYYYMMDD %TIME%: The current time in the following format: HHMMSSA iii. From Fields/Formulas, select DCTM_objectId and click to the Display Order list. to add the field/formula Note: DCTM_objectId is mandatory to create a Document ID Format Mask. iv. Select the other required fields/formulas and click Order list. Note: To add a Literal Value to the Document ID Format Mask: a. Select Literal Value from the Type options. to add them to the Display b. Type the value in the Value field and click to add the field/formula to the Display Order list. 47