INSTALLATION NOTES FOR HL7 1.6 IHS PATCH 4 PREFIX: HL*1.6*1004 *****NOTE*****NOTE*****NOTE*****NOTE*****NOTE*****NOTE*****NOTE***** * Read the Entire Notes File Prior to Attempting Any Installation! * *****NOTE*****NOTE*****NOTE*****NOTE*****NOTE*****NOTE*****NOTE***** *** NOTE: *** INSTALL 5TH When installing this package with the FileMan22/Kernel distritution, this package should be installed 5th after patch XT*7.3*1001 is installed NOTE: This install guide provides instructions for both MSM and Cache sites. 1. GENERAL INFORMATION a. Print all notes / readme files b. This patch is cumulative and includes IHS patches 1-3 as well as all of the VA Health Level Seven 1.6 patches through sequence 78. HL7 patches seq 1-19 were contained in IHS patch 1. If you have not installed IHS patches 1-3 you may still install this patch. Below is a list of the VA patches and their subjects. For a more detailed list of the patches go to IHS website: http://www.ihs.gov/cio/rpms/appselectdoc.cfm HL*1.6*1 seq 1 SUBJECT: Improved support for old 1.5 interfaces HL*1.6*2 seq 2 SUBJECT: LOWER LAYER PROTOCOL FIXES HL*1.6*5 seq 3 SUBJECT: Incorrect dates in 772 (Message Text) HL*1.6*6 seq 4 SUBJECT: LLP STATE AFTER STOPPING HL*1.6*7 seq 5 SUBJECT: New HL7 Event Type HL*1.6*8 seq 6 SUBJECT: NULLSUBSCR ERROR-BATCH ACKNOWLEDGMENTS HL*1.6*9 seq 7 SUBJECT: PATCH TO PATCH HL*1.6*10 seq 8 SUBJECT: HLMA NODES NOT PURGED HL*1.6*16 seq 9 SUBJECT: HL7 MAILMAN SERVER OPTION HL*1.6*17 seq 10 SUBJECT: Mail links never purged HL*1.6*13 seq 11 SUBJECT: PURGE AWAITAING ACK MESSAGE HL*1.6*12 seq 12 SUBJECT: OUTGOING MESSAGE WITH POINTER PROBLEMS HL*1.6*13 seq 13 SUBJECT: More control over purge HL*1.6*15 seq 14 SUBJECT: COMM SERV MONITORS WRAPPING PROBLEMS HL*1.6*18 seq 15 SUBJECT: IN/OUTBOUND Filers in infinite loop HL*1.6*22 seq 16 SUBJECT: HLLP out queue / BTS clean-up HL*1.6*20 seq 17 SUBJECT: Documentation Change Pages HL*1.6*25 seq 18 SUBJECT: Filers Error Out HL*1.6*27 seq 19 SUBJECT: HLLP PROCESSING LOOP HL*1.6*26 seq 20 SUBJECT: Honor Disabled Server Protocol HL*1.6*28 seq 21 SUBJECT: More control over filers HL*1.6*29 seq 22 SUBJECT: date.time subscript of TMP('HL' HL*1.6*23 seq 23 SUBJECT: Country Code length HL*1.6*24 seq 24 SUBJECT: DD & data change for file #772 & #771.7 HL*1.6*30 seq 25 SUBJECT: Reduce Unnecessary Sets/Journalling HL*1.6*35 seq 27 SUBJECT: HL7 MAILMAN LLP HL*1.6*36 seq 28 SUBJECT: Don't Purge and Reprocessing functions HL*1.6*38 seq 29 SUBJECT: M10 & M11 check digit scheme HL*1.6*34 seq 30 SUBJECT: Msg ID, HLLP data blocks & LLP priority HL*1.6*41 seq 31 SUBJECT: Patch 34 missing routine HL*1.6*42 seq 32 SUBJECT: M10 and M11 for alphanumeric ID HL*1.6*14 seq 33 SUBJECT: Dynamic Addressing/Subscription Registry HL*1.6*37 seq 34 SUBJECT: Batch initiating and ACK messages HL*1.6*40 seq 35 SUBJECT: New site params,monitor updates HL*1.6*19 seq 36 SUBJECT: BI-DIRECTIONAL TCP/IP HL*1.6*43 seq 37 SUBJECT: TCP support for MPI HL*1.6*52 seq 38 SUBJECT: HL7 Journaling Recommendation HL*1.6*51 seq 39 SUBJECT: HL7 to FM name conversion HL*1.6*48 seq 40 SUBJECT: Error in Display of System Link Monitor HL*1.6*44 seq 41 SUBJECT: X3.25 undefined variable HLDP HL*1.6*55 seq 42 SUBJECT: Missing ID for 1.5 interface HL*1.6*50 seq 43 SUBJECT: Transmission, Error log HL*1.6*47 seq 44 SUBJECT: Message Status, Error lists & purging HL*1.6*49 seq 45 SUBJECT: LINK MANAGER HL*1.6*39 seq 46 SUBJECT: HL7 TCP Logical Links for CIRN HL*1.6*54 seq 47 SUBJECT: Add & update entries for Files #771.5, #779.001, and #771.2 HL*1.6*57 seq 48 SUBJECT: Tools,Security,Backwards Compability,Fixes HL*1.6*56 seq 49 SUBJECT: Documentation Refresh HL*1.6*60 seq 50 SUBJECT: Routing Mailman Acks HL*1.6*58 seq 57 SUBJECT: Error with Ping HL*1.6*63 seq 52 SUBJECT: HL7 Support for DNS Lookups HL*1.6*61 seq 53 SUBJECT: Requeuer and DICN-Error HL*1.6*59 seq 54 SUBJECT: Support for message structures,fix STUB RECORDS HL*1.6*64 seq 55 SUBJECT: Update message status HL*1.6*65 seq 56 SUBJECT: ENHANCE SYSTEM LINK MONITOR HL*1.6*66 seq 57 SUBJECT: Undefined in HLSUB, use new Mail API HL*1.6*67 seq 58 SUBJECT: Should I say HELO? HL*1.6*68 seq 59 SUBJECT: CLEAN UP HLCSMM HL*1.6*70 seq 60 SUBJECT: New HLSEVEN.COM filefor AXP/DSM sites HL*1.6*73 seq 61 SUBJECT: SystemLink Monitor Blank Screen HL*1.6*72 seq 62 SUBJECT: Free-text Data Stored in Pointer Field HL*1.6*69 seq 63 SUBJECT: wrong processing routine being executed for VistA HL7 apps HL*1.6*76 seq 64 SUBJECT: CACHE' out of order acknowledgements HL*1.6*80 seq 65 SUBJECT: Invalid Processing ID when Production or Training Mode HL*1.6*77 seq 66 SUBJECT: Direct connect read and write errors HL*1.6*81 seq 67 SUBJECT: Correct setup for sites using DNS and HL7 HL*1.6*75 seq 68 SUBJECT: STARTING LOGICAL LINK AFTER ERROR HL*1.6*82 seq 69 SUBJECT: ERRORS IN HLL('LINKS') HL*1.6*83 seq 70 SUBJECT: DELETE SUBSCRIPTION TERMINATION DATE HL*1.6*79 seq 71 SUBJECT: New HL7/Capacity Management API HL*1.6*62 seq 72 SUBJECT: Reduce calls to Kernel API HL*1.6*78 seq 73 SUBJECT: Batch Trailer Segment has hard- coded field separator HL*1.6*71 seq 74 SUBJECT: Corrupt HL7 Message Headers HL*1.6*89 seq 75 SUBJECT: MPI Direct Connect Undefined Error HL*1.6*92 seq 76 SUBJECT: ADD LOGICAL LINK FOR FHIE HL*1.6*91 seq 77 SUBJECT: New NAMESPACE field in HL7 Message Text file HL*1.6*85 seq 78 SUBJECT: Error listing and disk full errors HL*1.6*87 seq 79 SUBJECT: Excessive Generation of Duplicate Messages c. Many patches have been released since the original release of V1.6 and the HL7 standard itself has evolved over the past few years. This release provides a complete refresh of the User and Developer Manuals for the VISTA HL7 package. The new manual is 'VISTA HL7 Site Manager & Developer Manual'. The new VISTA HL7 Site Manager & Developer Manual brings the package's documentation up to date with those changes. This completely revised manual supercedes the following existing manuals which are obsolete and should be discarded: DHCP HL7 V1.6 User Manual DHCP HL7 V1.6*19 User Manual: TCP/IP Supplement DHCP HL7 V1.6 Developer Manual DHCP HL7 V1.6*14 Developer Manual: Dynamic Addressing Supplement This manual can be obtained from the IHS website: http://www.ihs.gov/cio/rpms/appselectdoc.cfm d. This patch contains the following IHS local modifications to HL7 routines: HLCSDL removed references to DSM and $ETRAP HLCSDR removed references to DSM and $ETRAP prevent wrapping of long lines HLCSDR1 halt LLP on timeout error reset message waiting flag to avoid false timeout errors HLCSMM replace call to ^VASITE with call to ^HLZFUNC HLFNC fix parameter return bug HLZFUNC new routine to replace ^VASITE HLLP checks to see if network device and if so does new routine HLCZTCP HLCHK checks for TCP and does SEND^HLZTCP instead of SEND^HLLP HLZTCP new TCP connection Lab interface routine e. This patch contains IHS modifications for the HL7/Lab interface. If you are using the HL7/Lab interface and are switching from a serial to a TCP connection, please reference document 'TCP/IP Lab Interface Setup Document' for instructions. This document is available on the IHS website: http://www.ihs.gov/cio/rpms/appselectdoc.cfm 2. CONTENTS OF DISTRIBUTION a. hl__0160.1004k - (KIDS distribution file) b. hl__0160.1004n - (Notes file - this file) c. hl__0160.1004n1 - (Notes file Appendix A, sample load/install process) 3. REQUIREMENTS VA Kernel 8.0 VA FileMan 22.0 IHS FileMan Patch DI*22.0*1001 IHS Kernel Patch XU*8.0*1007 Kernel Toolkit 7.3 IHS Kernel Toolkit patch XT*7.3*1001 Health Level Seven 1.6 4. INSTALLATION INSTRUCTIONS a. Before starting this installation, make sure you have a viable complete system backup. b. It is recommended that you use a terminal which has true VT-100 emulation during this installation (NOT THE CONSOLE ON A RISC MACHINE SINCE IT IS AN IBM 3151). The video display on a terminal which is NOT emulating a VT-100 will not display properly using KIDS (Kernel Installation and Distribution System). c. If you choose to load this patch remotely (not sitting close to the CPU) then FIRST make sure you have an UNTIED terminal (one that is not tied to the ZU command) from which to do the installation. The reason for this is when you disable user logins you won't accidentally lock yourself out of the database. d. It is recommended that the terminal output during the installation be captured using an auxport printer attached to the terminal at which you are performing the software installation. This will assure a printed audit trail if any problems should arise. e. Get users off the system f. Stop all background jobs and filers such as those for MailMan, Lab, Pharmacy, HL7, etc., that may be running Review the system status to determine which background jobs and filers are running and use the appropriate utilities or options to stop them. For example: To stop the MailMan filer use option 'Stop Background Filer (XMAD)' To stop the TCP Listener use option 'BGU Stop Listener' To stop the Lab to PCC transaction Processor use option 'Stop/restart Lab to PCC Transaction Processor' g. Use option 'Purge Message Text File Entries' to remove old messages. (Depending on your HL7 patch level, the purge option may be named 'Purge Messages [HL PURGE TRANSMISSIONS]) Suggested answers: Enter cutoff date for all messages REGARDLESS OF STATUS: T-28 Enter last INCLUSIVE date for status SUCCESSFULLY TRANSMITTED: T-2 Purge entries with an ERROR STATUS? YES Cutoff date for AWAITING ACKNOWLEDGEMENT status: T-7 Would you like to queue this purge? YES// NO h. Make sure all messages have been transmitted. Run the option 'Systems Link Monitor' and make sure 'messages to send' is equal to 'messages sent' for all Logical Links. i. Inhibit logins >D Q^DI VA FileMan 22.0 Select OPTION: ENTER OR EDIT FILE ENTRIES INPUT TO WHAT FILE: VOLUME SET EDIT WHICH FIELD: ALL// INHIBIT LOGONS THEN EDIT FIELD: Select VOLUME SET: VAH <--- Enter your production volume set INHIBIT LOGONS?: NO// YES j. Shut down TaskMan >D STOP^ZTMKU Are you sure you want to stop TaskMan? NO// YES Shutting down TaskMan. Should active submanagers shut down after finishing their current tasks? YES Okay! k. Create new global ^HLS. This will be the storage location for file 774 SUBSCRIPTION CONTROL. In production UCI: >S ^HLS="" l. Kill the transport global In production UCI: >K ^XTMP("XPDI") m. D ^XPDKRN to enter the KIDS menu to load the distribution file. Select option 1 to load the distribution >D ^XPDKRN KIDS 8.0 Select KIDS OPTION: ? Answer with KIDS OPTION NUMBER, or NAME Choose from: 1 LOAD A DISTRIBUTION 2 INSTALL PACKAGE(S) 3 RESTART INSTALL OF PACKAGE(S) 4 UNLOAD A DISTRIBUTION 5 VERIFY CHECKSUMS IN TRANSPORT GLOBAL Select KIDS OPTION: 1 LOAD A DISTRIBUTION Enter a Host File: hl__0160.1004k (Be sure to include the path of the directory where you placed the distribution file.) At this point the load process begins. |NOTE: If you are a Cache or any other site who may |have previously installed FileMan 22 or any of the |FileMan22/Kernel/Toolkit/HL7 patches, you may receive |messages similar to the following (Answer YES): |Build HL*1.6*32 has been loaded before, here is when: | HL*1.6*32 Install Completed | was loaded on May 30, 2002@18:28:21 |OK to continue with Load? NO// YES <--- Answer YES Want to RUN the Environment Check Routine? YES// YES (See Appendix A in file hl__0160.1004n1 for a sample of the entire load and install process.) n. Use the KIDS option to install the distribution >D ^XPDKRN KIDS 8.0 Select KIDS OPTION: ? Answer with KIDS OPTION NUMBER, or NAME Choose from: 1 LOAD A DISTRIBUTION 2 INSTALL PACKAGE(S) 3 RESTART INSTALL OF PACKAGE(2) 4 UNLOAD A DISTRIBUTION 5 VERIFY CHECKSUMS IN TRANSPORT GLOBAL Select KIDS OPTION: 2 INSTALL PACKAGE(S) Select INSTALL NAME: HL*1.6*1004 At this point the install process begins. Answer YES to all 'Want my data merged with yours?' prompts Answer NO to all 'Want KIDS to Rebuild Menu Trees Upon Completion of Install?' prompts Answer NO to 'Want KIDS to INHIBIT LOGONS during the install' prompt (See Appendix A in file hl__0160.1004n1 for a sample install session.) After installation is complete run EN1^XPDDI to print and review the installation process for this patch as well as all patches listed in 1b above. o. Restart TaskMan You must be logged in as root (on an AIX or UNIX system) to start TaskMan >D RESTART^ZTMB p. Enable user logins D Q^DI Select OPTION: ENTER OR EDIT FILE ENTRIES INPUT TO WHAT FILE: VOLUME SET// EDIT WHICH FIELD: ALL// INHIBIT LOGONS? THEN EDI T FIELD: Select VOLUME SET: DHC INHIBIT LOGONS?: YES// NO q. Restart background jobs and filers that were stopped for this install For example: To start the MailMan filer use option 'START background filer (XMAD)' To start the TCP Listener use option 'BGU Start Listener' To start the Lab to PCC transaction Processor use option 'Stop/restart Lab to PCC Transaction Processor' r. Start up all HL7 Logical Links and incoming and outgoing filers using option 'Restart/Start All Links and Filers'. (Note that links that do not have "autostart" enabled will need to be restarted manually.) s. Use option 'TCP Link Manager Start/Stop' to start the HL7 Link Manager. t. Use option BUILD PRIMARY MENU TREES to rebuild the menu trees. This option will build menu trees for each primary and secondary menu. You may build all the trees, or build them selectively, using 'verify'. Note that the 'compiled menus' will only be built into ^XUTL on this CPU. Do you wish to verify each primary menu? NO// Would you like to build secondary menu trees too? YES// Would you like to queue this job? YES// Requested Start Time: NOW// (JAN 29, 2003@17:38:02) u. Allow users back on the system. 5. POST-INSTALLATION INSTRUCTIONS If you are using HL7 complete the following items: a. Using Fileman, edit the AUTOSTART field of file 870. Set this to '1' if you want your logical links to automatically restart after a system reboot. b. Using the TaskMan option, 'Schedule/Unschedule options', select the new HL7 option, 'Restart/Start All Links and Filers', and place an 'S' in the SPECIAL QUEUEING field. c. It is highly recommended sites establish a mail group for HL7 related alerts. The Link Manager will use this mail group to send an alert whenever it finds a configuration problem between the links and TaskMan. This mail group should be entered into the Communication Servers Parameters using option 'HL EDIT COMM SERVER PARAMETERS' (see below). d. Patches HL*1.6*40 seq 35 and HL*1.6*47 seq 44 introduced new site parameters. Use ScreenMan option 'HL EDIT COMM SERVER PARAMETERS' and complete entries for the new site parameters provided. The screen will appear as follows: Select OPTION NAME: HL EDIT COMM SERVER PARAMETERS Edit HL7 Site Parameters Current Domain: Current Institution: Is this a Production or Test Account? Default Number of Incoming Filers: 1 Default Number of Outgoing Filers: 1 Mail Group for Alerts: Days to Keep Completed Messages: 7 Days to Keep Awaiting ACK Messages: 30 Days Before Purging ALL Messages: 90 e. It is recommended that only the following globals be journaled: ^HL ^HLMA 6. CONTACTS If you have any questions about this installation or any problems with Health Level Seven (HL7) 1.6, please contact the ITSC Customer Support Center at (505)248-4371 or (888)830-7280.