$TXT Created by CHY0017D.FO-BAYPINES.DOMAIN.EXT (KIDS) on Wednesday, 07/07/21 at 12:42 ============================================================================= Run Date: JUL 26, 2021 Designation: SD*5.3*788 Package : SD - SCHEDULING Priority: EMERGENCY Version : 5.3 SEQ #640 Status: Released Compliance Date: AUG 09, 2021 ============================================================================= Associated patches: (v)SD*5.3*785 <<= must be installed BEFORE `SD*5.3*788' Subject: VSE ENHANCEMENTS VS GUI RELEASE 1.7.8.2 Category: - Routine - Other Description: ============ VistA Scheduling (VS) Graphical User Interface (GUI) Release 1.7.8.2 and SD*5.3*788 include various enhancements and defect fixes. Defects corrected in the release include, correcting an issue where the Loading Dialog has duplicate wording, and updating the display icon on the Time Slot Viewer to display correct icons when collapsed and expanded. Additional fixes include recall and Multiple Return to Clinic (MRTC) fixes, "Waitlist" tool tip fix, formalizing JSON Return Object, and a User Preference fix that will allow the data in the Request Management (RM) Grid to match the User Preference setting. This patch addresses the 37 Jira tickets listed below and covers new or updated Remote Procedure Calls (RPCs), file updates and standardization of error messaging to the VS GUI. ************************************************************************** * GUI UPDATE NOTICE * *----------------------------------------------------------------------- * * This patch MUST be installed before the GUI update for release * * 1.7.8.2 of VS is installed. * * * * * * * * * * The previous version of the VS GUI will not operate after this * * patch is installed. Therefore, VS GUI v1.7.8.2 and VistA patch * * SD*5.3*788 must be coordinated and installed during the same * * maintenance window. * * * * * ************************************************************************** Patch Components: ----------------- Files & Fields Associated: -------------------------- File Name (Number) Field Name New/Modified/Deleted ------------------ ---------- -------------------- SDEC APPOINTMENT (#409.84) CHECK-IN STEP STATUS (#.01) New DATE/TIME ENTERED (#1) New SDEC CHECK-IN STEP STATUS CHECK-IN STEP STATUS (#.01) New (#409.842) SDEC SETTINGS (#409.98) CURRENT GUI VERSION (#2) Modified GUI VERSION EFFECTIVE DATE (#3) Modified 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 ----------- ---- -------------------- SDEC MRTC CHILD CLEANUP Routine New SDECRPC Menu Modified SDSUP Menu Modified 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 --------------------- -------------------- SDES GET APPT New SDES GET APPTS BY CLINIC New SDES GET APPTS BY PATIENT New SDES GET APPTS BY RESOURCE New SDES GET APPT CHECK-IN STEP New SDES GET APPT CHECK-IN STEPS New SDES SET APPT CHECK-IN STEP New SDES GET CHECK-IN STEP New SDES GET CHECK-IN STEPS New SDES SET CHECK-IN STEP New SDES EDIT CHECK-IN STEP New Parameter Definitions Associated: --------------------------------- N/A Defect Tracking System Ticket(s) & Overview: -------------------------------------------- JIRA tasks: ----------- 1) Jira #VSE-57: Changes made to User Preferences are not updating in the RM Grid. Problem: Changes made to User Preferences are not updating in the RM Grid. Resolution: The data in the RM Grid will match the User Preference setting. Changes will be saved and updated in the User Preference menu. The Clear button resets User Preferences and the RM Grid columns to the default sort order. 2) Jira #VSE-775 Create Remote Procedure Call (RPC) SDES Get Appointment List by Patient. Problem: Need to create a new SDES RPC to return an appointment list by patient and start/end date. Resolution: The new SDES APPT BY CLINIC JSON was created and will return it data in JSON format. Returned data includes: string ResourceName (Clinic name) string Notes string Duration string StartTime (appointment date time) string EndTime string AppointmentID string AppointmentTypeIEN bool IsOverbook 3) Jira #VSE-776 - Create RPC SDES Get Appointment List by Clinic. Problem: Need to create a new SDES RPC to return an appointment list by clinic and start/end date. Resolution: The new SDES APPT BY CLINIC JSON was created and will return it data in JSON format. Returned data includes: Appointment fields to return: string ResourceName (Clinic name) string Notes string Duration string StartTime (appointment date time) string EndTime string AppointmentID string AppointmentTypeIEN bool IsOverbook 4) Jira #VSE-777 - Create RPC SDES Get Appointment. Problem: Need to create a new SDES RPC to get a single appointment by SDEC APPOINTMENT IEN. Resolution: The new SDES GET APPT JSON was created and will return it data in JSON format. Returned data includes: Appointment fields to return: string ResourceName (Clinic name) string Notes string Duration string StartTime (appointment date time) string EndTime string AppointmentID string AppointmentTypeIEN bool IsOverbook 5) Jira #VSE-787: Prompt scheduler to verify patient contact information. Problem: Prompt the schedule to verify auto-filled patient contact information when creating a video appointment from VS, so that appointment information is sent to the right email/number. Resolution: Scheduler is prompted to confirm that the auto-filled email address/phone number(s) in the Make Video Visit window is correct. 6) Jira #VSE-788: Add zip code field to Make Video Visit screen. Problem: Display patient's zip code on the Make Video Visit screen to know patient's location. Resolution: Patient's zip code is displayed on the Make Video Visit screen. 7) Jira #VSE-789: Include option to receive Video Visit Service (VVS) link via text. Problem: Indicate when making a video appointment from VS that the patient/provider prefers to receive the video link via email, text message, or both. Resolution: Added ability to indicate a patient's preferred contact method (email or SMS). 8) Jira #VSE-792: Update tooltips to reflect most-used name for RM Grid. Problem: Tool buttons tooltips display "Wait List" instead of "RM Grid" or "Facility/Default View" (e.g. "Export Wait List") Resolution: Renamed each to accurate label. 9) Jira #VSE-793: Consolidate Appointment window to one tab. Problem: View/New Appointment modal dialog displays a single tab. Resolution: Consolidated Appointment window to one tab. 10) Jira #VSE-794: Update expand/collapse icon on time slot viewer. Problem: Time Slot Viewer expand/collapse icon opposes behavior. Resolution: Display correct icons when collapsed and expanded. 11) Jira #VSE-795: Loading dialog has duplicate word. Problem: Clicking a Pending Appointment displays "Loading Clinic Schedule Schedule". Resolution: Renamed to "Loading Clinic Schedule". 12) Jira #VSE-801: Improve error handling on Make VVS Appointment. Problem: Improve error handling for ICN Error, Access Error, and Timeout/VVS system down error. Resolution: A window was created to handle errors so that the system message box is not required to display errors to users. 13) Jira #VSE-802: Error Window. Problem: Create a window to handle errors so that the system message box is not required to display errors to users. Resolution: A window was created to handle errors so that the system message box is not required to display errors to users. 14) Jira #VSE-804: Add contact method preferences to VVS Make Appointment screen - Patient. Problem: Add ability to indicate a patient's preferred contact method (email or SMS). Resolution: Email for patient is no longer required. Email or SMS is acceptable. Add a message explaining that email and/or SMS will be sent if contact info is provided. 15) Jira #VSE-805: Add contact method preferences to VVS make appointment screen - Provider. Problem: Add ability to indicate a provider's preferred contact method (email or SMS). Resolution: For providers, email is the required method of communication. If there is a cell phone number, then an SMS will be sent in addition to the email. This behavior will be described in a text label. 16) Jira #VSE-861: Formalize JSON Return Errors. Problem: Fix JSON returns to follow new JSON return pattern. Resolution: JSON returns follow new JSON return pattern. 17) Jira #VSE-863 - Updates/corrections to PtCSch code. Problem: Updates/corrections to PtCSch code based on work done as part of VSE-737 Resolution: VS GUI was updated to utilize the optimized VistA RPCs associated with the work done in a prior sprint related to VSE-737 and released in SD*5.3*785. 18) Jira #VSE-876: Develop option to identify stuck MRTCs and disposition. Problem: A new menu option is needed to clean up those MRTC children where the parent has been dispositioned and closed, but the child was left open. Resolution: A new menu option, SDEC MRTC CHILD CLEANUP ("Stuck MRTC child cleanup tool") was created. The tool will go through all open return to clinic requests that are MRTCs with a PID less than or equal to the date-90 days (or user entered date which is no sooner than -90 days). If the Parent is closed and dispositioned the child request will be closed and assigned the disposition based on the parent's disposition. 19) Jira #VSE-875: Update GUI logic for MRTC PIDs so that they are static based on parent PID. Problem: MRTC PID dates should NOT be based on appointment made. PID should be static. Resolution: MRTC PIDs are static based on parent PID. 20) Jira #VSE-876 - Develop option to identify stuck MRTCs and disposition. Problem: A new menu option is needed to clean up those Multiple Return to Clinic (MRTC) children where the parent has been dispositioned and closed, but the child was left open. Resolution: A new menu option, SDEC MRTC CHILD CLEANUP ("Stuck MRTC child cleanup tool") was created. The Tool will go through all open return to clinic requests that are MRTCs with a PID less than or equal to the date-90 days (or user entered date which is no sooner than -90 days). If the Parent 21) Jira #VSE-877: Update screens where buttons/fields/words are cut off. Problem: Content is cut off in GUI screens. Resolution: Updated screens where content was cut off. 22) Jira #VSE-884: Update GUI so that request already dispositioned/canceled is not dispositioned again. Problem: Update GUI so that an MRTC request already dispositioned is not dispositioned again when MRTCs are dispositioned in bulk. Resolution: GUI was updated so that an already dispositioned MRTC request is not dispositioned again. 23) Jira #VSE-886 - Formalize JSON Return Errors - SDEC RPCs. Problem: There needs to be a unified way to log errors and return JSON formatted data objects to the VS GUI. Resolution: Two new Application Program Interfaces (APIs) were created in VistA. One if for logging errors and the other for reporting back data. The Error API standardized the text for the return messages and allows additional information to be added to the standard messages if needed. The Data API will always return and object, even if there were no corresponding records found. 24) Jira #VSE-942: Fix null reference error when using Hotkeys for switching Calendar's View style. Problem: The GUI occasionally crashes when trying to update the calendar after a user enters shift + either D, W, M or T. These correspond to the hotkeys used in the GUI for quickly switching the calendar between the Day, Week, Month and Timeline views. Resolution: Added null check to the HotKey Events method to avoid null reference exception. 25) Jira #VSE-946: Formalize JSON Return Errors. Problem: Fix JSON returns created over last several sprints to follow new JSON return pattern. Resolution: Updated error messages for JSON RPC calls to use new VSE error window. 26) Jira #VSE-1016 - Add CHECK-IN STEP STATUS field to 409.84. Problem: To support CTO's work on VSIP, we need to add a check-in step status field to the appointment file. Resolution: The new CHECK-IN STEP STATUS (#3) multiple was added to the SDEC APPOINTMENT (#409.84) file. This multiple has 2 fields: CHECK-IN STEP STATUS (#.01) and DATE/TIME ENTERED (#1). 27) Jira #VSE-1017 - Create SDES RPC to set value CS(IEN, value). Problem: Create a SDES RPC to set the check-in step status in the newly created check-in step status file (VSE-1016) by SDEC APPOINTMENT file IEN. Ensure this can only be done for non-cancelled appointments. Resolution: The new SDES EDIT CHECK-IN ENTRY RPC was created and will return it data in JSON format. 28) Jira #VSE-1020 - Create SDES RPC to get value CS(IEN). Problem: Create a SDES RPC to get the check-in step status in the newly created check-in step status multiple (VSE-1016) by SDEC APPOINTMENT file IEN and the check-in step status IEN. Return JSON of the check-in step status entry and date/time entry. If it doesn't exist in that multiple, return null/0. Resolution: The new SDES GET CHECK-IN STATUS RPC was created and will return it data in JSON format. 29) Jira #VSE-1022 - Create new pre-check-in status file. Problem: Create new check-in step status file with a field to track the check in statuses. Resolution: The new SDEC CHECK-IN STEP STATUS (#409.842) file was created to store the necessary statuses related to check-ins. 30) Jira #VSE-1128 - Update RPC SDES Get Appointment List by Patient. Problem: Additional pieces of data need to be returned to assist processing in the VS GUI. Resolution: The needed data was identified in VistA and the SDES GET APPT LIST BY PAT JSON was updated to include this data in the JSON object returned to VS GUI. 31) Jira #VSE-1129 - Update RPC SDES Get Appointment List by Clinic. Problem: Additional pieces of data need to be returned to assist processing in the VS GUI. Resolution: The needed data was identified in VistA and the SDES APPT BY CLINIC JSON was updated to include this data in the JSON object returned to VS GUI. 32) Jira #VSE-1130 - Update RPC SDES Get Appointment. Problem: Additional pieces of data need to be returned to assist processing in the VS GUI. Resolution: The needed data was identified in VistA and the SDES GET APPT JSON was updated to include this data in the JSON object returned to VS GUI. 33) Jira #VSE-1114 - Ad-hoc execution for Test Save Multiple User Preference Configurations. Problem: Create RPC to get all check-in statuses for an appt in the check-in step status multiple. Resolution: A new RPC, SDES GET CHECK-IN STATUSES, has been created to retrieve all check-in statuses associated with an appointment. 34) Jira #VSE-1115 - Ad-hoc execution for Test Updates/corrections to PtCSch code. Problem: Create RPC to add a new entry to the new check-in step status file (409.842). Resolution: A new RPC, SDES CREATE CHECK-IN ENTRY, has been created to add a new entry(status) to the new check-in step status file. 35) Jira #VSE-1116 - Add CHECK-IN STEP STATUS field to 409.84. Problem: Create RPC to edit entry in 409.842 (check-in step status file). Resolution: A new RPC, SDES EDIT CHECK-IN ENTRY, has been created to edit entries(statuses) in the new check-in step status file. 36) Jira #VSE-1117 - Create SDES RPC to set value CS(IEN, value). Problem: Create RPC to get all check-in entries in the check-in step status file. Resolution: A new RPC, SDES GET ALL CHECK-IN ENTRIES, has been created to retrieve all the entries from the new check-in step status file. 37) Jira #VSE-1118 - Update "Print the Patient Letter." message to new format. Problem: Create RPC to get a single entry from the check-in step status file (409.842). Resolution: A new RPC, SDES GET CHECK-IN ENTRY, has been created to retrieve a single entry from the new check-in step status file. Test Sites: ----------- Amarillo, TX Detroit, MI El Paso, TX Software and Documentation Retrieval Instructions: ---------------------------------------------------- Software is distributed by PackMan message and MSI software. NOTE: There are two installation files. The file titled VISTASCHEDULINGGUIINSTALLER_1_7_8_2_P.MSI is the production VS GUI installation file. The file titled VISTASCHEDULINGGUIINSTALLER_1_7_8_2_T.MSI is the preproduction VS GUI file. Other Software Files: This release also includes documentation and other software files. They can be obtained at: https://download.vista.domain.ext/index.html/SOFTWARE/ Documentation Title File Name FTP Mode -------------------------------------------------------------------------- VS GUI R1.7.8.2 INSTALLER VISTASCHEDULINGGUIINSTALLER_1_7_8_2_P.MSI Binary VS GUI R1.7.8.2 INSTALLER VISTASCHEDULINGGUIINSTALLER_1_7_8_2_T.MSI Binary VS GUI R1.7.8.2 VDD VS_GUI_1_7_8_2 VDD Binary VS GUI R1.7.8.2 DIBR VS_GUI_1_7_8_2 DIBR Binary VS GUI R1.7.8.2 Release Notes VS_GUI_1_7_8_2 RN Binary VS GUI R1.7.8.2 Technical Manual VS_GUI_1_7_8_2 TM Binary VS GUI R1.7.8.2 User Guide Addendum VS_GUI_1_7_8_2_UG_ADD Binary PIMS Technical Manual PIMS_TM Binary Documentation describing the new functionality is included in this release. Documentation can be found on the VA Software Documentation Library at: https://www.domain.ext/vdl/ Patch Installation: ------------------- GUI Installation Instructions: ------------------------- Sites using the System Center Configuration Manager (SCCM) push process for installations can find the build documents in the following locations: - CMCB Build Document (Production): https://vaww.eie.domain.ext/SysDesign/CS/DTStatus/SitePages/Build%20Documents. aspx?pid=216 - CMCB Build Document (Test): https://vaww.eie.domain.ext/SysDesign/CS/DTStatus/SitePages/Build%20Documents. aspx?pid=228 Sites that employ the VistA Consolidated Server (VACS) installation process will be alerted to the new GUI via an action item from Office of Information and Technology (OIT) Information Technology Operations and Services (ITOPS). Follow the detailed instructions in the Action Item email for VACS installation. The IO HBMC FO Application Division will lead and coordinate deployment activities with EUO, Client Technology, Citrix Back Office, and Area Managers, and other OIT and business partners as required. The released software package is available at: https://download.vista.domain.ext/index.html/SOFTWARE Implementation Manager Point of Contact: Name: Yoojin Lee Phone: 206-277-4608 Email: Yoojin.Lee@domain.ext Pre/Post Installation Overview: ------------------------------- Routine SDEC788P will update SDEC SETTINGS (#409.98) FILE. Routine will run at the end of patch installation process. Pre-Installation Instructions: ------------------------------ N/A Setup/Configuration 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 recommended that this patch be queued. 1. Choose the PackMan message containing this patch. 2. Choose the INSTALL/CHECK MESSAGE PackMan option. 3. From the KIDS Menu, select the Installation Menu. From this menu, you may elect to use the following options. When prompted for the INSTALL NAME, enter SD*5.3*788. a. Backup a Transport Global - This option will create a backup message of any components exported with this patch. You are prompted to select "R" for Routines or "B" for Build. For this patch, backing up the "B"uild is suggested. Select one of the following: B Build R Routines Enter response: Build b. Compare Transport Global to Current System - This option will allow you to view all changes that will be made when this patch is installed. It compares all components of this patch (routines, DDs, templates, etc.). c. Verify Checksums in Transport Global - This option will allow you to ensure the integrity of the routines that are in the transport global. 4. From the Installation Menu, select the Install Package(s) option and when prompted for the INSTALL NAME, enter SD*5.3*788. 5. If prompted 'Want KIDS to Rebuild Menu Trees Upon Completion of Install? NO//' respond NO. 6. When prompted "Want KIDS to INHIBIT LOGONs during the install? NO//" respond NO. 7. If prompted "Want to DISABLE Scheduled Options, Menu Options, and Protocols? NO//" respond NO. 8. If prompted "Delay Install (Minutes): (0 - 60): 0//" respond 0. Post-Installation Instructions: ------------------------------- Post install routine SDEC788P will automatically run at the end of the installation process. After the post install has finished running, sites can delete the SDEC788P routine using the Delete Routines [XTRDEL] if they wish. Back-Out Plan/Roll Back Plan: ----------------------------- Install the backup message created during the installation of SD*5.3*788. The VS GUI NATIONAL and VS GUI LOCAL entries in the SDEC SETTINGS (#409.98) file needs to be reverted to 1.7.7. If 1.7.8.2 VS GUI was installed, it will need to be reverted to VS GUI 1.7.7. See Deployment, Installation, Back Out and Rollback Guide (DIBR) https://download.vista.domain.ext/index.html/SOFTWARE/VS_GUI_1_7_8_2_ DIBR.pdf. Routine Information: ==================== The second line of each of these routines now looks like: ;;5.3;Scheduling;**[Patch List]**;Aug 13, 1993;Build 6 The checksums below are new checksums, and can be checked with CHECK1^XTSUMBLD. Routine Name: SDEC07 Before:B176113316 After:B181314236 **627,642,651,658,665,669,671, 672,701,686,740,694,785,788** Routine Name: SDEC52CJSON Before: B45928218 After: B43856140 **784,785,788** Routine Name: SDEC788P Before: n/a After: B1888172 **788** Routine Name: SDECAR4 Before:B117464535 After:B127585078 **784,785,788** Routine Name: SDECCONSJSON Before: B30391755 After: B29675665 **784,785,788** Routine Name: SDECRTCF2 Before: n/a After: B26425770 **788** Routine Name: SDECVVS Before: B30381980 After: B36117901 **781,784,785,788** Routine Name: SDES Before: n/a After: B1116614 **788** Routine Name: SDESAPPT Before: n/a After: B24560891 **788** Routine Name: SDESAPPTDATA Before: n/a After: B11227759 **788** Routine Name: SDESCKNSTEP Before: n/a After: B42608501 **788** Routine Name: SDESCLINICDATA Before: n/a After: B1494050 **788** Routine Name: SDESJSON Before: n/a After: B10818891 **788** Routine Name: SDESPATIENTDATA Before: n/a After: B2076864 **788** Routine list of preceding patches: 785 ============================================================================= User Information: Entered By : Date Entered : MAY 19, 2021 Completed By: Date Completed: JUL 26, 2021 Released By : Date Released : JUL 26, 2021 ============================================================================= Packman Mail Message: ===================== $END TXT