CPWS DICOM Interface Installation Guide

Transcription

1 DIR Rev B Revision Date: 2015/10

2 The DICOM Interface for CardioPerfect Workstation provides the user with the ability to send a request for orders from a modality work list server and also the ability to send Resting ECG tests generated in CardioPerfect Workstation to a DICOM image server. Components The solution contains the following components each with their own installation package: DICOM Result Collector OrderList Client OrderList Server The DICOM Result Collector is the portion of the CPWS-DICOM solution that transmits new ECG tests created in CPWS to a DICOM image server. This piece of software is an extension of the Welch Allyn CardioPerfect Services windows service and must be installed on the same machine as the CPWS application. For detailed information on the implementation of the DICOM standard for CPWS refer to the DICOM Conformance Statement (Ref #2). The OrderList Client component of the CPWS-DICOM solution must be installed on the same machine as any CardioPerfect Workstation client that wishes to search for orders from a DICOM modality worklist server. This add-on creates an icon in CardioPerfect that allows the user to search for, display and select orders in CPWS. The OrderList Server component runs as windows service and is a stand-alone component of the CPWS-DICOM solution. It responds to requests from the OrderList Client to search for orders in a DICOM modality worklist server. It then sends a list of orders back to the OrderList Client which are then displayed in CPWS to the user. The sections following in this document outline instructions for the DICOM Result Collector portion of the solution. For instructions on how to install the OrderList Client and OrderList Server components of the solution refer to the OrderList Plug-in Installation routine (Ref #1). References Rev B OrderList Plug-in Installation and Admin Tool Guide Rev A DICOM Conformance Statement DIR Rev B 2 of 7

3 DICOM Result Collector Installation The DICOM Result Collector software is a plugin to the Welch Allyn CardioPerfect Services (CPSAPI) framework to allow ECG tests generated in CPWS to be converted into DICOM-ECG format and sent to a DICOM image server. The following sections outline instructions. Prerequisites 1. CPSAPI (the Cardio Perfect Services Windows service) is installed. 2. The user performing has the necessary Windows privileges to install software. Installation Steps 1. Unzip file to a temporary folder on the computer. 2. Double click the DICOM Result Collector installation program (DICOMResultCollector.exe) that is available in the temporary folder. Click Next to continue. 3. Click Next to continue. 4. On the License Agreement dialog read the terms of the license agreement and select Next to continue. 5. The Destination Location dialog appears, it is recommended to accept the default location. To change the install location, select Browse. Click Next to continue. 6. The following settings screen will then be displayed. Fill in the requested DICOM Result Collector Settings. DIR Rev B 3 of 7

4 7. The software is now being installed. When the software installation is complete, press Finish. Uninstall the DICOM Result Collector To uninstall the software, perform the following steps: 1. Navigate to Programs & Features. 2. Select Welch Allyn DICOM Result Collector. 3. Select to uninstall the application. DIR Rev B 4 of 7

5 Configuration To configure the CPSAPI DICOM Result Collector plugin after installation: - Stop the CardioPerfect Services windows service. - Navigate to the CPSAPI working directory (this is typically %Program Files%\Welch Allyn\CPSAPI) on the server that is hosting the CPSAPI application. - In a text editor, search for the line similar to the following: <ResultSender name="dicom Result Sender" enabled="1" standalone="1" type="dicomresultsender.dicomcollector,cpws.dicomresultsender" destinationfolder="c:\program Files (x86)\welch Allyn\CPSAPI\DICOM" ImageServer=" " PortNumber="1234" InstitutionName="Name" RemoteAETitle="Title" WorklistServer=" " WorklistPortNumber="1234" WorkListAETitle="Name" Timeout="30"/> - This line contains all the possible configurable values for the DICOM Result Collector. The following table describes each one: Value Name Default Value Description Name DICOM Collector Name of the CPSAPI plugin. Fixed Enabled 1 Switches the CPSAPI plugin on or off: 1=on, 0=off Type Destinationfolder ImageServer [Image Server IP Address] PortNumber [Image Server Port Number] InstitutionName [Institution Name] RemoteAETitle [Image Server AE Title] WorklistServer [Worklist Server IP Address] WorklistPortNumber [Worklist Server Port Number] WorklistAETitle [Worklist Server AE Title] Timeout DICOMResultSender.DICOM Collector,CPWS.DICOMResul tsender <<CPSAPI Install folder>>\dicom Internal CPSAPI value. Do not change this value. Temporary path used during conversion process IP address of DICOM image server to which the DICOM information is sent. Port number of the DICOM image server to which the DICOM information is sent. DICOM Institution name for the site. DICOM specific name of the application the DICOM data is sent to. IP address of the DICOM worklist server. Port number of the DICOM worklist server DICOM specific name of the worklist server Configurable value in seconds of how long to wait before sending DICOM transformed data to the image server - If changes are made to the configuration file, save the file and restart the Cardio Perfect Services windows service in order for the changes to take effect. DIR Rev B 5 of 7

6 Troubleshooting In the event that your CPWS-DICOM solution is not behaving in the manner you expect the following outlines a troubleshooting guide in order to check that all the components of the CPWS-DICOM solution are installed and running correctly. Verify that the DICOM Result Collector is running: 1. Go to the PC that is running the Welch Allyn CardioPerfect Services (CPSAPI) component 2. Open the windows Services window. 3. From the list of services locate the CardioPerfect Services service and verify that it is running. 4. If the service is not running restart it as the DICOM Result Collector software needs CPSAPI to be running. 5. If you are have difficulty starting the CPSAPI service or the solution continues to fail to perform view the CPSAPI log file located at the following location %Program Files%\Welch Allyn\CPSAPI\CPSAPI\CPWS.Services.log. Scroll to the bottom of the log to see the latest messages any errors produced by the DICOM Result Collector will be logged here. Verify that the OrderList Client is installed and running: 1. Go to the PC that is running the CardioPerfect Workstation client you are having difficulty with. 2. Open CardioPerfect Workstation. 3. On the left hand view of the main CardioPerfect Workstation application a tab is present labelled OrderList. 4. Select the OrderList tab a Refresh button is displayed in the OrderList tab view. 5. If either the OrderList tab is not present or the Refresh button is not displayed upon selecting the OrderList tab, the software has not installed correctly. At his point re-install the software. 6. If the OrderList tab is present but no orders are coming back as expected go to the following location (%Program Files%\Welch Allyn\OrderList Client\OrderListConfig.xml and check that the settings for the OrderList Client are correct. Verify that the OrderList Server is installed and running: 1. Go to the PC that is running the OrderList Server application. 2. Open the windows Services window. 3. From the list of services locate the CPWS.OrderList service and verify that it is running. 4. If the service is not running restart it. 5. If you have difficulty starting the CPWS.OrderList service, the software has not installed correctly. At his point re-install the software. 6. If the OrderList service is started but no orders are being displayed in the OrderList Client then go to the following location in the registry HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OrderList Plug-in\DICOM Worklist and check that the settings for the OrderList Server are correct In the event that all of the above components appear to be running but you are still unable to get the CPWS-DICOM solution functioning as you expect please contact Welch Allyn Technical support for further help. DIR Rev B 6 of 7

7 SOFTWARE LICENSE and WARRANTY SOFTWARE LICENSE AGREEMENT This is a legal agreement between you (either an individual or an entity) and Welch Allyn, Inc. By installing the enclosed software, you are agreeing to be bound by the terms of this Agreement. If you do not agree to the terms of this Agreement, promptly return the software and the accompanying items (if applicable) to the place you obtained them for a full refund. If you need to return the software, you must prepay shipping and either insure the package or assume all risk of loss or damage in transit. COPYRIGHT The SOFTWARE is owned by Welch Allyn or its suppliers and is protected by United States copyright laws and international treaty provisions. Therefore, you must treat the SOFTWARE like any other copyrighted material (e.g., a book or musical recording). You may not use or copy the SOFTWARE or any accompanying written materials for any purposes other than what is described in this Agreement. LIMITED WARRANTY Welch Allyn expressly disclaims any warranty for the SOFTWARE. The SOFTWARE and any related documentation is provided "as is" without warranty of any kind, either express or implied, including, without limitation, the implied warranties or merchantability or fitness for a particular purpose. The entire risk arising out of use or performance of the SOFTWARE remains with you. NO LIABILITY FOR CONSEQUENTIAL DAMAGES. In no event shall Welch Allyn or its suppliers be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruptions, loss of business information, or any other pecuniary loss) arising out of the use or inability to use this Welch Allyn product. Contact Details Welch Allyn, Inc State Street Road, PO Box 220 Skaneateles Falls, NY USA Please see for Welch Allyn Technical Support contact information for your location. DIR Rev B 7 of 7