Transcription
Department of Veterans AffairsVistA Scheduling Enhancements (VSE)Enhancement 1: An Aggregated View of VistA Clinic ProfileScheduling Grids for VistA SchedulingEnhancement 2: A Single Queue for Appointment RequestsSD*5.3*627SD*5.3*642Enhancement 3: Resource Management ReportingSD*5.3*628Additional EnhancementsVS GUISD*5.3*658Technical ManualJanuary 2017Version 6.2
Revision dressed HPS reviewer comments.Added version number to title page; addedalt text to all tables and figures; updatedsection 2.3E. Phelps, TW01/18/20176.1Updated per VA comments: Table 3headers and replaced images with text,Table 4 info, Section 3 notes, added alttext to figuresC. Ruiz, GUI DevE. Phelps, TW12/21/20166.0Technical edit for submission: formattingand consistency; updated table numbers,TOC and footersE. Phelps, TW12/14/20165.2Updates for SD*5.3*658: Added routinesto section 2.4 Routine Table; added crossreferences to section 2.6 VistA SchedulingGUI Cross References; revised files insection 2.7 Table File; added parametersto section 2.12 Parameter DefinitionsS. Thimmes, M Dev11/28/20165.1S. Thimmes, M DevUpdates for SD*5.3*658: Added routinesto section 2.4 Routine Table; added files tosection 2.7 Table File; added parametersto section 2.12 Parameter Definitions;added security key to section 2.13Security Keys12/03/20155.0Document SubmissionD. Vick, PM11/30/20154.2TW Format and Edit PerformedG. Scorca, Sr. TW11/12/20154.1Updated Document for OT4 FunctionalityS. Thimmes10/29/20154.0Document SubmissionD. Vick, PM10/28/20153.2TW Format and Edit PerformedG. Scorca, Sr. TW10/22/20153.1Updated Document for OT3 FunctionalityS. Thimmes05/31/20153.0Document submissionD. Vick, PM;E. Crean, TW05/28/20152.2Updated Request ManagementinformationB. Gibbons, Dev;S, Thimmes, Dev04/8/20152.1Updated Security Key informationE. Crean, TW03/22/20152.0Document submissionD. Vick, PM;G. Scorca, TW03/20/20151.2Updated content for patch SD*5.3*627S. Thimmes, Dev.;G. Scorca, TWVistA Scheduling Enhancements (VSE)Technical ManualiiJanuary 2017
ted Enhancement 3(SD*5.3*628) content and formatteddocumentC. Rodriguez, Dev.;C. Jan, BA;G. Scorca, TWM. Colyvas, TW01/23/20151.0Initial version for submissionD. Vick, PM;M. Woehrle, PM;F. Struble, Dev.;C. Jan, Sr. BA;E. Crean, TW;G. Scorca, TWVistA Scheduling Enhancements (VSE)Technical ManualiiiJanuary 2017
Table of Contents1.Overview . 11.1. Security. 11.2. Rules of Behavior . 11.3. Orientation. 12.Implementation and Maintenance . 22.1. System Requirements . 22.2. Package-Wide Variables. 22.3. Menu Diagram . 22.4. Routines . 22.5. Files and Tables . 82.5.1. File Access . 92.5.2. Client Application Dependencies and Files. 102.5.2.1. VistA Scheduling GUI Trace Log . 122.5.2.2. Request Management . 142.6. VistA Scheduling GUI Cross References. 162.7. Table File . 332.8. Internal Relations . 952.9. External Relations. 952.10.Published Entry Points. 952.11.Exported Option . 952.12.Parameter Definitions . 962.13.Security Keys . 962.14.Archiving and Purging . 973.Resource Management Reporting Implementation . 983.1. System Requirements . 983.2. Application Files . 983.3. Resource Management Reporting Java Application Build Process. 993.4. Data Flow Diagram. 1003.5. Implementation of Report Filters . 1003.6. Resource Management Reporting Application Functions . 1013.6.1. Report Filter Functionality . 1013.6.2. Java Classes Implementation . 1033.6.3. Report Viewer Functionality . 1043.6.4. Report Viewer Error Handling and Resolution . 1053.6.4.1. Invalid Folder or Folder Does Not Exist . 1053.6.4.2. Missing Source Data File (SDEC VSE.xml) . 1063.6.4.3. Java Application Exception Error Logs . 107VistA Scheduling Enhancements (VSE)Technical ManualivJanuary 2017
4.Generating Online Documentation . 1084.1.4.2.4.3.4.4.5.%INDEX . 108List File Attributes . 109Standards and Conventions Requirements and Exemptions . 109Callable Routines . 109Glossary . 110List of FiguresFigure 1: Trace Log Capability Shortcut . 13Figure 2: Show Trace Log Menu Option . 13Figure 3: VistA Scheduling GUI Trace Log . 14Figure 4: Request Query . 15Figure 5: Query Results . 15Figure 6: VistA Scheduling GUI Cross Reference . 16Figure 7: VistA Scheduling GUI Cross Reference (cont.) . 17Figure 8: VistA Scheduling GUI Cross Reference (cont.) . 17Figure 9: VistA Scheduling GUI Cross Reference (cont.) . 17Figure 10: VistA Scheduling GUI Cross Reference (cont.) . 18Figure 11: VistA Scheduling GUI Cross Reference (cont.) . 18Figure 12: VistA Scheduling GUI Cross Reference (cont.) . 18Figure 13: VistA Scheduling GUI Cross Reference (cont.) . 19Figure 14: VistA Scheduling GUI Cross Reference (cont.) . 19Figure 15: VistA Scheduling GUI Cross Reference (cont.) . 19Figure 16: VistA Scheduling GUI Cross Reference (cont.) . 20Figure 17: VistA Scheduling GUI Cross Reference (cont.) . 20Figure 18: VistA Scheduling GUI Cross Reference (cont.) . 21Figure 19: VistA Scheduling GUI Cross Reference (cont.) . 21Figure 20: VistA Scheduling GUI Cross Reference (cont.) . 22Figure 21: VistA Scheduling GUI Cross Reference (cont.) . 22Figure 22: VistA Scheduling GUI Cross Reference (cont.) . 22Figure 23: VistA Scheduling GUI Cross Reference (cont.) . 23Figure 24: VistA Scheduling GUI Cross Reference (cont.) . 26Figure 25: VistA Scheduling GUI Cross Reference (cont.) . 27Figure 26: VistA Scheduling GUI Cross Reference (cont.) . 28Figure 27: VistA Scheduling GUI Cross Reference (cont.) . 28Figure 28: VistA Scheduling GUI Cross Reference (cont.) . 29Figure 29: VistA Scheduling GUI Cross Reference (cont.) . 29Figure 30: VistA Scheduling GUI Cross Reference (cont.) . 30Figure 31: VistA Scheduling GUI Cross Reference (cont.) . 30Figure 32: VistA Scheduling GUI Cross Reference (cont.) . 30Figure 33: VistA Scheduling GUI Cross Reference (cont.) . 31Figure 34: VistA Scheduling GUI Cross Reference (cont.) . 31Figure 35: VistA Scheduling GUI Cross Reference (cont.) . 31VistA Scheduling Enhancements (VSE)Technical ManualvJanuary 2017
Figure 36: VistA Scheduling GUI Cross Reference (cont.) . 32Figure 37: VistA Scheduling GUI Cross Reference (cont.) . 32Figure 38: Table File . 33Figure 39: Table File (cont.) . 33Figure 40: Table File (cont.) . 34Figure 41: Table File (cont.) . 34Figure 42: Table File (cont.) . 35Figure 43: Table File (cont.) . 35Figure 44: Table File (cont.) . 36Figure 45: Table File (cont.) . 37Figure 46: Table File (cont.) . 38Figure 47: Table File (cont.) . 39Figure 48: Table File (cont.) . 39Figure 49: Table File (cont.) . 40Figure 50: Table File (cont.) . 41Figure 51: Table File (cont.) . 41Figure 52: Table File (cont.) . 42Figure 53: Table File (cont.) . 42Figure 54: Table File (cont.) . 43Figure 55: Table File (cont.) . 44Figure 56: Table File (cont.) . 45Figure 57: Table File (cont.) . 46Figure 58: Table File (cont.) . 47Figure 59: Table File (cont.) . 48Figure 60: Table File (cont.) . 49Figure 61: Table File (cont.) . 50Figure 62: Table File (cont.) . 51Figure 63: Table File (cont.) . 52Figure 64: Table File (cont.) . 53Figure 65: Table File (cont.) . 54Figure 66: Table File (cont.) . 55Figure 67: Table File (cont.) . 56Figure 68: Table File (cont.) . 57Figure 69: Table File (cont.) . 58Figure 70: Table File (cont.) . 59Figure 71: Table File (cont.) . 60Figure 72: Table File (cont.) . 61Figure 73: Table File (cont.) . 62Figure 74: Table File (cont.) . 62Figure 75: Table File (cont.) . 63Figure 76: Table File (cont.) . 64Figure 77: Table File (cont.) . 65Figure 78: Table File (cont.) . 66Figure 79: Table File (cont.) . 67Figure 80: Table File (cont.) . 68Figure 81: Table File (cont.) . 69VistA Scheduling Enhancements (VSE)Technical ManualviJanuary 2017
Figure 82: Table File (cont.) . 70Figure 83: Table File (cont.) . 71Figure 84: Table File (cont.) . 72Figure 85: Table File (cont.) . 73Figure 86: Table File (cont.) . 74Figure 87: Table File (cont.) . 75Figure 88: Table File (cont.) . 76Figure 89: Table File (cont.) . 77Figure 90: Table File (cont.) . 78Figure 91: Table File (cont.) . 79Figure 92: Table File (cont.) . 80Figure 93: Table File (cont.) . 81Figure 94: Table File (cont.) . 82Figure 95: Table File (cont.) . 83Figure 96: Table File (cont.) . 84Figure 97: Table File (cont.) . 85Figure 98: Table File (cont.) . 86Figure 99: Table File (cont.) . 87Figure 100: Table File (cont.) . 88Figure 101: Table File (cont.) . 89Figure 102: Table File (cont.) . 90Figure 103: Table File (cont.) . 91Figure 104: Table File (cont.) . 92Figure 105: Table File (cont.) . 93Figure 106: Table File (cont.) . 94Figure 107: VistA Scheduling GUI Data Flow Diagram. 100Figure 108: VistA Scheduling GUI Report Console . 102Figure 109: Save/Export/Print Features . 102Figure 110: Report Viewer . 103Figure 111: Report Viewer Functionality . 104Figure 112: Report Console . 105Figure 113: Report Viewer . 106List of TablesTable 1: Routines and Description. 2Table 2: File Numbers and Names. 8Table 3: File Access . 9Table 4: Exported Option and Description . 95Table 5: Parameter Definitions . 96Table 6: Exported Security Keys . 96Table 7: Java Class Name and Purpose . 103Table 8: Terms and Definitions . 110VistA Scheduling Enhancements (VSE)Technical ManualviiJanuary 2017
1.OverviewThis manual provides Department of Veterans Affairs (VA) site managers with a technicaldescription of the Veterans Health Information System and Technology Architecture (VistA)Scheduling Graphical User Interface (GUI) routines, files, menus, cross references, globals, andother necessary information required to effectively manage the system.The VistA Scheduling GUI module has the following features: 1.1.MS Windows user interfaceGraphical patient, clinic, provider, and resource schedulingTightly linked to VistA patient and clinic dataGraphical resource and clinic availability schedulingPrinting and What You See Is What You Get (WYSIWYG) Print Preview of clinicschedulesGraphical patient check-in linked to VistA/PCC Plus (PCC ) check-inReschedule and manipulate appointments using standard Windows cut/paste metaphorsutilities proceduresSchedule multiple appointments during a time blockStore and retrieve clinic availability patternsView schedules for multiple clinics simultaneouslyResource Management Reporting for viewing metrics related clinic appointments andpatient encounters in VistASecurityThe VistA Scheduling GUI uses VistA security keys to limit user’s ability to change system setup parameters and patient information. In other words, not all VistA Scheduling GUI options areavailable to all users. Contact your site administrator to determine or change your security keys.1.2.Rules of BehaviorAll VistA users are required to observe VA Rules of Behavior regarding patient privacy and thesecurity of both patient information and VA computers and networks.1.3.OrientationThe VistA Scheduling GUI module has no VistA server menu options. The only VistA serverpreparation specifically required to run VistA Scheduling GUI is to install patches SD*5.3*627,SD*5.3*642, SD*5.3*628, and SD*5.3*658 using the Kernel Installation & Distribution System(KIDS) module and assign appropriate security keys to users. The rest of the module runs on thePC client and can be managed from there.Interaction of VistA Scheduling GUI with the VistA system is accomplished entirely via the useof Remote Procedure Calls (RPCs).VistA Scheduling Enhancements (VSE)Technical Manual1January 2017
2.Implementation and MaintenanceVistA Scheduling GUI provides a Windows interface for the Patient Information ManagementSystem (PIMS) Scheduling software and is designed to interoperate with existing PIMSschedules.2.1. System RequirementsServeroooooooClientoo2.2.Cache version 5.0Kernel version 8Patient Information Management System (PIMS) version 5.3 patch 1012VistA Scheduling Patch SD*5.3*627VistA Scheduling Patch SD*5.3*628VistA Scheduling Patch SD*5.3*642VistA Scheduling Patch SD*5.3*658.Net Version 4.0 or higher4 GB RAMPackage-Wide VariablesThere are no package-wide variables associated with the PIMS package.2.3.Menu DiagramVistA Scheduling GUI menus are discussed in detail in the VistA Scheduling Enhancements VSGUI User Guide.2.4.RoutinesTable 1: Routines and DescriptionRoutineDescriptionSDAM2ALB/MJK - Appt Mgt (cont)SDAMWI1ALB/MJK - Walk-Ins (cont.)SDAPIAPALB/MJK - Outpatient API/AppointmentsSDBFLA/RF,BSN/GRR - SET UP A CLINICSDB1ALB/GRR - SET UP A CLINICSDCMAN/GRR,ALB/LDB - CANCEL A CLINIC'S AVAILABILITYSDCNP0ALB/LDB - CANCEL APPT. FOR A PATIENTVistA Scheduling Enhancements (VSE)Technical Manual2January 2017
RoutineDescriptionSDCNSLTALB/HAG - LINK APPOINTMENTS TO CONSULTSSDCODELALB/RMO,ESW - Delete - Check OutSDECALB/SAT - VISTA SCHEDULING RPCsSDEC01ALB/SAT - VISTA SCHEDULING RPCsSDEC01AALB/SAT - VISTA SCHEDULING RPCsSDEC01BALB/SAT - VISTA SCHEDULING RPCsSDEC02ALB/SAT - VISTA SCHEDULING RPCsSDEC03ALB/SAT - VISTA SCHEDULING RPCsSDEC04ALB/SAT - VISTA SCHEDULING RPCsSDEC05ALB/SAT - VISTA SCHEDULING RPCsSDEC06ALB/SAT - VISTA SCHEDULING RPCsSDEC07ALB/SAT - VISTA SCHEDULING RPCsSDEC07AALB/SAT - VISTA SCHEDULING RPCsSDEC07BALB/SAT - VISTA SCHEDULING RPCsSDEC08ALB/SAT - VISTA SCHEDULING RPCsSDEC09ALB/SAT - VISTA SCHEDULING RPCsSDEC12ALB/SAT - VISTA SCHEDULING RPCsSDEC13ALB/SAT - VISTA SCHEDULING RPCsSDEC14ALB/SAT - VISTA SCHEDULING RPCsSDEC15ALB/SAT - VISTA SCHEDULING RPCsSDEC16ALB/SAT - VISTA SCHEDULING RPCsSDEC17ALB/SAT - VISTA SCHEDULING RPCsSDEC18ALB/SAT - VISTA SCHEDULING RPCsSDEC19ALB/SAT - VISTA SCHEDULING RPCsSDEC20ALB/SAT - VISTA SCHEDULING RPCsSDEC21ALB/SAT - VISTA SCHEDULING RPCsSDEC22ALB/SAT - VISTA SCHEDULING RPCsSDEC23ALB/SAT - VISTA SCHEDULING RPCsVistA Scheduling Enhancements (VSE)Technical Manual3January 2017
RoutineDescriptionSDEC24ALB/SAT - VISTA SCHEDULING RPCsSDEC25ALB/SAT - VISTA SCHEDULING RPCsSDEC25AALB/SAT - VISTA SCHEDULING RPCsSDEC25BALB/SAT - VISTA SCHEDULING RPCsSDEC26ALB/SAT - VISTA SCHEDULING RPCsSDEC27ALB/SAT - VISTA SCHEDULING RPCsSDEC28ALB/SAT - VISTA SCHEDULING RPCsSDEC29ALB/SAT - VISTA SCHEDULING RPCsSDEC30ALB/SAT - VISTA SCHEDULING RPCsSDEC31ALB/SAT - VISTA SCHEDULING RPCsSDEC32ALB/SAT - VISTA SCHEDULING RPCsSDEC33ALB/SAT - VISTA SCHEDULING RPCsSDEC34ALB/SAT - VISTA SCHEDULING RPCsSDEC35ALB/SAT - VISTA SCHEDULING RPCsSDEC36ALB/SAT - VISTA SCHEDULING RPCsSDEC37ALB/SAT - VISTA SCHEDULING RPCsSDEC38ALB/SAT - VISTA SCHEDULING RPCsSDEC40ALB/SAT - VISTA SCHEDULING RPCsSDEC44ALB/SAT - VISTA SCHEDULING RPCsSDEC45ALB/SAT - VISTA SCHEDULING RPCsSDEC46ALB/SAT - VISTA SCHEDULING RPCsSDEC47ALB/SAT - VISTA SCHEDULING RPCsSDEC48ALB/SAT - VISTA SCHEDULING RPCsSDEC49ALB/SAT - VISTA SCHEDULING RPCsSDEC50ALB/SAT - VISTA SCHEDULING RPCsSDEC51ALB/SAT - VISTA SCHEDULING RPCsSDEC51AALB/SAT – VISTA SCHEDULING RPCsSDEC52ALB/SAT - VISTA SCHEDULING RPCsVistA Scheduling Enhancements (VSE)Technical Manual4January 2017
RoutineDescriptionSDEC52AALB/SAT - VISTA SCHEDULING RPCsSDEC52BALB/SAT - VISTA SCHEDULING RPCsSDEC53ALB/SAT - VISTA SCHEDULING RPCsSDEC54ALB/SAT - VISTA SCHEDULING RPCsSDEC54AALB/SAT - VISTA SCHEDULING RPCsSDEC55ALB/SAT - VISTA SCHEDULING RPCsSDEC55AALB/SAT - VISTA SCHEDULING RPCsSDEC56ALB/SAT - VISTA SCHEDULING RPCsSDEC57ALB/SAT - VISTA SCHEDULING RPCsSDEC57AALB/SAT - VISTA SCHEDULING RPCsSDEC658ALB/SAT VISTA SCHEDULING PRE/POSTSDEC658AALB/SAT/JSM - VISTA SCHEDULING PRE/POST(CONTINUED)SDEC658BALB/SAT/JSM - VISTA SCHEDULING PRE/POST(CONTINUED)SDECALVALB/SAT - VISTA SCHEDULING RPCsSDECALV1ALB/SAT - VISTA SCHEDULING RPCsSDECALVRALB/SAT - VISTA SCHEDULING RPCsSDECAPIALB/SAT - VISTA SCHEDULING RPCsSDECAPI4ALB/SAT - VISTA SCHEDULING RPCsSDECDIQ1ALB/SAT - VISTA SCHEDULING RPCsSDECARALB/SAT - VISTA SCHEDULING RPCsSDECAR1ALB/SAT - VISTA SCHEDULING RPCsSDECAR1AALB/SAT - VISTA SCHEDULING RPCsSDECAR2ALB/SAT - VISTA SCHEDULING RPCsSDECAR3ALB/SAT/JSM – VISTA SCHEDULING RPCsSDECCLNALB/RBD - VISTA SCHEDULING CLEANUP UTILITYSDECDEMALB/SAT – VISTA SCHEDULING RPCsSDECDEVALB/SAT - VISTA SCHEDULING RPCsVistA Scheduling Enhancements (VSE)Technical Manual5January 2017
RoutineDescriptionSDECDIQ1ALB/SAT - VI
Security The VistA Scheduling GUI uses VistA security keys to limit user’s ability to change system set-up parameters and patient information. In other words, not all VistA Scheduling GUI options are ava
