Acuo Workflow Services

Transcription

1 Acuo Workflow Services Product Guide Version: Written by: Product Knowledge, R&D Date: February 2016

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

3 Table of Contents Acuo Workflow Services - Overview... 4 Acuo Workflow Services - Install and Configuration... 4 Install Acuo Workflow Services... 4 Configure Acuo Workflow Services... 5 Configure Microsoft Distributed Transaction Coordinator... 6 Configure Route Destinations... 6 Automated Configuration... 6 Stored procedure - Install... 7 Stored procedure - Uninstall... 8 Create TagMapper directory... 8 Patient Management REST Web Service... 8 Delete Patient... 8 Delete Study... 9 Delete Study from All Databases... 9 Delete Series... 9 Delete Series from All Databases Delete Image Delete Image from All Databases Batch Move Web Services BatchMoveStudy MoveStudyCancel GetMoveStudyStatus WakeUp SetNews Batch move WSDL access TagMapper Web Service MoveStudy MoveStudyCancel GetMoveStudyStatus Processsing Overview Replace MatchAndReplace TagMapper WSDL access

4 Acuo Workflow Services - Overview Acuo Workflow Service enables web service driven, enterprise level orchestration and offers alternative access to Acuo s Universal Clinical Platform (UCP) functionality, UCP3. This includes real time DICOM federation across disparate systems as well as inbound and outbound metadata morphing. The system is designed to match a facility's unique workflow without custom software engineering efforts. All web services and REST endpoints are self hosted (no IIS requirement) and are configurable through the app.config configuration mechanism. Acuo Workflow Services is comprised of the following web services. Patient Management REST Service: Web Service controlled delete operations at all DICOM levels. Batch Move Web Service: Web Service controlled DICOM C Move. Tag Mapper Web Service: Web Service driven tag morphing. Web Service controlled federated DICOM C Find (part of AcuoAccess). OData access to Workflow Services status tables, BatchQueues tables, HisRis database tables Acuo Workflow Services - Install and Configuration Install Acuo Workflow Services To install Acuo Workflow Services, complete the following steps. 1. In the <Acuo Workflow Services>\DiskImages\DISK1 folder, right-click Setup.exe and select Run as Administrator. 2. Click Next to continue the InstallShield Wizard. 3. Accept the license agreement. 4. Click Next. 5. In the Service Logon Information dialog box, enter the username and password. 6. Click Next. 7. In the SQL Server Connection dialog box, select a database server from the drop-down menu and select an authentication method. 8. Click Next. 9. In the Database Installation dialog box, use the default settings for the SQL database file and log file. 10. Click Next. 11. In the Setup Type dialog box, choose a setup type. 4

5 12. Click Next. 13. Click Install to begin the installation. 14. Click Finish to close the InstallSheild Wizard. Configure Acuo Workflow Services To configure Acuo Workflow Services, complete the following steps. 1. Complete one of the following substeps. 1. Give the Acuo Workflow Services service user administrator rights. 2. Reserve the HTTP namespaces by running the following command. Note HOSTNAME should be entered explicitly as an IP or an actual host name (do not use localhost ). netsh http add urlacl url= user=hostname\acuoserviceuser netsh http add urlacl url= user=hostname\acuoserviceuser netsh http add urlacl url= user=hostname\acuoserviceuser netsh http add urlac url= user=hostname\acuoserviceuser netsh http add urlac url= user=hostname\acuoserviceuser 2. To configure the Acuo Web Service XML file, complete the following substeps. 1. Locate the AcuoWebServicesService.exe.xml file in the following directory. Program Files (x86)\acuo Technologies\Workflow Services 2. Update the file using the following configurations. Edit baseaddress= Edit baseaddress= Edit connectionstring, Data Source=HOSTNAME\SQLinstance; Edit connectionstring, Data Source=HOSTNAME\SQLInstance; Edit Key, <add key="acuomedservername" value="hostname" /> 3. Start the Acuo Workflow Services service. 3. To configure the Acuo Patient Management REST Service XML file, complete the following substeps. 1. Locate the AcuoPatientManagement.exe.xml file in the following directory. Program Files (x86)\acuo Technologies\Workflow Services 2. Update the file using the following configurations. Edit connectionstring, Data Source=HOSTNAME\SQLInstance; 3. If not present, add the following configurations to the file: <appsettings> <add key="pmrestaddress" value=" /> <add key="remrestaddress" value=" /> </appsettings> 4. Start the Acuo Patient Management REST Service. 5

6 Configure Microsoft Distributed Transaction Coordinator Complete the following steps to configure Microsoft Distributed Transaction Coordinator (MSDTC). 1. From the Control Panel, select Administrative Tools > Component Services > Computers > My Computer > Distributed Transaction Coordinator. 2. Right-click Local DTC and select Properties. 3. On the Security tab, under Security Settings, select the Network DTC Access check box. 4. Under Transaction Manager Communication, select the Allow Inbound and Allow Outbound check boxes. 5. Click OK. 6. Click Yes to restart the MSDTC service. Configure Route Destinations Route destinations should have a priority level of Direct. To configure a destination to use the direct mode priority, complete the following steps. 1. Right-click the route you want to configure and select Properties. 2. In the DICOM Command Options dialog box, under C-STORE Batch Process Settings, select Direct from the Priority drop-down menu. Automated Configuration Built-in stored procedures can be used to automatically configure certain AcuoMed objects that are used for the TagMapper workflow service. Each time it s executed, the stored procedure successfully configures the following components in AcuoMed. Two external devices. For example, Pacs1 and Pacs2. Two routes, one to each device created above. After it is created, the destination external device has tagmapper enabled and it will point to a command file that does not yet exist. The script mentioned below creates the necessary directories and command files. For example, createtagmapperdirectory. C-Store batch process settings with a Direct priority. One local CalledAE SCP One Move/Route mapping assignment 6

7 Stored procedure - Install The first stored procedure is located in the AcuoMed database and is labeled TAGMAPPER_AWS_INSTALL. Example The following example script executes the install stored procedure. A description of each parameter is listed in the table below. Use AcuoMed int = = = = = = = = = 4321 SELECT 'Return Value' value The CalledAeName for the Source PACS. When the example above is executed, it creates an external device with a label of FIND_PACS1 with a CalledAeName of PACS1. The hostname used for source PACS. The port used for source PACS. The CalledAeName for the destination PACS. When the example above is executed, it will create an external device with a label of STORE_PACS2 with a CalledAeName of PACS2. The hostname used for dest PACS. Optional. This parameter can be used to add a prefix to AE name (TM used if not specified). The port used for Destination PACS. The port of the local AE. 7

8 Stored procedure - Uninstall The second stored procedure is labeled TAGMAPPER_AWS_UNINSTALL and can be used to uninstall or remove configuration. Example The following example script executes the stored procedure. Note Running this script removes all settings configured during the stored install procedure. USE [AcuoMed] GO int = = = = 'PRE' SELECT 'Return Value' Create TagMapper directory The batch script, CreateTagMapperDirectory, can be used to automatically create TagMapper directories. This will save time creating directories manually in situations where multiple configurations are used. To create the directory, complete the following steps. 1. Locate the CreateTagMapperDirectory script in the following directory. \Program Files (x86)\acuo Technologies\TagMapper\Configuration 2. Execute the script. 3. Enter the desired name for the directory. 4. Click Enter. Step result The directory is created in the \Program Files (x86)\acuo Technologies\TagMapper directory and the command file is copied from the WebServices directory. Patient Management REST Web Service The Patient Management REST web service can be used to perform delete operations at all DICOM levels. When implementing a WCF service, you define a number of contracts that describe the service and the data that it sends and receives. The Patient Management REST web service is comprised of the following operational contracts. Delete Patient The Delete Patient operation deletes the patient from a specified DICOM database. Listed below are the [WebInvoke(UriTemplate = "{dicomdbfriendlyname}/patient/{id}", Method = "DELETE")] void DeletePatient(string dicomdbfriendlyname, string id); 8

9 dicomdbfriendlyname id DICOM database from which the patient is to be deleted. Value matches the DICOM Database Destination friendly name (name assigned in the AcuoMed DICOM Database Properties). PatientID of the patient to be deleted. Delete Study The Delete Study operation deletes the study from a specified DICOM database. Listed below are the [WebInvoke(UriTemplate = "{dicomdbfriendlyname}/study/{uid}", Method = "DELETE")] void DeleteStudy(string dicomdbfriendlyname, string uid); dicomdbfriendlyname uid DICOM database from which the study is to be deleted. Value matches the DICOM Database Destination friendly name (name assigned in the AcuoMed DICOM Database Properties). StudyInstanceUID of the study to be deleted. Delete Study from All Databases The Delete All Studies operation deletes the study from all DICOM databases. Listed below are the [WebInvoke(UriTemplate = "delete/all/studies/{uid}", Method = "DELETE")] void DeleteAllStudies(string uid); uid StudyInstanceUID of the study to be deleted. Delete Series The Delete Series operation deletes the series from a specified DICOM database. Listed below are the [WebInvoke(UriTemplate = "{dicomdbfriendlyname}/series/{studyuid}/{seriesuid}", Method = "DE LETE")] void DeleteSeries(string dicomdbfriendlyname, string studyuid, string seriesuid); 9

10 dicomdbfriendlyname studyuid seriesuid DICOM database from which the series is to be deleted. Value matches the DICOM Datbase Destination friendly name (name assigned in the AcuoMed DICOM Database Properties). StudyInstanceUID of the study containing the series to be deleted. SeriesInstanceUID of the series to be deleted. Delete Series from All Databases The Delete All Series operation deletes the series from all DICOM databases. Listed below are the [WebInvoke(UriTemplate = "delete/all/series/{studyuid}/{seriesuid}", Method = "DELETE")] void DeleteAllSeries(string studyuid, string seriesuid); studyuid seriesuid StudyInstanceUID of the study containing the series to be deleted. SeriesInstanceUID of the series to be deleted. Delete Image The Delete Image operation deletes the image from a specified DICOM database. Listed below are the [WebInvoke(UriTemplate = "{dicomdbfriendlyname}/image/{seriesuid}/{imageuid}", Method = "DEL ETE")] void DeleteImage(string dicomdbfriendlyname, string seriesuid, string imageuid); dicomdbfriendlyname seriesuid imageuid DICOM database from which the image is to be deleted. Value matches the DICOM Datbase Destination friendly name (name assigned in the AcuoMed DICOM Database Properties). SeriesInstanceUID of the series containing the image to be deleted. SOPInstanceUID of the image to be deleted. 10

11 Delete Image from All Databases The Delete All Images operation deletes the image from all DICOM databases. Listed below are the [WebInvoke(UriTemplate = "delete/all/images/{seriesuid}/{imageuid}", Method = "DELETE")] void DeleteAllImages(string seriesuid, string imageuid); seriesuid imageuid SeriesInstanceUID of the series containing the image to be deleted. SOPInstanceUID of the image to be deleted. Batch Move Web Services Batch move web services allows more flexibility with batch move data. Through this web service, you can execute the following procedures. Batch move jobs The batch web service can be used to table a batch move job. Wake up Once a batch move job has been tabled, a wake up call can be placed to AcuoMed to tell it to proceed with the move now that there is a job to be performed. Status The status of a batch move job can be retrieved, or changed to cancelled or paused. There are also counts that can be returned consisting of In Progress jobs or Completed jobs. The batch move web service provides web service-controlled DICOM C-Moves. When implementing a WCF service, you define a number of contracts that describe the service and the data that it sends and receives. The Batch Move Web Service is comprised of the following operations. BatchMoveStudy The BatchMoveStudy operation defines the MoveStudy interface. Listed below are the operational parameters. transactionid transactionsource movepriority movestartdelayinseconds moveretryintervalinseconds User-defined and is sent back on the callback. User-defined string. The priority for the batch move request. This value is added to the current time to delay when the batch move is scheduled. If value is present, the batch move is retried after the delay. 11

12 movetimetoliveinseconds alreadymovedseconds sourceroutename xmlsourcedicommatchingtag destinationae callbackurl Stops the polled move. Note This value must be present if moveretryintervalinseconds is provided. If value is present, a new batch move request is not issued if a batch move request was already issued for this patient ID and accession number within the given timeframe (previous number of seconds specified in parameter). The source route name for the move. The matching tags that are the key for the Tag Mapper table. The Destination Move AE Title for the DICOM Move request. This is used by the source to send images back to Perceptive. The URL to call back with the status of the move. MoveStudyCancel The BatchMoveStudy operation defines the MoveStudyCancel interface. Listed below are the operational parameters. MoveStudyCancel(int acuoid); acuoid - To cancel a request pass in the Id returned from the MoveStudy request. An alternative would be to use OData to obtain the Id. GetMoveStudyStatus The BatchMoveStudy operation defines the MoveStudyStatus interface. Listed below are the operational parameters. GetMoveStudyStatus(int acuoid); acuoid - To request the status of a Batch Move Job, pass in the Id returned from the MoveStudy request. An 12

13 WakeUp The BatchMoveStudy operation defines the WakeUp interface. Listed below are the operational parameters. WakeUp(string server); String Server To request a server to Wakeup pass the server name. This can be used SetNews The BatchMoveStudy operation defines the move study interface. Listed below are the operational parameters. (string server, long jobnumber, priority, string moveaetitle, String moveroutename); Route GUID, datetime, wakeup) String Server, job number, job priority, moveaetitle, moveroutename, Roure GUID, datatime,wakeup) Batch move WSDL access The following example URL can be used to access the WSDL for BatchServices. 13

14 TagMapper Web Service The TagMapper web service can be used to transform DICOM tag data while moving from a source to a destination. When implementing a WCF service, you define a number of contracts that describe the service and the data that it sends and receives. The TagMapper web service is comprised of the following operational contracts. MoveStudy The MoveStudy operation defines the MoveStudy interface. Listed below are the transactionid transactionsource movepriority movestartdelayinseconds moveretryintervalinseconds movetimetoliveinseconds sourceroutename xmlsourcedicommatchingtag destinationae xmldicomtagtransformations callbackurl User defined and is sent back on the callback. User defined string. The priority for the Batch Move Request. This value will be added to the current time to delay when the Batch Move is scheduled. If value is present we will retry the Batch Move after this delay. This value needs to be present if moveretryintervalinseconds is provided. Stops the Polled Move. This is the Source Route Name for the Move. These are the Matching Tags that will be the key for the Tag Mapper table. This is the Destination Move AE Title for the DICOM Move request. This is used by the source to send images back to us. These are the transformations for the images. These are converted to Tag Mapper commands. This is the URL to call back with the status of the Move. MoveStudyCancel The MoveStudyCancel operation defines the the MoveStudyCancel interface. Listed below are the MoveStudyCancelStatus MoveStudyCancel(int acuoid); acuoid. To cancel a request pass in the Id returned from the MoveStudy request. An alternative would be to use OData to obtain the Id. 14

15 GetMoveStudyStatus The GetMoveStudyStatus operation defines the MoveStudyStatus interface. Listed below are the GetMoveStudyStatus GetMoveStudyStatus(int acuoid); acuoid. To request the status of a Batch Move Job, pass in the Id returned from the MoveStudy request. An alternative would be to use OData to obtain the Id. Processsing Overview The xmlsourcedicommatchingtag parameter is based on the DICOM Starndard Supplement 118 for representing DICOM tags in XML. The source matching tags that are currently supported are PID and Accession Number. The xmldicomtagtransformation parameter is also based on DICOM Starndard Supplement 118. The matching tags that are currently supported are Replace and MatchAndReplace for sequences. Below is the sequence of events for the TagMapper web service. 1. The move study request is received and validated. 2. A batch move is tabled to run based on the input parameters. Note The Interval and Time to Live values support a polled moved. To run the batch move only once, theses values should equal zero. 3. As the images are moved from the sourceroutename to the destinationae, the xmldicomtagtransformations are applied to the images. 4. If a CallBack URL is provided, the system calls back with the status of the request. The following diagram demonstrates the sequence of events outlined above. There are two types of transforms currently supported, Replace and MatchAndReplace. 15

16 Replace The Replace transform replaces the current tag with the supplied value. Example Replace PID Tag (Patient ID) is transformed to PID Replace Accession Number Tag (Accesion Number) is transformed to Accession MatchAndReplace The MatchAndReplace (sequences only) transform replaces the tag based on matching criteria. Example MatchAndReplace Tag 0040A372 (Requestd Procedure Code) is transformed as follows. Transform matchitem="1" replaceitem="3" If the sequence values match Item 1 "ABC/CSD", they are transformed to Item 3 "CPT04/CPT. Transform matchitem="2" replaceitem="3" If the sequence values match Item 2 "DEF/CSD", they are transformed to Item 3 "CPT04/CPT. Transform matchitem="*" replaceitem="3" If the sequence exists, they are transformed to Item 3 "CPT04/CPT. Transform matchitem="+" replaceitem="3" The sequence is added with the values of Item 3 "CPT04/CPT. TagMapper WSDL access The following example URL can be used to access the WSDL for TagMapper web services. 16