============================================================================= Run Date: NOV 18, 2022 Designation: MAG*3*303 Package : MAG - IMAGING Priority: Mandatory Version : 3 SEQ #233 Status: Released Compliance Date: DEC 19, 2022 ============================================================================= Associated patches: (v)MAG*3*269 <<= must be installed BEFORE `MAG*3*303' Subject: VISTA IMAGING EXCHANGE (VIX) VIEWER IMPROVEMENTS Category: - Routine Description: ============ This patch addresses the following issues and new capabilities: Unless noted otherwise, each change applies to VIX and CVIX. 1. Enhancement (IMAG-3573) DICOM SCP Improvements. 2. Enhancement (IMAG-3072, INC20875535) Query for Data Access Service (DAS)/Data Exchange Service (DES)/Healthcare Artifact and Imagery Management Solution (HAIMS) for Department of Defense (DOD) non-DICOM files is now optional and not done for the Joint Legacy Viewer (JLV). 3. Defect (IMAG-3320) Make image type not supported image more intuitive for display in JLV (and VIX Viewer). 4. Enhancement (IMAG-3730) Enterprise Clinical Imaging Archive (ECIA) / DOD performance enhancements. 5. Defect (IMAG-76, INC6349754) Modify the validate button in the VIX Installation Wizard to improve clarity. 6. Defect (IMAG-3373) Support for MUSE Study and Image queries in CVIX. 7. Enhancement (IMAG-3087) Replace SQLServer with SQLite. 8. Enhancement (IMAG-1849) Installation changes and improvements. 9. Enhancement (IMAG-3000) Enhanced encryption support in configuration files. 10. Enhancement (IMAG-1855) Commercial off-the-shelf (COTS) package updates for VA Technical Reference Manual (TRM) compliance. 11. Defect (IMAG-3658) Remove Site Service asmx fallback mechanism. 12. Defect (IMAG-3713) Remove Dashboard.RequireAdministrator. 13. Defect (IMAG-3746) Display the RTF or TXT thumbnail instead of PDF. 14. Enhancement (IMAG-3870) Implement HTTP compression support using gzip. 15. Defect (IMAG-3873, INC23912305) Services returning the wrong metadata for MUSE images. Patch Components: ----------------- 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: (IMAG numbers are from VA Jira) 1. Enhancement (IMAG-3573) DICOM SCP Improvements Problem: -------- There was non-optimized caching logic and non-optimized remote fetching logic for DICOM Query Retrieve Service Class Provider (SCP) retrieve requests. There was also no configuration option to exclude sites within a particular Veterans Integrated Service Network (VISN). The DICOM QR (Query Retrieve) feature was not efficiently serving concurrent requests. Reports generated by DICOM QR appear to belong to a different patient with a similar name and/or study than the instances for that study. The Vix Cache folder contained duplicate files with different names for study reports generated by DICOM QR. Resolution: ----------- The DICOM SCP logic was updated to improve performance of cached behavior and remote fetch of images and establish more rigid control of threading. The DICOM SCP configuration file has been updated to contain a site code blacklist allowing exclusion of data fetch from particular sites by their site number and toggle returning study query level in C-FIND responses. The DICOM QR now more efficiently serves concurrent requests. Reports generated by DICOM QR now appear under the same patient and study as the instances for that study. The Vix Cache folder now no longer contains duplicate files and instead a single file for study reports generated by DICOM QR. 2. Enhancement (IMAG-3072,INC20875535) Query for Data Access Service (DAS)/Data Exchange Service (DES)/Healthcare Artifact and Imagery Management Solution (HAIMS)for Department of Defense (DOD) non-DICOM files is now optional and not done for the Joint Legacy Viewer (JLV). Problem: -------- JLV users do not want CVIX to query DAS/DES/HAIMS for non-DICOM DOD artifacts as JLV already does this itself. However, other applications, such as VistA Imaging Clinical Display, still need those files. Resolution: ----------- The JLV already retrieves DoD non-DICOM artifacts itself via its Fast Healthcare Interoperability Resources (FHIR) interface so the CVIX no longer queries for those files when JLV asks for a patient's study list. 3. Defect (IMAG-3320) Make image type not supported image more intuitive for display in JLV (and VIX Viewer). Problem: -------- When displaying an image type not supported image, JLV (and the VIX Viewer) do not allow one to intuitively have the other series in the study display. Resolution: ----------- The VIX Viewer now sets the image type not supported image to the same study instance UID as the other series in the study. Further, the VIX Viewer now sets the image type not supported image to have a series number one greater than the maximum of the others in the study so it always displays last in JLV (and the VIX Viewer). 4. Enhancement (IMAG-3730) Enterprise Clinical Imaging Archive (ECIA) / DOD performance enhancements. Problem: -------- ECIA/DOD calls were slow resulting in studies not loading as quickly as possible. Resolution: ----------- ECIA/DOD calls have been updated to improve performance and load studies faster. 5. Defect (IMAG-76,INC6349754) Modify the validate button in the VIX Installation Wizard to improve clarity. Problem: -------- The Validate button in the VIX Installer only validates that the fields have been populated correctly. This is misleading as it can be interpreted it is validating if a service account exists in VistA. Resolution: ----------- The Validate button has been renamed Confirm to accurately describe its function and not mislead users. 6. Defect (IMAG-3373) Support for MUSE Study and Image queries in VIX and CVIX. Problem: -------- Queries against the CVIX "/Study/restservices/study/{studyId}" and "/ImageWebApp/image" endpoints do not return Study or Image artifacts from MUSE and will instead return 500 (Internal Server Error)responses. Resolution: ----------- This fix allows servers to query and include MUSE Study data for individual Study queries as well as to allow queries against MUSE for individual images. Artifacts listed in study query results can now be retrieved (including Study and Image data). 7. Enhancement (IMAG-3087) Replace SQL Server with SQLite. Problem: -------- Until now, the VIX Render service used SQL Server 2017 which is not supported in the TRM. Upgrading to SQL Server 2019 requires Windows Server 2016 that some VIX servers are not running. Maintaining and upgrading SQL Server was a challenge including lengthy installations and a Windows service that runs. Thus an alternative to SQL server is needed. Resolution: ----------- The VIX Installer and VIX Render service replaced SQL Server with SQLite that is supported by the TRM and does not require Windows Server 2016. 8. Enhancement (IMAG-1849) Installation changes and improvements. A. Determine if there is enough disk space for installation. Problem: -------- Prior to this change, the VIX Installer allowed an installation to proceed if the free disk space was low and sometimes allowed the disk to run out of free space. Resolution: ----------- When the user arrives on the VIX Prerequisites page during the VIX install, there is now a line that informs the user if sufficient free disk space is detected. If there is insufficient free disk space, the user is not allowed to proceed with the VIX install. B. Specify the MUSE configuration as part of the VIX install. Problem: -------- Prior to this change, in order to set-up or update the MUSE configuration,the configuration file required a manual update. Resolution: ----------- The VIX Installer now has a Specify the MUSE configuration page allowing the user to enter or update the MUSE Site Number, Server Host, Username,and Password. C. Relocate VIX Viewer/Render services installation in the VIX Installer. Problem: -------- Prior to this change, the VIX Viewer/Render services installation was included as part of the VIX Prerequisites page. This was confusing to users as a Reinstall button often displayed, and it is its own application and web service on the same level as the VIX. Resolution: ----------- The VIX Installer now has the VIX Viewer/Render services installation moved from the VIX Prerequisites page to the Install the VIX page. Now when one clicks Install, the VIX Viewer/Render services is installed along with VIX/CVIX. D. Remove backups of the logs folder in C:\VixConfig. Problem: -------- Prior to this change, the VIX Installer automatically created a backup of the logs folder in C:\VixConfig. This was not necessary and used disk space. Resolution: ----------- The VIX install no longer backups the logs folder in C:\VixConfig and now deletes any existing backup. 9. Enhancement (IMAG-3000) Enhanced encryption support in configuration files. Problem: -------- All Java based configuration files need to be FIPS-140 compliant and encrypted. Resolution: ----------- Additional support for configuration files to be encrypted has been added.Supported Java based configuration files now convert plain text fields (ie.username or password) to encrypted forms on service use or Tomcat startup. Further, a encryption utility allows P303 to P269 rollback installations to proceed automatically between the previous and new encryption algorithms. 10. Enhancement (IMAG-1855) Commercial off-the-shelf (COTS) package updates for VA Technical Reference Manual (TRM) compliance. Problem: -------- COTS packages required an upgrade in accordance with the TRM. Resolution: ----------- The Tomcat version in MAG*3.0*269 was 9.0.40 and upgraded to 9.0.58 in accordance with the TRM. The Java version in MAG*3.0*269 was 8u291 and upgraded to 8u331 in accordance with the TRM. The LibreOffice version in MAG*3.0*269 was 7.0.6 and upgraded to 7.2.5 in accordance with the TRM. 11. Defect (IMAG-3658) Remove Site Service asmx fallback mechanism. Problem: -------- VIX that failed to update their Site Service file through rest services would fallback to an old .asmx endpoint that served invalid data. Upon updating their Site Service file from that endpoint, the VIX would cease to function until Tomcat was restarted. Resolution: ----------- The VIX no longer send requests to the .asmx endpoint. Instead, they asynchronously attempt to re-query the rest services using Exponential Backoff, and VIX relies on the file system cached version of the site service until it can update through rest services. The backoff algorithm defaults are set to 50 for and 90 seconds for . If desired, the backoff algorithm maximums can be set in the SiteServiceResolution-1.0.config. 12. Defect (IMAG-3713) Remove Dashboard.RequireAdministrator. Problem: -------- The Previous VIX Installation Guide told the reader to add the Dashboard.RequireAdministrator entry to VIX.Viewer.config. That was a temporary work around to fix a defect in the code that relied on that entry. Resolution: ----------- The defect was fixed in this patch, so that line is no longer needed. The VIX Installation Wizard removes that unwanted line from the file. The software no longer contains any references to Dashboard.RequireAdministrator. 13. Defect (IMAG-3746) Display the RTF or TXT thumbnail instead of PDF. Problem: -------- The previous VIX Image Viewer displayed a PDF thumbnail for RTF and TXT files. Resolution: ----------- Display any RTF thumbnail for RTF files, a TXT thumbnail for TXT files, and a PDF thumbnail for PDF files. 14. Enhancement (IMAG-3870) Implement HTTP compression support using gzip. Problem: -------- The VIX and CVIX did not support HTTP compression. Resolution: ----------- The VIX and CVIX communicating with web applications on Apache Tomcat port 443 now support HTTP compression using the gzip algorithm. Further, DICOM SCP image fetch now supports HTTP compression by including the "Accept-Encoding:gzip" http header. 15. Defect (IMAG-3873,INC23912305) Services returning the wrong metadata for MUSE images. Problem: -------- When querying the CVIX image metadata endpoints (image/globalnodes, image/devfields) for metadata about an image with a MUSE image identifier (e.g., "urn:museimage:identifier") the service will return data for the wrong image. Resolution: ----------- The MUSE data source does not implement or provide metadata, so modifications to the service endpoints were made to filter MUSE image metadata requests and return blank data. Test Sites: ----------- * Richmond VAMC * Veterans Health Care System of the Ozarks * Puget Sound Health Care System Software and Documentation Retrieval Instructions: --------------------------------------------------------------- The software for this patch is being released using a host file. The host file (Kernel Installation and Distribution System (KIDS)) is available at the following location: /srv/vista/patches/SOFTWARE/MAG3_0P303.KID Other Software Files: This release also includes other software files. They can be obtained at location: /srv/vista/patches/SOFTWARE Other software files can also be obtained by accessing the URL: https://download.vista.domain.ext/index.html/SOFTWARE. File Title File Name ---------------------------------------------------------------------- VistA Imaging Exchange (VIX) Installer MAG3_0P303_VIX_SETUP.MSI Central VistA Imaging Exchange (CVIX) Installer* MAG3_0P303_CVIX_SETUP.MSI Documentation describing the new functionality is included in this release. Documentation can be found on the VA Software Documentation Library: https://www.domain.ext/vdl/application.asp?appid=105. Documentation can also be obtained at https://download.vista.domain.ext/index.html/SOFTWARE. Documentation Title File Name ------------------------------------------------------------------------ Deployment, Installation, Backout, and Rollback Guide MAG3_0P303_DIBORG.PDF VistA Imaging Exchange (VIX) Installation Guide MAG3_0P303_VIX_INSTALLATION_GUIDE.PDF Central VistA Imaging Exchange (CVIX) Installation Guide* MAG3_0P303_CVIX_INSTALLATION_GUIDE.PDF VistA Imaging Exchange (VIX) Administration Guide MAG3_0P303_VIX_ADMINISTRATION_GUIDE.PDF CVIX Administrator's Guide and Product Operations Manual* MAG3_0P303_CVIX_POM.PDF *Note: Only the KIDS and VIX client for MAG*3.0*303 should be installed at medical centers. As a result, the CVIX Installer and related CVIX installation files are not provided to sites on the Network File Shares. Patch Installation: ------------------- Pre/Post Installation Overview: MAG*3.0*303 KIDS must be installed on the VistA System prior to running the new executables. 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 may be loaded while the VistA Imaging System is active. The installation takes less than one minute. Pre-Installation Instructions: This patch may be installed with users on the system, although it is recommended that it be installed during non-peak hours to minimize potential disruption to users. This patch should take less than 5 minutes to install. It is not necessary to stop VIX services prior to installation of the Host file. Installation Instructions: 1. This release is provided using a Host file, use the Load a Distribution option contained on the Kernel Installation and Distribution System Menu to load the Host file. When prompted to "Enter a Host File:" enter /srv/vista/patches/SOFTWARE/MAG3_0P303.KID 2. From the Kernel Installation and Distribution System Menu, select the Installation Menu. From this menu, A. Select the Verify Checksums in Transport Global option to confirm the integrity of the routines that are in the transport global. When prompted for the INSTALL NAME enter the patch name MAG*3.0*303. NOTE: Using does not bring up a Multi-Package build even if it was loaded immediately before this step. It will only bring up the last patch in the build. B. Select the Backup a Transport Global option to create a backup message of any routines exported with this patch. It does not backup any other changes such as DDs or templates. C. You may also elect to use the following options: i. Print Transport Global - This option allows you to view the components of the KIDS build. ii. Compare Transport Global to Current System - This option allows you to view all changes made when this patch is installed. It compares all of the components of this patch,such as routines, DDs, templates, etc. D. Select the Install Package(s) option and choose the patch to install. i. If prompted 'Want KIDS to Rebuild Menu Trees Upon Completion of Install? NO//', answer ii. When prompted 'Want KIDS to INHIBIT LOGONs during the install? NO//', answer . iii. When prompted 'Want to DISABLE Scheduled Options, Menu Options,and Protocols? NO//', answer KIDS installation takes 2 - 5 minutes. Installation Verification: Use the Install File Print option on the Utilities menu under KIDS and select MAG*3.0*303 to verify successful VistA installation. Successful VIX installation can be verified by following the instructions in the MAG3_0P303_VIX_INSTALLATION_GUIDE.PDF. Post-Installation Instructions: For post-installation instructions, please see the MAG3_0P303_VIX_INSTALLATION_GUIDE.PDF for more detail. Back-out Procedures for MAG Routines ------------------------------------ Back-out can be done only with the concurrence and participation of the development team and appropriate VA site/region personnel. The decision to back-out or rollback software can be a joint decision between the development team, VA site/region personnel, and other appropriate VA personnel. Routine MAGIP303 is an installation routine that is automatically deleted after the KIDS installation. Rollback, Back Out, or Uninstalling MAG*3.0*303 MSI -------------------------------------------------- If it is necessary to uninstall the MAG*3.0*303 VIX MSI, use the Uninstall option from Windows Control Panel to uninstall: "VIX Service Installation Wizard 30.303.1.8021". Then install the previous version of VIX, which was included in MAG*3.0*303. To back out the VIX and replace it with the prior version, please see the MAG3_0P303_VIX_INSTALLATION_GUIDE.PDF for more detail. The versions should be validated during uninstall, rollback or back-out if necessary. Routine Information: ==================== The second line of each of these routines now looks like: ;;3.0;IMAGING;**[Patch List]**;Mar 19, 2002;Build 5;Jan 18, 2012 The checksums below are new checksums, and can be checked with CHECK1^XTSUMBLD. Routine Name: MAGIP303 Before: n/a After: B4110371 **303** ============================================================================= User Information: Entered By : Date Entered : FEB 25, 2021 Completed By: Date Completed: NOV 18, 2022 Released By : Date Released : NOV 18, 2022 ============================================================================= Packman Mail Message: ===================== No routines included