$TXT Created by WILLIAMS,JOHN at SCH.FO-ALBANY.MED.VA.GOV (KIDS) on Monday, 06/07/04 at 14:59 ============================================================================= Run Date: JUL 12, 2004 Designation: SD*5.3*301 Package : SD - SCHEDULING Priority: Mandatory Version : 5.3 SEQ #298 Status: Released Compliance Date: AUG 12, 2004 ============================================================================= Subject: SCHEDULING API Category: - Routine Description: ============ Description: =========== **INSTALLATION OF THIS PATCH IS TRANSPARENT TO USERS** PURPOSE OF THE PATCH ==================== This patch contains a new API that will be used by VistA applications to integrate M-based Class I, Class III and local applications with the Government Off-the-Shelf (GOTS) Scheduling application being developed by the Scheduling Replacement team. The API will replace other methods of accessing the patient appointment information stored in the Patient sub-file(#2.98) and the Hospital Location sub-file (#44.001). During implementation of the new GOTS Scheduler, this appointment information will be moved to the GOTS database and deleted from the Scheduling files. Installing the patch will not modify existing functions or data in any way. It contains nine routines. TEST SITES ========== MADISON WI VAMC CHARLESTON SC VAMC RICHMOND VA SHERIDAN WY EL-PASO TX OVERVIEW ======== The API is designed to be 'flexible' and will switch from the old database source (VistA Scheduling files) to the new database source (GOTS SQL tables) without re-programming the requesting application. Any hard-coded or Fileman references to Scheduling globals in routines or data dictionaries that are not replaced with one of the Scheduling Replacement APIs will cause the application to error. The API accepts user-specified criteria, in the form of an array, and returns the matching appointment data. The following appointment data can be requested: 1. APPOINTMENT DATE/TIME 2. CLINIC IEN and NAME 3. APPOINTMENT STATUS AND DESCRIPTION 4. PATIENT DFN and NAME 5. LENGTH OF APPOINTMENT 6. COMMENTS ("OTHER") 7. OVERBOOK 8. ELIGIBILITY OF VISIT ID and NAME 9. CHECK-IN DATE/TIME 10. APPOINTMENT TYPE IEN and NAME 11. CHECK-OUT DATE/TIME 12. OUTPATIENT ENCOUNTER IEN 13. PRIMARY STOP CODE IEN AND CODE 14. CREDIT STOP CODE IEN AND CODE 15. WORKLOAD NON-COUNT 16. DATE APPOINTMENT MADE 17. DESIRED DATE OF APPOINTMENT 18. PURPOSE OF VISIT AND SHORT DESCRIPTION 19. EKG DATE/TIME 20. X-RAY DATE/TIME 21. LAB DATE/TIME 22. STATUS 23. X-RAY FILMS The following documentation is available SD_53_301RN.PDF - Release Notes NOTE: The document is in binary format so it must be transferred in binary, not ASCII, mode. To download from the first available FTP server, use FTP location download.vista.med.va.gov Or any of the following may also be used to download directly from a particular FTP location ALBANY ftp.fo-albany.med.va.gov HINES ftp.fo-hines.med.va.gov SALT LAKE ftp.fo-slc.med.va.gov The file is available in the SOFTWARE sub-directory. API ENTRY POINT =============== Extrinsic call: $$SDAPI^SDAMA301(.ARRAY) where ".ARRAY" is a user-specified array containing filter criteria as defined in the Release Notes. ROUTINE SUMMARY: ================ The following is a list of the routine(s) included in this patch. The second line of each of these routine(s) will look like: ;;5.3;Scheduling;**[patch list]**;Aug 13, 1993 CHECK^XTSUMBLD results Routine name Before Patch After Patch Patch List ============ ============ =========== ========== SDAMA300 N/A 5725864 301 SDAMA301 N/A 966439 301 SDAMA302 N/A 6642111 301 SDAMA303 N/A 6122575 301 SDAMA304 N/A 1809937 301 SDAMA305 N/A 9318805 301 SDAMA306 N/A 1375982 301 SDAMA307 N/A 497659 301 SDAMA308 N/A 4744613 301 Number of Routines = 9 INSTALLATION INSTRUCTIONS: ========================== This patch should be installed during non-peak hours. Users can be on the system. Installation will take less than 5 minutes. 1. Use the INSTALL/CHECK MESSAGE option on the PackMan menu. 2. Review your mapped set. If any of the routines listed in the ROUTINE SUMMARY section are mapped, they should be removed from the mapped set at this time. 3. From the Kernel Installation and Distribution System Menu, select the Installation menu. 4. From this menu, you may elect to use the following options (when prompted for INSTALL NAME, enter SD*5.3*301): a. Backup a Transport Global - this option will create a backup message of any routines exported with the patch. It will NOT backup any other changes such as DDs or templates. b. Compare Transport Global to Current System - this option will allow you to view all changes that will be made when the patch is installed. It compares all components of the 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. 5. Use the Install Package(s) option and select the package SD*5.3*301. 6. When prompted 'Want KIDS to INHIBIT LOGONs during the install? YES??//',respond NO. 7. When prompted 'Want to DISABLE Scheduled Options, Menu Options, and Protocols? YES//', respond NO. 8. If routines were unmapped as part of step 2, they should be returned to the mapped set once the installation has run to completion. Routine Information: ==================== Routine Name: - SDAMA300 Routine Checksum: 5725864 Routine Name: - SDAMA301 Routine Checksum: 966439 Routine Name: - SDAMA302 Routine Checksum: 6642111 Routine Name: - SDAMA303 Routine Checksum: 6122575 Routine Name: - SDAMA304 Routine Checksum: 1809937 Routine Name: - SDAMA305 Routine Checksum: 9318805 Routine Name: - SDAMA306 Routine Checksum: 1375982 Routine Name: - SDAMA307 Routine Checksum: 497659 Routine Name: - SDAMA308 Routine Checksum: 4744613 ============================================================================= User Information: Entered By : SAUNDERS,ANGELA C Date Entered : JUL 03, 2003 Completed By: MEYERS,STEPHEN Date Completed: JUL 08, 2004 Released By : FITCH,DONNA Date Released : JUL 12, 2004 ============================================================================= Packman Mail Message: ===================== $END TXT