============================================================================= Run Date: MAR 09, 2020 Designation: MAG*3*239 Package : MAG - IMAGING Priority: Mandatory Version : 3 SEQ #186 Status: Released Compliance Date: APR 09, 2020 ============================================================================= Subject: HDIG Adaptive Maintenance and Defect Patch Category: - Routine Description: ============ Description: This document describes MAG*3.0*239, a patch that provides fixes to the HDIG. This patch addresses the following issues: 1. HDIG not re-processing failed images 2. Incorrect formatting in DICOM header of imported images 3. Incorrect Global reference in ^MAGDGMRC 4. Change the default setting of C:\Vixconfig\DICOMServerconfiguration.config rejectDuplicates flag to true 5. Query Retrieve is creating a New SOP Instance UID when transferring images 6. Query Retrieve includes a DICOM header element in the data set that should be removed before that should before transmission 7. Open-ended date range parameters fail to return associated studies in Query Retrieve 8. CLASS INDEX field value saving as free text, not pointer value 9. Site name not populating on HDIG Stats page after install of HDIG Patch 204 10. Tomcat Vulnerabilities 11. DICOM corrections not rolling over to a Complete status 12. Patch 239 T2 KID produces an error in test site's error trap Associated Patches: VistA Imaging MAG*3.0*239 must be installed after MAG*3.0*204. Patch Components: ----------------- MAG3_0P239.KID - Kernel Installation and Distribution System (KIDS) build for Patch 239 - New MAG3_0P239_HDIG_Setup.exe - Hybrid DICOM Gateway Installation File - New MAG3_0P239_DIBORG.pdf - Hybrid DICOM Gateway Deployment, Installation, Back-Out, and Rollback Guide - New Files & Fields Associated: File Name (Number) Field Name (Number) New/Modified/Deleted ------------------ ------------------- -------------------- N/A Forms Associated: Form Name File Number New/Modified/Deleted --------- ----------- -------------------- N/A Mail Groups Associated: Mail Group Name New/Modified/Deleted --------------- -------------------- N/A Options Associated: Option Name Type New/Modified/Deleted ----------- ---- -------------------- N/A Protocols Associated: Protocol Name New/Modified/Deleted ------------- -------------------- N/A Security Keys Associated: Security Key Name ----------------- N/A Templates Associated: Template Name Type File Name (Number) New/Modified/Deleted ------------- ---- ------------------ -------------------- N/A Remote Procedures Associated: Remote Procedure Name New/Modified/Deleted --------------------- -------------------- N/A Parameter Definitions Associated: Parameter Name New/Modified/Deleted -------------- -------------------- N/A Additional Information: ----------------------- Blood Bank Team Coordination: N/A New Service Requests (NSRs): N/A Patient Safety Issues (PSIs): N/A Defect Tracking System Ticket(s) & Overview: 1. Defects 976101, 1101400, 1114004, 1116516 (Trouble Tickets INC4807577, INC5574618, INC6993081, INC7064624, INC7315868, INC7080188, INC7160823, INC7092084) HDIG not re-processing failed images Problem: -------- The original send of the object to the HDIG gets partially processed. Entries are started in the VistA files, but image is never stored due to a write error on the Image Share. After the issue with the share is resolved the site then attempts to send the object again and the HDIG fails to process the send with the error below: 04 Apr 2019 14:20:52,105 INFO [Thread-334] (EntityDAO.java:371) - MAGV ATTACH SOP RPC Results:[-63`Active reference with same unique ID already exists] Resolution: ----------- Modified the code to update the Image SOP Instance File on the resend instead of trying to create a new entry. This allowed the process to complete and save the image to the share. 2. User Story 787812 Incorrect formatting in DICOM header of imported images Problem: -------- When importing a DICOM Image using Importer III the DICOM header is being modified and changing the format of two fields (Name & Date of Birth). This current format does not follow the DICOM standard. The Patient Name (0010,0010) should be in Last Name^First Name^Middle Name, Name Prefix, Name suffix format currently is Last^First Middle. The Patient's Date of Birth (0010,0030) should be YYYYMMDD and the format currently is Day of Week Month Day Time Year. Resolution: ----------- Modified the code to format these fields in the DICOM header correctly. 3. Defect 1004047 (Trouble Ticket INC5253064) Incorrect Global reference in ^MAGDGMRC Problem: -------- When searching VistA files #2005.61 and #2005.62 in the MUMPS routine MAGDGMRC the wrong Global is being used. These files are part of the new SOP class structure and use the ^MAGV global not the ^MAG global. Resolution: ----------- Updated the routine with the correct Global (^MAG). 4. User Story 997886 Change the default setting of C:\Vixconfig\DICOMServerconfiguration.config rejectDuplicates flag to true. Problem: -------- Currently the default setting for the of the C:\Vixconfig\DICOMServerconfiguration.config rejectDuplicates flag is set to false on install of the HDIG. The customer has requested this configuration default to true on install. Resolution: ----------- Modified the code to set the default value of rejectDuplicates to true on install. 5. Defect 1016623 (Trouble Ticket INC5787452, INC7930153) Query Retrieve is creating a New SOP Instance UID when transferring images. Problem: -------- When transmitting certain DICOM files Query Retrieve is updating the New SOP Instance UID because it is removing some private DICOM Data Elements. Resolution: ----------- Query retrieve will now create the New SOP Instance UID only if the image does not already contain the element with tag name PACS UID. (PACS UID is the tag name used in these images which actually refers to SOP Instance UID). 6. Defect 1057062 (Trouble Ticket INC6043604) Query Retrieve includes a DICOM header element in the data set that should be removed before that should before transmission. Problem: -------- When a Targa file is part of the Query Retrieve request, the HDIG is including 0002,0002 as a Data Elements in the Data Set. Per the DICOM standard Data Elements with a group of 0002 shall not be used in Data Sets other than within the File Meta Information. Resolution: ----------- Modify the code to remove the 0002,0002 data element when converting a Targa file to DICOM for transmission like it does for the other group 0002 Data Elements. 7. Defect 1088841 (Trouble Ticket INC6715534) Open-ended date range parameters fail to return associated studies in Query Retrieve Problem: -------- When users attempt to perform Query Retrieve using open-ended date range parameters (ex. 20190101 - ) to retrieve studies from VistA, the attempt fails to return associated studies. Resolution: ----------- Corrected program to use the system's date when last date is null. 8. Defect 1090147 (Trouble Ticket INC6755002) CLASS INDEX field value saving as free text, not pointer value Problem: -------- The Class Index field value is being improperly saved as free text ("CLIN") instead of a pointer value (to file #2005.82) Resolution: ----------- Changed code to fix storing of the CLASS INDEX pointer in the series file #2005.63. Updated post-install routines to include a clean-up subroutine that fixes CLASS INDEX pointers in the series file #2005.63. 9. Defect 1103538 (Trouble Ticket INC7035015, INC7053152, INC7055156, INC7056056, INC7056860, INC6926283, INC7127221) Site name not populating on HDIG Stats page after install of HDIG Patch 204 Problem: -------- When the PLACE value field in the Network Location in the Vista has a bad pointer or blank, the HDIG stats page does not populate the site name. Resolution: ----------- The HDIG logs will display the error message - "The PLACE value for the <> in the NETWORK LOCATION file is either blank or has a bad pointer. The PLACE field value needs to be corrected". 10. Defect 1099285 (Trouble Ticket INC6916645, INC7768445) Tomcat Vulnerabilities Problem: -------- A default install of Tomcat was identified with a vulnerability that allowed an unauthenticated user to manage and deploy web applications. Resolution: ----------- External connections to the Tomcat manager webpage have been disabled. 11. Defect 1098714 (Trouble Ticket INC6800869) DICOM corrections not rolling over to a Complete status Problem: -------- When creating a new order, DICOM corrections performed using the Importer will not roll over to a Complete status despite setting the proper values in the Status Change Details window. Resolution: ----------- Updated the java code so that the Exam Status changes to the value set in the Importer application for DICOM Correct workflow. 12. Defect 1161382 Patch 239 T2 KIDS produces an error in the test site's error trap Problem: -------- When running Patch 239's T2 KIDS, an error is produced in the test site's error trap due to having too many entries being processed at once. Resolution: ----------- Modified post-install routine to process one entry at a time to prevent the FDA array from becoming too large and causing an error. Test Sites: ----------- VA St. Louis Healthcare System Memphis VA Medical Center Hunter Holmes McGuire VA Medical Center (Richmond) Sacramento VA Medical Center - VA Northern California Health Care System Software and Documentation Retrieval Instructions: -------------------------------------------------- Documentation describing the new functionality and/or a host file containing a build may be included in this release. Sites may retrieve the software and/or documentation directly using Secure File Transfer Protocol (SFTP) from the ANONYMOUS.SOFTWARE directory on download.vista.domain.ext Documentation can also be found on the VA Software Documentation Library at: https://www.domain.ext/vdl/ Patch Installation: ------------------- Supported Client Versions: When MAG*3.0*239 is released, the list of supported versions of HDIG will change: Client Versions Supported: 3.0.239 3.0.204 3.0.194 Client Versions No Longer Supported: 3.0.192 3.0.172 3.0.162 Pre/Post Installation Overview: MAG*3.0*239 must be installed on the VistA System and on 64-bit HDIG servers. This patch must be installed by the compliance date. All sites running VistA Imaging 3.0 must install the KIDS portion of this patch. This patch can be loaded while the VistA Imaging System is active and users are on the system. Installing the MAG*3.0*239 KIDS takes 2-5 minutes. Note: HDIG will not install on 2003 and 2008 servers configured as 32 bit. There is also a known issue if there are multiple Java versions on the system for HDIG and hence not recommended: For a fresh installation, remove all installed Java applications before the installation of MAG*3.0*239. Verify that the patches listed in the Associated Patches section of this document have been previously installed. Note: To avoid losing configuration changes, sites with a modified HDIG Listen file will need to save a copy of the file before installing this patch. After the installation is complete, restore the file and restart the Tomcat service. C:\DCF_RunTime\cfg\apps\defaults\LISTEN Installation Instructions: KIDS installation will take less than one minute. 1. On the VistA system, access the Kernel Installation and Distribution System Menu [XPD MAIN]. 2. Run the Installation option [XPD INSTALLATION MENU]. 3. Load the KIDS file by performing the following steps: a. Run the Load a Distribution option [XPD LOAD DISTRIBUTION] to load the KIDS distribution. b. When prompted, enter the path and file name (MAG3_0P239.KID) of the MAG*3.0*239 KIDS file. c. When prompted to continue with the load, enter "YES". A Distribution OK! message will be displayed when the load is complete. 4. After loading the KIDS file, use the following options to verify the contents of the patch and to back up any affected routines. a. Verify Checksums in Transport Global [XPD PRINT CHECKSUM] - Run this option if you want to ensure the integrity of the routines in the patch. b. Compare Transport Global to Current System [XPD COMPARE TO SYSTEM] - Run this option if you want to view all changes that will be made when the patch is installed. All components (routines, options, and so on) in the patch will be compared. c. Backup a Transport Global [XPD BACKUP] - Run this option if you want to create a backup message of any routines exported with the patch. It will NOT back up any of the other changes. 5. After performing the load and any optional verification steps, install the KIDS file by performing the following steps: a. Run the Install Package(s) [XPD INSTALL BUILD] option. b. When prompted for the install name, enter "MAG*3.0*239". c. Answer "NO" to the following prompts, if they appear: i. Want KIDS to Rebuild Menu Trees Upon Completion of Install? NO// ii. Want KIDS to INHIBIT LOGONs during the install? NO// iii. Want to DISABLE Scheduled Options, Menu Options, and Protocols? NO// 6. When installation is finished, an Install Complete message will be displayed. Installing and Updating the HDIG: For installing or updating the HDIG, refer to the Hybrid DICOM Image Gateway (HDIG) Installation Guide. Post-Installation Instructions N/A Back-Out/Roll Back Plan: ------------------------ Uninstalling the MAG*3.0*239 KIDS: If it is necessary to uninstall the MAG*3.0*239 VistA KIDS, you needed to select the "Kernel Installation & Distribution System" menu option, "Backup a Transport Global" (see installation section above, step 4c), before you installed the patch. Administrators will need to use the PackMan function INSTALL/CHECK MESSAGE. Check your MailMan messages for the backup message sent by the "Backup a Transport Global" function. 1. In VistA MailMan, select the message shown below: Backup of MAG*3.0*239 install on 2. Select the Xtract PackMan option. 3. Select the Install/Check Message option. 4. Enter Yes at the prompt. 5. Enter No at the backup prompt. There is no need to back up the backup. Enter message action (in IN basket): Ignore// Xtract PackMan Select PackMan function: ? Answer with PackMan function NUMBER, or NAME Choose from: 1 ROUTINE LOAD 2 GLOBAL LOAD 3 PACKAGE LOAD 4 SUMMARIZE MESSAGE 5 PRINT MESSAGE 6 INSTALL/CHECK MESSAGE 7 INSTALL SELECTED ROUTINE(S) 8 TEXT PRINT/DISPLAY 9 COMPARE MESSAGE Select PackMan function: Select PackMan function: 6 INSTALL/CHECK MESSAGE Warning: Installing this message will cause a permanent update of globals and routines. Do you really want to do this? NO// YES Routines are the only parts that are backed up. NO other parts are backed up, not even globals. You may use the 'Summarize Message' option of PackMan to see what parts the message contains. Those parts that are not routines should be backed up separately if they need to be preserved. Shall I preserve the routines on disk in a separate back-up message? YES// NO No backup message built. Line 2 Message #42925 Unloading Routine MAGxxx (PACKMAN_BACKUP) Select PackMan function: Uninstalling the HDIG Client: For uninstalling the HDIG, refer to the Hybrid DICOM Image Gateway (HDIG) Installation Guide. Routine Information: VistA KIDS Checksums This section lists modified routines for the VistA KIDS build. For each routine, the second line will contain the following information: ;;3.0;IMAGING;** [Patch List]**;**;Mar 19, 2002;Build 25 CHECK1^XTSUMBLD is used to generate the checksums. Routine Checksums Routine Checksum Checksum Patch List Before After MAGDGMRC 23141065 24146694 **10,51,50,85,118,138, 239** MAGDQR02 63705354 64531448 **51,54,66,118,239** MAGDRPC1 49239029 59747626 **11,30,51,50,54,49, 122,138,239** MAGDRPC9 97395044 98039455 **50,54,53,49,123,118, 138,180,190,239** MAGIP239 New 6439353 **239** MAGVRS44 40208831 43868072 **118,239** Routine MAGIP239 is an installation routine that is automatically deleted after the KIDS installation. Routine Information: ==================== The second line of each of these routines now looks like: ;;3.0;IMAGING;**[Patch List]**;Mar 19, 2002;Build 19;May 19, 2019 The checksums below are new checksums, and can be checked with CHECK1^XTSUMBLD. Routine Name: MAGDGMRC Before: B23141065 After: B24146694 **10,51,50,85,118,138,239** Routine Name: MAGDQR02 Before: B63705354 After: B64531448 **51,54,66,118,239**Sept 09,2019 Routine Name: MAGDRPC1 Before: B49239029 After: B59747626 **11,30,51,50,54,49,122,138,239** Routine Name: MAGDRPC9 Before: B97395044 After: B98039455 **50,54,53,49,123,118,138,180, 190,239** Routine Name: MAGIP239 Before: n/a After: B6439353 **239** Routine Name: MAGVRS44 Before: B40208831 After: B43868072 **118,239** Routine list of preceding patches: 190 ============================================================================= User Information: Entered By : Date Entered : MAR 14, 2019 Completed By: Date Completed: MAR 05, 2020 Released By : Date Released : MAR 09, 2020 ============================================================================= Packman Mail Message: ===================== No routines included