EMC Documentum Connector for EPIC

Transcription

1 EMC Documentum Connector for EPIC Version 1.6 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 [email protected]

3 Table of Contents Preface... 5 Chapter 1 About C4E... 7 What is C4E?... 7 HIP Epic ROI Module... 7 How does C4E Work?... 7 Functions of C4E... 9 Viewing Documents Stored in Documentum... 9 File Types Supported by Documentum Viewer... 9 Scanning Documents to Documentum... 9 Batch Scanning Documents to Documentum Importing Documents to Documentum Batch Importing Documents to Documentum Publishing ROI Packages Chapter 2 Security Configuration Access Control Settings User Authentication Default Accounts Authentication Configuration User Authorization Component Access Control Log Settings Log Description Communication Security Settings Port Usage Network Encryption Secure Deployment and Usage Settings Secure Deployment Settings Chapter 3 C4E Installation and Configuration Prerequisites Installing C4E Configuring C4E Deploying Object Types Importing Document Types Installing the HIP Epic ROI Module Configuring the HIP Epic ROI Module Configuring Epic Hyperspace Chapter 4 C4E Configuration for Scanning FDI Record Settings

4 Table of Contents LWP Record Settings SDF Settings EAF/HSD Settings Appendix A Sample Configuration Files C4E AppSettings.xml C4E DCTMSettings.xml C4E MimeTypes.xml C4E ScanSettings.xml ROI Module AppSettings.xml ROI Module DCTMSettings.xml XdsRegSettings.xml

5 Preface Purpose This document describes the procedure to install and configure EMC Documentum Connector for EPIC (C4E) and the related modules of C4E. Audience This guide is intended for technical support team who is responsible for installing EMC Documentum C4E. This document assumes that the person who performs installation has technical knowledge and experience in network topologies, Oracle, Documentum, Epic Hyperspace, and storage technologies and is familiar with Microsoft Windows, Linux, and VMware. Revision History Revision Date June 2015 June 2014 Description Updated the description of document levels attribute in the Section Importing Document Types. Initial publication. 5

6 Preface 6

7 Chapter 1 About C4E This chapter contains the following topics: What is C4E?, page 7 How does C4E Work?, page 7 Functions of C4E, page 9 What is C4E? The C4E package enables Healthcare providers using Epic EMR to store and retrieve patient records from a Documentum Repository. The C4E package contains the C4E and the HIP Epic EMR Release of Information (ROI) module. The C4E enables your Epic Hyperspace client application to: Scan and store Healthcare documents in a Documentum repository Upload Healthcare documents to a Documentum repository View Healthcare documents stored in a Documentum repository HIP Epic ROI Module The HIP Epic ROI module enables you to retrieve patient content stored in Documentum and then package and output that content as part of an Epic Release of Information package. The module converts all PDF documents to images before sending the content to the Epic viewer. The module converts each page of a multi-page PDF to a TIFF image. This module supports only PDF and TIFF file formats. How does C4E Work? For all Desktop Scan, View, and Upload scenarios, the action is initiated through the Epic workstation. Epic calls the C4E when scanning, viewing, or uploading. C4E uses DFS Web Services to access the EMC Documentum Repository when sending or retrieving content. 7

8 About C4E The following figure illustrates the C4E workflow: For batch scan and upload scenarios, high-volume scanners scan and upload documents to the EMC Documentum Repository. The XDS Repository Server uses HL7 messages to inform Epic of the new content. The following figure illustrates the batch scanning workflow: 8

9 About C4E Functions of C4E C4E supports the following functions: Viewing Documents Stored in Documentum, page 9 Scanning Documents to Documentum, page 9 Batch Scanning Documents to Documentum, page 10 Importing Documents to Documentum, page 10 Batch Importing Documents to Documentum, page 10 Publishing ROI Packages, page 10 Viewing Documents Stored in Documentum You must open the Media tab under the appropriate patient context and click the document link. The C4E retrieves the document from Documentum, and displays it to you through the integrated Documentum viewer. If the viewer does not support the file type, Windows attempts to open the content with the default application for the file type. File Types Supported by Documentum Viewer TIFF GIF JPG JPEG JPE PDF DOC PNG BMP txt Besides the above mentioned file types, the Documentum Viewer supports other valid file types that you add. Scanning Documents to Documentum You can scan the documents through an Epic Hyperspace client that presents a scanning interface with a Scan button in the Media tab of the interface. From the scanning interface, users can select the 9

10 About C4E document type and click Scan. The C4E ensures that the application saves the scanned document in the Documentum repository. Documentum returns a unique object ID to Epic, enabling Epic to provide a link to the document on the Media tab. Batch Scanning Documents to Documentum You can schedule batch scans through a scan capture server that scan and upload documents to a Documentum repository. The XDS Repository Server generates an HL7 MDM message containing the Documentum unique ID for each document uploaded to Documentum. It sends this message to Epic, enabling Epic to display the document ID with the corresponding patient ID on the media tab. Importing Documents to Documentum You can import documents through the Epic scanning interface. You must define the document type and then select the file to import. The C4E ensures the application saves the document in the Documentum repository. Documentum returns a unique object ID to Epic, enabling Epic to provide a link to the document on the Media tab. Batch Importing Documents to Documentum You can schedule batch upload to a Document repository through a high volume server. The XDS Repository Server generates an HL7 MDM message containing the Documentum unique ID for each document uploaded to Documentum. It sends this message to Epic, enabling Epic to display the document ID with the corresponding patient ID on the media tab. Publishing ROI Packages The HIP Epic ROI module receives a document ID from Epic that corresponds to the object ID of a document in Documentum. The module then retrieves the document and transforms it (if required) from PDF to an image format and sends the resulting image back to the Epic Module. If the HIP Epic ROI module encounters a multiple page PDF file, each page of the PDF file is converted to an TIFF image and sent back to Epic. 10

11 Chapter 2 Security Configuration This chapter provides the security configuration settings required to ensure secure operation of C4E. This chapter contains the following topics: Access Control Settings, page 11 Log Settings, page 12 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. User Authentication The 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 The C4E contains a configuration utility to configure the authentication information. You must specify the repository name, the user name, and the 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 All content created by the C4E is configured with an Access Control List (ACL). The 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 DCTM runtime ACL is generated. Component Access Control You can use the Epic Hyperspace to access C4E. All access to the C4E is controlled by the Epic Hyperspace application administrator. Log Settings The log file generated by the C4E logs information from levels NONE (no logging) to DEBUG (all messages logged) and this is configured in the configuration tool. Log Description The C4E generates the log file in the C4E installation folder. The name of the log file generated is DCTM_EpicIntegratorCommon - <Epic User name>.log. The logs for Media handler viewer is generated in DCTM_EpicIntegratorCommon.log. Communication Security Settings The communication security settings enable the establishment of secure communication channels between the product components as well as between product components and external systems or components. Port Usage Component Service Protocol Port Description C4E Viewer /Scanner NA http 80 NA C4E ROI NA http 80 NA 12

13 Security Configuration Component Service Protocol Port Description C4E Viewer /Scanner NA http 9080 ACS C4E ROI NA http 9080 NA Network Encryption You can use SSL if configured on the web services application server. In the configuration URL you can designate the protocol https in the URL string. Secure Deployment and Usage Settings The following figure illustrates the C4E layers: 13

14 Security Configuration Secure Deployment Settings The security settings for deployment of the web services layer are described in the DFS web services documentation. 14

15 Chapter 3 C4E Installation and Configuration This chapter contains the following topics: Prerequisites, page 15 Installing C4E, page 16 Configuring C4E, page 16 Deploying Object Types, page 29 Importing Document Types, page 31 Installing the HIP Epic ROI Module, page 32 Configuring the HIP Epic ROI Module, page 32 Configuring Epic Hyperspace, page 37 Prerequisites Ensure that the following criteria are met before you start the installation of C4E: Content Server is installed and functioning properly. The following files are downloaded from the EMC Download Center: HIP-DCTM dar HIP-XDS dar The dardeployer.exe file located in the folder C:\Documentum\product\6.7\install\composer\ComposerHeadless is deployed. The HIP dar files contains the data models that are required to perform operations using C4E. Desktop Experience is enabled on Windows Server machines HIP XDS Repository Server is installed and tested. The HL7.properties file is deployed and configured. This is required for batch scanning integration with Epic. Epic Hyperspace Client is installed on all required workstations. Epic Print Server (EPS) is installed and tested. Scanner is attached to your network and functioning properly. 15

16 C4E Installation and Configuration If Citrix is used, the 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 is present in the Prerequisites folder of C4E package. AX Viewer 7.0 present in the Prerequisites folder of C4E package is installed. Microsoft.NET Framework 4.0 redistributable installer is present in the Prerequisites folder of C4E package and HIP Epic ROI module package. Datalogics PDF2Image redistributable installer is present in the Prerequisites folder in the HIP Epic ROI module package. Documentum User Account is created for the use of Epic Integration solution components. Do not share this account with other administrative functions. Documentum Foundation Services (DFS) Web service is functioning properly Installing C4E 1. Uninstall the current version. 2. Delete the config files, the temp files and the temp folders from the installation directory. 3. Run the EMC Documentum Epic Integration.msi file. 4. Click Next. 5. Click Install to start the installation process. The InstallShield wizard successfully completes the installation. 6. Click Finish. Note: If you do not uninstall the current version and remove the config files from the installation directory, you will get an XML error and the config tool will crash when it tries to load one of the previous XML files. Configuring C4E 1. Go to the C4E installation directory. For example, C:\Program Files (x86)\emc\emc Documentum Epic Integration. 2. Double-click DCTM_EpicIntegratorConfig.exe. 3. Type the configuration details in the following four tabs of thedctm Epic Integrator Configuration Utility. Login: Contains basic information about your Documentum repository. Configuring the login details:, page 17 DCTM Server: Contains the Documentum Foundation Services (DFS) URL and the format of the DOCUID. 16

17 C4E Installation and Configuration Configuring the DCTM server details:, page 18 Mime Types: Defines the media types in your repository that C4E can handle. For each Mime Type, you can decide whether the integrated Documentum viewer or another application allows viewing of the file. When the viewer encounters an unsupported media format, the application uses the default Windows viewer for the file type. Configuring the mimetype details:, page 23 Scanning: Contains setting for your scanning operations. Configuring the scanning details:, page Click Save. You must click Save after you type the configuration details in each tab. 5. Click Exit to close the utility. Configuring the login details: 1. Click Login. 2. Type/select appropriate values in the fields, as mentioned 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 the C4E will use 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. Epic must pass this user account to C4E to enable the Admin user interface. 17

18 C4E Installation and Configuration Field Log Output Description Select the type of information required in the C4E log file. 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. 3. Click Save. Configuring the DCTM server details: 1. Click DCTM Server. 2. Type /select appropriate values in the fields as mentioned 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 The server name indicates the hostname of the machine on which the AppServer is installed. Click this button to validate the URL. An error message appears if the URL is not valid. Displays the syntax C4E uses when it creates the Epic Document Unique Identifier (DOCUID). You can create the syntax using Document ID (DOCUID) Format Mask Builder. Click to define the syntax C4E uses when it creates the Epic DOCUID. The Document ID (DOCUID) Format Mask Builder allows you to define the format that C4E will use to generate document identifiers. The following figure shows a sample. 18

19 C4E Installation and Configuration 3. Create a Document ID Format using Document ID (DOCUID) Format Mask Builder as follows: a. Type /select appropriate values in the fields as mentioned in the following table: Field Document ID (DOCUID) Delimiter Description Type a delimiter to separate the values in the DOCUID. For example, /. Fields/Formulas You cannot use characters such as %, [], *, and " as delimiters because they are reserved characters. Contains the following data fields and variables that you can use to construct the DOCUID syntax. 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 format: YYYYMMDDHHMMSSA %DATE% The current date in the format: YYYYMMDD %TIME% The current time in the format: HHMMSSA 19

20 C4E Installation and Configuration b. From Fields/Formulas, select DCTM_objectId and click to add the field/formula to the Display Order list. Note: DCTM_objectId is mandatory to create a Document ID Format Mask. c. Select the 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) if you want to view the scanned documents in the PDF format. During the view operation, C4E shows the documents in the PDF format 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. The procedure Configuring the mimetype details:, page 23 provides more details on Mime Type settings. 5. Select View the CURRENT version of a document if you want to view the latest version of a document. 6. Select XDS Registry Enabled if you want to register the documents in XDS Registry. This option is enabled by default. Note: All fields under the XDS Registration Settings are mandatory. An invalid entry in any of the fields leads to error in registering the documents. You must ensure that the DFS you are using contains the commons-codec-1.6.jar file, to use the XDS Registry settings feature. To successfully import or scan a document, you must either: Disable the XDS Registry Enabled option. or Correctly set the values for all attributes in XDS Registry. Perform the following steps for setting the attribute values to be stored in the XDS Registry: a. Contact the Server Administrator who set up the server for HIP. b. Get the values for all the attributes (Class, Practise Setting, Format, Type, Healthcare Facility, Submission Type, Assigning Authority and Language Code). 20

21 C4E Installation and Configuration The values for Class, Practise Setting, Format, Type, Healthcare Facility, Submission Type must be exactly as specified in the dmh_code table. c. Click Set Attributes. d. Type the values received from the Server Administrator in the respective fields. The following table describes the attributes that you must set for XDS Registry: Field Class Code Description The code specifying the type of document. For example, Schema History and Physical The coding scheme for Class code. For example, Practise Setting Code sampleclasscodes The code specifying the clinical specialty where the document was generated. For example, Schema Outpatient The coding scheme for Practise Setting. For example, Format Code practicesettingcodes The code used globally to uniquely specify the format of the document. Format code, along with Type code is sufficient to allow potential consumer to know if it will be able to process the document. For example, Schema Dialysis The coding scheme for Format code. For example, sampleformatcodes 21

22 C4E Installation and Configuration Field Type Code Description The code specifying the precise type of document (e.g., Pulmonary History and Physical, Discharge Summary, Ultrasound Report). For example, Schema CDAR2/IHE 1.0 The coding scheme for Type code. For example, Healthcare Facility Code healthcarefacilitytypecode The code representing the type of organizational setting of the clinical encounter during which the documented act occurred. For example, Schema T-D4909 The coding scheme for Healthcare Facility code. For example, Submission Type Code SNM3 The code representing the type of submission. For example, Schema TEXT The coding scheme for Submission Type code. For example, LOINC 22

23 C4E Installation and Configuration Field Assigning Authority Description Represents a participant who has legally authenticated or attested the document within the author Institution. For example, Language Code Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator. Specifies the human language of character data in the document. The values of this attribute are language identifiers as described by the IETF (Internet Engineering Task Force) RFC For example, en-us XdsRegSettings.xml, page 46 shows a sample XdsRegSettings.xml file. e. Click Save. When you click Save, a validation of the attributes (Class, Practise Setting, Format, Type, Healthcare Facility, Submission Type) is performed against the values specified in the dmh_code table. If the values mentioned in the attribute fields exactly match with the values specified in the dmh_code table, save will be successful. Otherwise you get an error message. The validation for Assigning Authority and Language Code does not happen when you click Save, however, these values are validated when the document is registered. If the registration fails, the errors will be captured in the registry log files. The import/scan operation will be successful only if it meets the following criteria: The validation of attribute values (Class, Practise Setting, Format, Type, Healthcare Facility, Submission Type) against the values mentioned in dmh_code table is successful. The registration of the document will be successful only if it meets both the following criteria: The validation of attribute values (Class, Practise Setting, Format, Type, Healthcare Facility, Submission Type) against the values mentioned in dmh_code table is successful. The validation of attribute values Assigning Authority and Language Code during document registration is successful. Therefore, you must ensure that the values for all the fields in the XDS Registry Settings are accurate for a successful import/scan operation and subsequent registration. 7. Click Save. Configuring the mimetype details: 1. Click Mime Types. 23

24 C4E Installation and Configuration 2. Type /select appropriate values in the fields, as mentioned in the following table: Field Mime Type Description Type the Mime Type. Extension Type the file extension of the Mime type. DCTM Format Name Viewer Support Type the Documentum format name of the Mime. If you want 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. 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 You must select this option to view the JPEG files rendered in PDF. Select the TIFF Support option to enable C4E to convert images to 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 the 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 it is not enabled for TIFF Support, 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/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. 24

25 C4E Installation and Configuration The following figure shows a sample of the configuration information: 3. Click. 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 the 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 utility shows an error message if you attempt to create a Mime type with the 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. 5. To edit a Mime Type: a. Select the Mime Type to be edited from the list. b. Edit the required fields. 25

26 C4E Installation and Configuration c. Click. A message Are you sure you wish to edit the selected Mime Type appears. d. Click Yes. 6. Click Save. Configuring the scanning details: 1. Click Scanning. 2. Type /select appropriate values in the fields, as mentioned in the following table: Field Default Paper Size Description Select the default page size for scanned images. By default, the page size is US Legal. You can change this setting during scanning. The available values are: A4 A5 A6 A7 ISO B5 ISO B6 Business Card US Letter Default Mode US Legal Select the default scanning mode. The available values are: Bitonal (B/W) Greyscale (256 color) Color (24-bit) 26

27 C4E Installation and Configuration Field Default DPI Description Select the default Dots Per Inch (DPI) setting for scanning. The available values are: RootCabinet 600 Type the Documentum cabinet where the C4E stores all the scanned and imported content. The cabinet name must be preceded by a /. GroupContextName ACL Name Max. Import Size (MB) Working Folder The cabinet must already exist in the Documentum. Type the Epic context parameter name. C4E groups the documents based on this context parameter name. Type the Access Control List (ACL) name that C4E will apply to the scanned and imported documents. This name must already exist in Documentum. 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. Click and select the folder where C4E stores the scanned documents or the documents selected for viewing. You must have full control permissions to this folder. Also, ensure that the working folder path ends with a \. This setting does not accept environment variables. By default, the utility uses the C4E installation location. The working folder is accessible by both Epic Hyperspace and Workstation machines, even if they are on different machines. 27

28 C4E Installation and Configuration Field 3rd party application always on top On top Timeout (sec) Description Select this option if you want the 3rd 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 value taken by the 3rd party application for loading the window. The value is in seconds. The default value is 10 seconds. Note: The size of the documents that can be scanned 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. During a scan/import operation, if you have enabled the XDS Registry option, a validation is performed to ensure that the mandatory attributes for XDS Registry have been set. If the mandatory attributes are present, and if the values of the mandatory attributes are set correctly, the import will be successful, otherwise the import will fail. If the import is successful, the document gets stored in the Documentum server. When the imported document is added to the Documentum, a folder dmh_patient_folder is created and the name of the patient is stored in the folder with the patient_name attribute. A time configurable poller then sends this entry to the Registry (only if XDS Registry is enabled) and validates the values of Registry attributes required for successful document registration. If the values of Registry attributes are incorrect, the registration fails and the error is logged in the XDS Registry logs. If the validation is successful, the document gets registered in the XDS Registry. Registering the document in XDS Registry is a configurable option that is enabled by default. When adding a document to the repository, the Connector stores the following meta-data 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 to confirm if the scanned/imported document must be uploaded to the repository. When the documents are processed, the scanning interface shows a message indicating if the operation was a success or a failure. If the scan/import operation is performed on a tiff file, the status of the c4e _scan or c4e_import input flag depends on the operation (scan/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. Chapter 4, C4E Configuration for Scanning provides more details on C4E configuration for integration with a third-party scanning product. 28

29 C4E Installation and Configuration The configuration settings in each tab in the configuration utility are saved to the following XML files: AppSettings.xml Stores the settings you defined in the Login tab. The schema for this file is: <installation_dir>/appsettingsschema.xsd MimeTypes.xml 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 MimeType node. The schema for this file is: <installation_dir>/mimetypeschema.xsd DCTMSettings.xml Stores the settings you defined in the DCTM Server tab. The schema for this file is: <installation_dir>/dctmsettingsschema.xsd ScanSettings.xml Stores the settings you defined in the Scanning tab. The schema for this file is: <installation_dir>/scansettingsschema.xsd XdsRegSettings.xml Stores the settings you defined in the Set Attributes dialog box on the DCTM Server tab. You can copy and deploy these files to other locations that require the same settings. The chapter Appendix A, Sample Configuration Files provides a sample of these files. Deploying Object Types C4E requires the HIP dar files to be deployed before you can perform any operation such as import, scan, and so on. The following dar files contains the data models that are required to complete the operations: HIP-DCTM dar stores the HIP Healthcare Information Model object types HIP-XDS dar stores the HIP XDS object types Deploy both the DAR files using either the Composer D7 DAR Installer (dardeployer.exe) or Documentum Headless Composer. Deploying HIP dar files using dar deployer: 1. Double-click dardeployer.exe located at <DCTM_install_dir>\product\7.1\install \composer\composerheadless\ 29

30 C4E Installation and Configuration 2. Define the following settings in the DAR Details and Docbroker Details sections: DAR Browse and select the DAR file. Docbroker Host Select your Docbroker host. Docbroker Port Define the port number for your Docbroker host. Click Connect. 30

31 C4E Installation and Configuration 3. Define the following settings in the Repository Details section: Repository Select your Documentum Repository from the list. User Name Supply the Documentum Content Server User Name. Password Supply the password for the Documentum Content Server user name. Click Install. The DAR Installer informs you when the DAR files are successfully installed. Deploy both the dar files as mentioned above. Importing Document Types To import your document types to the Documentum Server, use the DocTypes Import Utility and import a configuration file that describes your document types. Your configuration file should describe your document types in the following format: <document_type>,<description>,<document_levels>,<enabled> document type: The document type value to be imported. For example, ABR. description: A description of the document type value. For example, ABR REPORT document levels: The applicable document level for the document type. 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. The document type value must be unique and can have only one value for the document level. If a document type is available at multiple levels, the document type value must be different for each level. enabled: Defines 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. Sample document type descriptions: ABR,ABR REPORT,P,1 AMBR,AMBULANCE RECORD,P,1 To import your document types: 1. Go to the C4E installation directory. For example, C:\Epic\EMC\EMC Documentum Epic Integration. 2. Double-click DctmConnectorDocTypeImportApp.exe. 3. Type/select appropriate values in the fields as mentioned in the following table: Field Server Url Repository Description Type the URL of the Documentum Web Services Server. This is the same URL you provided for DCTM Base URL in Configuring C4E, page 16. Type the name of the primary Documentum Repository. This is the same repository name you provided for Default DCTM Repository Name in Configuring C4E, page

32 C4E Installation and Configuration Field UserName Password Select file Description Type the Documentum user name that the utility will use to log in to Documentum. Type the password for the Documentum user name. Click and select the configuration file that contains your document types. 4. Click Import. Installing the HIP Epic ROI Module 1. Extract the DCTM_EPS_Painter_Plug-in.zip 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 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 Control permission for 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 else select Everyone to enable access to all users on the local system. 6. Click Next. 7. Click Next to start the installation. You can click Back if you want to review your settings. 8. Click Close when the installation is completed. Configuring the HIP Epic ROI Module 1. Go to the HIP 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 the Epic Document Unique Identifier (DOCUID). 4. Configuring the DCTM Settings. 32

33 C4E Installation and Configuration a. Click the DCTM Settings tab. b. Type /select appropriate values in the fields, as mentioned 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/ For JBoss: /services 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. Configuring the General details. a. Click the General tab. b. Type /select appropriate values in the fields as mentioned in the following table: Field Working Folder Description Click and select the folder where the HIP Epic ROI module places the temporary files when Epic requests documents. The user must have full control permissions to this folder. This setting will not accept environment variables. By default, the utility uses the installation location of the HIP Epic ROI module. 33

34 C4E Installation and Configuration Field Working Folder Purge Log Output Description 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. 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. 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. c. Click Save. 6. Configuring the Epic DOCUID details. a. Click the Epic DOCUID tab. b. Type /select appropriate values in the fields as mentioned in the following table: 34

35 C4E Installation and Configuration 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 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 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. Type /select appropriate values in the fields, as mentioned in the following table: 35

36 C4E Installation and Configuration 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 the Display Order list. Note: To add a Literal Value to the Document ID Format Mask: a. Select Literal Value from the Type options. to add the field/formula to b. Type the value in the Value field and click to add the field/formula to the Display Order list. 36

37 C4E Installation and Configuration If you want to delete a Field/Formula from the Display Order list, select the Field/Formula you want to delete and click. v. Click OK. d. Click Save. 7. Click Exit to close the utility. The configuration settings in each tab in the configuration utility are saved to the following XML files in the HIP Epic ROI installation directory: AppSettings.xml This file stores the settings you defined on the General tab. The schema for this file is: <installation_dir>/appsettingsschema.xsd DCTMSettings.xml This file stores the settings you defined on the DCTM Settings tab. The schema for this file is: <installation_dir>/dctmsettingsschema.xsd You can copy and deploy these files to other location that require the same settings. The chapter Appendix A, Sample Configuration Files provides a sample of these files. Configuring Epic Hyperspace You must configure Epic Hyperspace to use the C4E components. 1. Log in to Epic Hyperspace. 2. View the Workstation Settings and open a Workstation Profile. 3. In the Sections list, select Media Handlers. 4. Select the Scan attribute and type the following value: DCTM_EpicIntegratorViewer.Viewer. 5. From the sections list, select Scans. 6. Select the ProgID of Scan Acquisition Server attribute and type the following value: DCTM_EpicIntegration.EpicScan. 7. Select the ProgID of Scan Viewer attribute and type the following value: DCTM _EpicIntegratorViewer.Viewer. 8. Accept the changes and restart Epic Hyperspace. 37

38 C4E Installation and Configuration 38

39 C4E Configuration for Scanning Chapter 4 This chapter describes the specific C4E configuration settings to be built in Epic for integration with a third-party scanning product. This chapter contains the following topics: FDI Record Settings, page 39 LWP Record Settings, page 40 SDF Settings, page 40 EAF/HSD Settings, page 40 FDI Record Settings Attribute MEDIAHANDLER_PROGID FDI1 SCANACQ_PROGID FDI2 NEEDS_AUTHENTICATION FDI3 GENERIC_USERID FDI4 GENERIC_PASSWORD FDI5 SCANACQ_INITPARAMS FDI6 SCANVIEWER_PROGID FDI7 SCANVIEWER_LIC_KEY FDI8 WEB_ACQ_URL_PROGPT FDI9 WEB_VIEW_URL_PROGPT FDI10 WEB_ACQ_PROGID FDI11 Value DCTM_EpicIntegratorViewer.Viewer DCTM_EpicIntegration.EpicScan No Set this to match the Admin User ID setting to allow you to view the admin UI while viewing a document. Any value NA NA NA NA NA NA 39

40 C4E Configuration for Scanning LWP Record Settings Attribute File Format LWP1 Path LWP2 ProgID of Scan Acquisition Server LWP3 ProgID of Scan Viewer LWP4 Use BlobServer LWP5 Use Scan Acquisition System Value NA NA DCTM_EpicIntegration.EpicScan DCTM_EpicIntegratorViewer.Viewer No Yes LWP6 SDF Settings Attribute ProgID of Scan Analyst Module SDF1 ProgID of Scan Provider Signature Module Value NA NA SDF2 EAF/HSD Settings Attribute Application Path EAF 1 Display Title Value NA NA EAF 2 40

41 C4E Configuration for Scanning Attribute Payment Posting HSD 1 Denial/Correspondence Follow-up Value NA NA HSD 2 41

42 C4E Configuration for Scanning 42

43 Appendix A Sample Configuration Files This appendix contains the following sample files associated with C4E: C4E AppSettings.xml, page 43 C4E DCTMSettings.xml, page 43 C4E MimeTypes.xml, page 44 C4E ScanSettings.xml, page 45 ROI Module AppSettings.xml, page 45 ROI Module DCTMSettings.xml, page 45 XdsRegSettings.xml, page 46 C4E AppSettings.xml <?xml version="1.0" standalone="yes"?> <AppSettingsSchema xmlns=" <Global> <DefaultRepository>Healthcare</DefaultRepository> <UserName>njkA2n+hLHAGo8A7u1pBJA==</UserName> <Password>SH9N2tOaKencWkYkdC9iBA==</Password> <Logging>2</Logging> </Global> </AppSettingsSchema> C4E DCTMSettings.xml <?xml version="1.0" standalone="yes"?> <DCTMSettingsSchema xmlns=" <DCTM> <DCTMBase_URL> <DOCUIDMask>[DCTM_Repository]/[DCTM_objectId]/%DATETIME%</DOCUIDMask> <DOCUIDDelimiter>/</DOCUIDDelimiter> </DCTM> </DCTMSettingsSchema> 43

44 Sample Configuration Files C4E MimeTypes.xml <?xml version="1.0" standalone="yes"?> <MimeTypeSchema xmlns=" <MimeType> <Type>application/msword</Type> <Extension>doc</Extension> <ViewerSupport>true</ViewerSupport> <TiffSupport>false</TiffSupport> <DCTMFormatName>doc</DCTMFormatName> </MimeType> <MimeType> <Type>application/pdf</Type> <Extension>pdf</Extension> <ViewerSupport>true</ViewerSupport> <TiffSupport>false</TiffSupport> <DCTMFormatName>pdf</DCTMFormatName> </MimeType> <MimeType> <Type>image/jpeg</Type> <Extension>jpg</Extension> <ViewerSupport>true</ViewerSupport> <TiffSupport>true</TiffSupport> <DCTMFormatName>jpeg</DCTMFormatName> </MimeType> <MimeType> <Type>image/jpeg</Type> <Extension>jpeg</Extension> <ViewerSupport>true</ViewerSupport> <TiffSupport>true</TiffSupport> <DCTMFormatName>jpeg</DCTMFormatName> </MimeType> <MimeType> <Type>image/jpeg</Type> <Extension>jpe</Extension> <ViewerSupport>true</ViewerSupport> <TiffSupport>true</TiffSupport> <DCTMFormatName>jpeg</DCTMFormatName> </MimeType> <MimeType> <Type>image/tiff</Type> <Extension>tiff</Extension> <ViewerSupport>true</ViewerSupport> <TiffSupport>true</TiffSupport> <DCTMFormatName>tiff</DCTMFormatName> </MimeType> <MimeType> <Type>image/tiff</Type> <Extension>tif</Extension> <ViewerSupport>true</ViewerSupport> <TiffSupport>true</TiffSupport> <DCTMFormatName>tiff</DCTMFormatName> </MimeType> <MimeType> <Type>text/plain</Type> <Extension>txt</Extension> <ViewerSupport>true</ViewerSupport> <TiffSupport>false</TiffSupport> <DCTMFormatName>text</DCTMFormatName> </MimeType> <MimeType> <Type>video/avi</Type> <Extension>avi</Extension> 44

45 Sample Configuration Files <ViewerSupport>false</ViewerSupport> <TiffSupport>false</TiffSupport> <DCTMFormatName>avi</DCTMFormatName> </MimeType> </MimeTypeSchema> C4E ScanSettings.xml <?xml version="1.0" standalone="yes"?> <ScanSettingsSchema xmlns=" <ScanSettings> <PaperSizeIndex>1</PaperSizeIndex> <DPI>200</DPI> <ModeIndex>0</ModeIndex> <WorkingFolder>C:\Program Files (x86)\emc\documentum Epic Integrator\Temp </WorkingFolder> <ACLName /> <GroupContextName /> <RootCabinet /> </ScanSettings> </ScanSettingsSchema> ROI Module AppSettings.xml <?xml version="1.0" standalone="yes"?> <AppSettingsSchema xmlns=" <Global> <WorkingFolder>C:\Program Files (x86)\emc\documentum EPS Painter Plug-in\ </WorkingFolder> <PurgeFolder>5</PurgeFolder> <Logging>2</Logging> <LogFolder>Default</LogFolder> </Global> </AppSettingsSchema> ROI Module DCTMSettings.xml <?xml version="1.0" standalone="yes"?> <DCTMSettingsSchema xmlns=" <DCTM> <DCTMBase_URL> <DefautlDCTMRepository>Healthcare</DefautlDCTMRepository> <UserName>njkA2n+hLHAGo8A7u1pBJA==</UserName> <Password>SH9N2tOaKencWkYkdC9iBA==</Password> <DOCUIDMask>[DCTM_Repository]/[DCTM_objectId]/%DATETIME%</DOCUIDMask> <DOCUIDDelimiter>/</DOCUIDDelimiter> </DCTM> </DCTMSettingsSchema> 45

46 Sample Configuration Files XdsRegSettings.xml <?xml version="1.0" standalone="yes"?> <XdsRegSettingsSchema xmlns=" <XdsRegSettings> <ClassCode>History and PhysicalClassCode>History and Physical</ClassCode> <ClassSchema>sampleClassCodes</ClassSchema> <FormatCode>Dialysis</FormatCode> <FormatSchema>sampleFormatCodes</FormatSchema> <HcFacilityCode>T-D4909</HcFacilityCode> <HcFacilitySchema>SNM3</HcFacilitySchema> <PractiseSettingCode>Outpatient</PractiseSettingCode> <PractiseSettingSchema>practiceSettingCodes</PractiseSettingSchema>practiceSettingCodes> <TypeCode>CDAR2/IHE 1.0</TypeCode> <TypeCodeSchema>healthcareFacilityTypeCode</TypeCodeSchema> <SubmissionTypeCode>TEXT</SubmissionTypeCode> <SubmissionTypeSchema>LOINC</SubmissionTypeSchema> <AssigningAuthority> </AssigningAuthority> <LanguageCode>en-us</LanguageCode> </XdsRegSettings> </XdsRegSettingsSchema> 46

47 Index A access control settings, 11 ACL name, 26 assigning authority code and schema, 21 authentication configuration, 11 B batch importing documents with C4E, 10 batch scanning documents with C4E, 10 C C4E installation configuration, 15 C4E scanning configuration, 39 class code and schema, 21 communication security settings port usage, 12 configuring C4E, 16 configuring DCTM server details DCTM base URL, 18 configuring Epic Hyperspace, 37 configuring HIP Epic ROI module, 32 configuring login details, 17 configuring mimetype details mime type, 23 configuring scanning details root cabinet, 26 Connector for Epic functions of Epic, 7 D DCTM base URL DCTM default repository, 33 DCTM format name, 23 DCTM user name DCTM password, 33 deploying object types, 29 DOCUID delimiter, 36 E EAF/HSD record settings, 40 Epic ROI module, 7 F FDI record settings, 39 format, 21 functions of C4E, 9 H Healthcare Facility, 21 I importing document types, 31 importing documents with C4E, 10 installing C4E, 16 installing HIP Epic ROI module, 32 L language code and schema, 21 log description, 12 log output log location, 33 log settings, 12 LWP record settings, 40 O on top timeout (sec), 26 P practise setting code and schema, 21 prerequisites for C4E installation, 15 Program ID of scan acquisition server, 37 Program ID of scan viewer, 37 publishing ROI packages, 10 47

48 Index S sample configuration files, 43 scanning documents with C4E, 9 SDF record settings, 40 secure deployment and usage settings C4E layers, 13 security configuration, 11 submission type code and schema, 21 T TIFF Support, 23 Type, 21 user authorization, 12 V viewer support, 23 viewing documents with C4E file types supported by C4E, 9 W working folder working folder purge, 33 working of C4E, 7 U user authentication, 11 48