$TXT Created by G at CHY0017D.FO-BAYPINES.DOMAIN.EXT (KIDS) on Wednesday, 02/15/23 at 11:53 ============================================================================= Run Date: MAR 02, 2023 Designation: SD*5.3*836 Package : SD - SCHEDULING Priority: Mandatory Version : 5.3 SEQ #689 Status: Released Compliance Date: MAR 15, 2023 ============================================================================= Associated patches: (v)SD*5.3*835 <<= must be installed BEFORE `SD*5.3*836' Subject: VS GUI VERSION 1.7.38.0 Category: - Routine - Enhancement (Mandatory) Description: ============ VistA Scheduling (VS) Graphical User Interface (GUI) Release 1.7.38.0 and SD*5.3*836 includes several defect corrections and enhancements including the retirement of the SDES GET APPTS BY CLINIC LIST and SDES GET APPTS BY PATIENT DFN2 Remote Procedure Calls (RPCs). The new SDES GET CLINIC ORIGINAL AVAIL RPC was created to return an unmodified version of a clinic's appointment slots. Unlike, SDEC APPTSLOTS which decrements the availability to indicate that appointments have been made, this RPC will only return the original, unmodified copy of the days schedule. Checks for locks were added to the SDECAR routine which is called when the VS GUI sends Health Level-7 (HL7) messages to update an order. Additional fields were added to the returned JSON object for the SDES SEARCH CLINIC RPC. The code supporting the SDES CHECKOUT and SDES UNDO CHECKOUT RPCs was updated by removing the check for the SD SUPERVISOR key. The new SDES GET CLINIC STOPCD RPC was created and was added to the SDESRPC option. The new SDES GET CANCEL REASONS RPC was created and was added to the SDESRPC option. The new SDES GET COMP/PEN 2507 RPC was created and was added to the SDESRPC option. The new SDES SET COMP/PEN AMIE TRKNG RPC was created and was added to the SDESRPC option. The VS GUI logic was updated to look for error codes being returned from RPC calls and displayed that error message to the disposition process. The SDES SEARCH RECALL CLINICS RPC was updated return a list of recall clinics to assist schedulers when creating a recall request. SDES GET APPT CHECK-IN STEPS was retired as part of patch SD*5.3*828; however, GUI is still calling it. We need to have GUI call SDES GET APPT CHECK-IN STEPS 2 instead. The SDEC GET REQ BY TYPE VET JSON RPC was updated to send back an empty JSON object when there is no matching data for the input criteria. The SDES GET APPTS BY CLINIEN LIST and SDES GET APPTS BY CLIN LIST2 RPCs were updated return back today's appointment based on the clinic's time zone. The SDBUILD security key was added to the SDBUILD menu option. The SDES CREATE CLINIC and SDES EDIT CLINIC RPCs were updated to include the telephone extension in their returned JSON object. The SDES GET CLINIC INFO2 RPC was updated to include the telephone extension in their returned JSON object. ************************************************************************** * GUI UPDATE NOTICE * * ---------------------------------------------------------------------- * * This patch MUST be installed before the GUI update for release * * 1.7.38.0 of VS is installed. * * * * * * The previous version of the VS GUI will not operate after this * * patch is installed. Therefore, VS GUI V1.7.38.0 and VistA patch * * SD*5.3*836 must be coordinated and installed during the same * * maintenance window. * * * * * ************************************************************************** Patch Components: ----------------- Files & Fields Associated: New/Modified/Deleted -------------------------- -------------------- SDES ERROR CODES New errors being Modified (#409.93) deployed File Name (Number) Field Name 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 ----------- ---- -------------------- SDBUILD Run Routine Modified SDECRPC Broker Modified SDESRPC Broker 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 ------------- ----------------------- -------------------- Remote Procedures Associated: ----------------------------- Remote Procedure Name New/Modified/Deleted --------------------- -------------------- SDES CREATE CLINIC Modified SDES EDIT CLINIC Modified SDES GET APPTS BY CLIN LIST2 Modified SDES GET APPTS BY CLINIC LIST Deleted SDES GET APPTS BY CLINIEN LIST Modified SDES GET APPTS BY PATIENT DFN2 Deleted SDES GET CANCEL REASONS New SDES GET CLINIC INFO2 Modified SDES GET CLINIC ORIGINAL AVAIL New SDES GET CLINIC STOPCD New SDES GET COMP/PEN 2507 New SDES SEARCH CLINIC Modified SDES SEARCH RECALL CLINICS Modified SDES SET COMP/PEN AMIE TRKNG New Parameter Definitions Associated: --------------------------------- N/A Defect Tracking System Ticket(s) & Overview: -------------------------------------------- JIRA tasks: =========== 1) VSE-4159: VistA - Retire RPCs post release of SD*5.3*824. Problem: Need to retire the obsolete SDES GET APPTS BY CLINIC LIST and SDES GET APPTS BY PATIENT DFN2 RPCs. Resolution: The SDES GET APPTS BY CLINIC LIST and SDES GET APPTS BY PATIENT DFN2 RPCs will be deleted at the sites and removed from the SDECRPC and SDESRPC options. 2) VSE-4162: VistA - Display original clinic availability once some or all availability is consumed. Problem: Need the ability to allow the user can create clinic availability then add appointments that consume some or all of the original clinic availability then display the availability prior to any of the availability being consumed by appointments. Resolution: The new SDES GET CLINIC ORIGINAL AVAIL RPC was created to will return an unmodified version of a clinic's appointment slots. Unlike, SDEC APPTSLOTS which decrements the availability to indicate that appointments have been made, this RPC will only return the original, unmodified copy of the days schedule. 3) VSE-4559: VistA: Lock down the VistA menu options with the new SDBUILD key. Problem: Need to lock down the VistA menu options with the new SDBUILD key.This key will be used by the CCM application to lock down the Set Up A Clinic menu option in VistA. Resolution: The SDBUILD security key was added to the SDBUILD menu option. 4) VSE-4589: VistA - Any time VS GUI sends hl7 to update order, first check for lock on the order. Problem: There is a long-standing issue with orders (file 100) getting stuck in PENDING or PARTIAL RESULTS status, although the corresponding request(s) have been dispositioned (can be as Removed/Scheduled - Assigned or any of the other disposition reasons). We partially addressed this in a prior patch by checking for an OR/CPRS lock, but it seems that there is some other lock in use. This can be replicated as follows: 1. Create MRTC from CPRS 2. Schedule at least one appointment from the MRTC (but don't schedule all) 3. Lock order (I did this by going in to edit it from VistA) 4. Disposition the parent request Resolution: Checks for locks was added to the SDECAR routine to address this issue. 5) VSE-4701: VistA - Modify SDES SEARCH CLINIC to add additional fields in return. Problem: CCM needs additional fields to be returned from the SDES SEARCH CLINIC RPC. The fields needed are: Active <- Call INACTIVE^SDESUTIL to determine clinic status nonCount <- This is field 2502 NON-COUNT CLINIC? primary AMIS Stop Code <- Call STOPCODETOAMIS^SDESUTIL to determine AMIS Number secondary AMIS Stop Code <- Call STOPCODETOAMIS^SDESUTIL to determine AMIS Number patient friendly name <- This is field 60 PATIENT FRIENDLY NAME Resolution: These fields were added to the returned JSON object for the SDES SEARCH CLINIC RPC. 6) VSE-4706: VistA - Modify SDES CHECKOUT and SDES UNDO CHECKOUT to not require the SD SUPERVISOR key. Problem: SDES CHECKOUT currently fails if the VistA user in context does not have the SD SUPERVISOR key. In our case (Acheron), it always fails because the NEW PERSON record for the Acheron user won't have that key. Acheron team identified they have the same issue with SDES UNDO CHECKOUT so we need to make the same change to SDES UNDO CHECKOUT. The RPC needs to be changed to not require a security key since it's been discussed that it will be the responsibility of the service using Acheron Enterprise Appointment Services (EAS) to make that access control decision. Resolution: The code supporting the SDES CHECKOUT and SDES UNDO CHECKOUT RPCs was updated by removing the check for the SD SUPERVISOR key. 7) VSE-4711: VistA - Rewrite SDEC CLINSTOP in the SDES namespace. Problem: Need to rewrite SDEC CLINSTOP in the SDES namespace utilizing the latest coding standards and returning data as a JSON object. Add to SDESRPC menu option. This should allow ISS users to search for a service/specialty and get a list of results. Resolution: The new SDES GET CLINIC STOPCD RPC was created and was added to the SDESRPC option. 8) VSE-4723: VistA - Rewrite SDEC CANREAS in the SDES menu option. Problem: Need to rewrite the SDEC CANREAS in the SDES namespace utilizing the latest coding standards and returning data as a JSON object. Add to SDESRPC menu option. This should return a list of cancellation reasons (file 409.2). Resolution: The new SDES GET CANCEL REASONS RPC was created and was added to the SDESRPC option. 9) VSE-4735: VistA - Rewrite SDECCAP GET in SDES namespace. Problem: Need to rewrite SDECCAP GET in the SDES namespace utilizing the latest coding standards and returning data as a JSON object. Add to SDESRPC menu option. Resolution: The new SDES GET COMP/PEN 2507 RPC was created and was added to the SDESRPC option. 10) VSE-4736: VistA - Rewrite SDECCAP SET in the SDES namespace. Problem: Need to rewrite SDECCAP SET in the SDES namespace utilizing the latest coding standards and returning data as a JSON object. Add to SDESRPC menu option. Resolution: The new SDES SET COMP/PEN AMIE TRKNG RPC was created and was added to the SDESRPC option. 11) VSE-4765: VS GUI - Support and Implementation for AR Close Responses Containing Locked Notification/Errors. Problem: When AR Close is being called a locked error was being thrown but ignored by GUI. Need GUI to possibly take action on AR Close responses containing locked notifications/errors. Resolution: The VS GUI logic was updated to look for error codes being returned from RPC calls and displayed that error message to the disposition process. 12) VSE-4779 - VistA: Modify SDES SEARCH RECALL CLINICS. Problem: Need to modify SDES SEARCH RECALL CLINICS to return a list of recall clinics so that when creating a recall request you can specify the recall clinic the request is for. Resolution: The SDES SEARCH RECALL CLINICS RPC was updated return a list of recall clinics to assist schedulers when creating a recall request. 13) VSE-4848: VS GUI: SDES GET APPT CHECK-IN STEPS RPC causing error in VS GUI. Problem: SDES GET APPT CHECK-IN STEPS was retired as part of patch SD*5.3*828; however, GUI is still calling it. We need to have GUI call SDES GET APPT CHECK-IN STEPS 2 instead. Resolution: VS GUI 1.7.38.0 was updated to utilize the SDES GET APPT CHECK-IN STEPS 2. 14) VSE-4855: VistA: When viewing list of VETERAN Requests and there are none GUI is returning an error. Problem: The return JSON object from the SDEC GET REQ BY TYPE VET JSON RPC is telling the GUI that there was an issue. The JSON object should be just been an empty object with no data. So, the GUI is stating there was a problem. In actuality, no data is missing and there really isn't a data problem or GUI problem. Resolution: The SDEC GET REQ BY TYPE VET JSON RPC was updated to send back an empty JSON object when there is no matching data for the input criteria. 15) VSE-4874: VistA: Update SDES GET APPTS BY CLIN LIST2 and SDES GET APPTS BY CLINIEN LIST. Problem: Update SDES GET APPTS BY CLINIEN LIST and SDES GET APPTS BY CLIN LIST2 to convert vista time zone to clinic time zone and send appointments for the given clinics in the time zone of those clinics (following conversion from Vista time zone). Resolution: The SDES GET APPTS BY CLINIEN LIST and SDES GET APPTS BY CLIN LIST2 RPCs were updated return back today's appointment based on the clinic's time zone. 16) VSE-4907: VistA: Modify SDES CREATE CLINIC and SDES EDIT CLINIC to specify the telephone extension. Problem: Need to modify SDES CREATE CLINIC and SDES EDIT CLINIC to specify the telephone extension. Resolution: The SDES CREATE CLINIC and SDES EDIT CLINIC RPCs were updated to include the telephone extension in their returned JSON object. 17) VSE-4908: VistA: Modify SDES GET CLINIC INFO2 to return clinic phone extension. Problem: Need to modify SDES GET CLINIC INFO2 to return clinic phone extension. Resolution: The SDES GET CLINIC INFO2 RPC was updated to include the telephone extension in their returned JSON object. Test Sites: ----------- Salt Lake City, UT (SLC) Honolulu, HI (HON) 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_38_0_P.MSI is the production VS GUI installation file. The file titled VISTASCHEDULINGGUIINSTALLER_1_7_38_0_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.38.0 INSTALLER VISTASCHEDULINGGUIINSTALLER_1_7_38_0_P.MSI Binary VS GUI R1.7.38.0 INSTALLER VISTASCHEDULINGGUIINSTALLER_1_7_38_0_T.MSI Binary VS GUI R1.7.38.0 VDD VS_GUI_1_7_38_0 VDD Binary VS GUI R1.7.38.0 DIBR VS_GUI_1_7_38_0 DIBR Binary VS GUI R1.7.38.0 Release Notes VS_GUI_1_7_38_0 RN Binary VS GUI R1.7.38.0 Technical Manual VS_GUI_1_7_38_0 TM 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 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 VistA Consolidated Server (VACS) installation. The Information Operations (IO) HBMC Field Operations (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 Release Manager Point of Contact: Name: Stevens Jack Phone: 772-646-2303 Email: jack.stevens1@domain.ext Pre/Post Installation Overview: ------------------------------- Routine SDES836P will update SDEC SETTINGS (#409.98) file. Routine will run at the end of patch installation process. The post install will also create the new REQPTR x-ref in SDEC CONTACT (#409.86) file. 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 10 minutes to install. 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*836. 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*836. 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 SDES836P will automatically run at the end of the installation process. After the post install has finished running, sites can delete the SDES836P 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*836. The VS GUI NATIONAL and VS GUI LOCAL entries in the SDEC SETTINGS (#409.98) file needs to be reverted to 1.7.37. If 1.7.38.0 VS GUI was installed, it will need to be reverted to VS GUI 1.7.37.0. See Deployment, Installation, Back Out and Rollback Guide (DIBR) https://download.vista.domain.ext/index.html/SOFTWARE/VS_GUI_1_7_38_0_ DIBR.PDF. Routine Information: ==================== The second line of each of these routines now looks like: ;;5.3;Scheduling;**[Patch List]**;Aug 13, 1993;Build 20 The checksums below are new checksums, and can be checked with CHECK1^XTSUMBLD. Routine Name: SDECAR4 Before:B155979383 After:B155195782 **784,785,788,805,813,826,833, 835,836** Routine Name: SDES Before:B115642867 After:B115868397 **788,790,792,794,797,799,800, 801,803,804,805,807,809,813, 814,815,818,819,824,825,826, 836** Routine Name: SDES01C Before: B10168681 After: B18866318 **790,807,836** Routine Name: SDES836P Before: n/a After: B2416769 **836** Routine Name: SDESAPPT4 Before:B149023110 After:B153968156 **824,828,836** Routine Name: SDESCANCELRSNS Before: n/a After: B7573346 **836** Routine Name: SDESCHECKOUT Before:B190353992 After:B189532605 **826,827,836** Routine Name: SDESCLINDAILYSCH Before: n/a After: B16405108 **836** Routine Name: SDESCLINICSET Before:B212546710 After:B217550860 **799,805,820,824,825,831,835,836** Routine Name: SDESCOMPPEN Before: n/a After: B42390389 **836** Routine Name: SDESGETSTOPCD Before: n/a After: B4865855 **836** Routine Name: SDESRTVCLN2 Before:B115455228 After:B117996215 **823,825,827,828,833,836** Routine Name: SDESSEARCHRCLN Before: n/a After: B35429209 **836** Routine Name: SDESUNDOCHECKOUT Before: B15251040 After: B15876281 **831,836** Routine Name: SDESUTIL Before: B63229611 After: B66653412 **801,804,805,814,816,818,820, 823,824,825,831,836** Routine list of preceding patches: 835 ============================================================================= User Information: Entered By : Date Entered : JAN 17, 2023 Completed By: Date Completed: MAR 02, 2023 Released By : Date Released : MAR 02, 2023 ============================================================================= Packman Mail Message: ===================== $END TXT