$TXT Created by ORMSBY,SKIP at NXT.KERNEL.FO-OAKLAND.MED.VA.GOV (KIDS) on Tuesday, 03/07/06 at 06:07 ============================================================================= Run Date: MAY 10, 2006 Designation: XU*8*378 Package : XU - KERNEL Priority: Mandatory Version : 8 SEQ #333 Status: Released Compliance Date: JUN 10, 2006 ============================================================================= Associated patches: (v)XU*DBA*3 <<= must be installed BEFORE `XU*8*378' (v)XU*8*292 <<= must be installed BEFORE `XU*8*378' (v)XU*8*328 <<= must be installed BEFORE `XU*8*378' Subject: STATE & FOREIGN COUNTRY CLEAN UP Category: - Routine - Data Dictionary Description: ============ This patch corrects the following issue: The purpose of this patch is to synchronize VistA's STATE(#5) and the COUNTY CODE(#5.13) files with the Austin Automation Center's(AAC) for the 50 United States, it's territories, and recognized foreign countries. Any entries that are "local", that is, not contained in the following table, will be flagged as not recognized by the AAC upon completion of installation so the "local" entries can be screened out for certain STATE(#5) file look ups. All three values in the following table MUST match your VistA STATE(#5) entry. ========================================================================== Table of AAC's STATE(#5) file entries ========================================================================== NAME ABB. VA STATE CODE ==== ==== ============= ALABAMA AL 01 ALASKA AK 02 ALBERTA AB 58 AMERICAN SAMOA AS 60 ARIZONA AZ 04 ARKANSAS AR 05 ARMED FORCES AF,EU,ME,CA AE 87 ARMED FORCES AMER (EXC CANADA) AA 85 ARMED FORCES PACIFIC AP 88 BRITISH COLUMBIA BC 59 CALIFORNIA CA 06 CANADA CANAD 91 COLORADO CO 08 CONNECTICUT CT 09 DELAWARE DE 10 DISTRICT OF COLUMBIA DC 11 EUROPE EU 93 FEDERATED STATES OF MICRONESIA FM 64 FLORIDA FL 12 FOREIGN COUNTRY FG 90 GEORGIA GA 13 GUAM GU 66 HAWAII HI 15 IDAHO ID 16 ILLINOIS IL 17 INDIANA IN 18 IOWA IA 19 KANSAS KS 20 KENTUCKY KY 21 LOUISIANA LA 22 MAINE ME 23 MANITOBA MB 61 MARSHALL ISLANDS MH 68 MARYLAND MD 24 MASSACHUSETTS MA 25 MEXICO MX 92 MICHIGAN MI 26 MINNESOTA MN 27 MISSISSIPPI MS 28 MISSOURI MO 29 MONTANA MT 30 NEBRASKA NE 31 NEVADA NV 32 NEW BRUNSWICK NB 62 NEW HAMPSHIRE NH 33 NEW JERSEY NJ 34 NEW MEXICO NM 35 NEW YORK NY 36 NEWFOUNDLAND NF 63 NORTH CAROLINA NC 37 NORTH DAKOTA ND 38 NORTHERN MARIANA ISLANDS MP 69 NORTHWEST TERRITORIES NT 73 NOVA SCOTIA NS 65 NUNAVUT PROVINCE NU 94 OHIO OH 39 OKLAHOMA OK 40 ONTARIO ON 75 OREGON OR 41 PALAU PW 70 PENNSYLVANIA PA 42 PHILIPPINES PH 96 PRINCE EDWARD ISLAND PE 77 PUERTO RICO PR 72 QUEBEC QC 80 RHODE ISLAND RI 44 SASKATCHEWAN SK 82 SOUTH CAROLINA SC 45 SOUTH DAKOTA SD 46 TENNESSEE TN 47 TEXAS TX 48 U.S. MINOR OUTLYING ISLANDS UM 74 UTAH UT 49 VERMONT VT 50 VIRGIN ISLANDS VI 78 VIRGINIA VA 51 WASHINGTON WA 53 WEST VIRGINIA WV 54 WISCONSIN WI 55 WYOMING WY 56 YUKON TERRITORY YT 83 1. The environment check routine, XU8P378E, checks your STATE(#5) file to see if there are any issues that will need manual correction(s). Please see the section of this description called: "Example Installation With Environment Check Routine Failure" for an example. 2. Patch makes corrections to the States in the STATE(#5) file and flag any "States" that are not recognized by the AAC. Also, makes corrections to the COUNTY CODE(#5.13) file and fixes any broken pointers in the COUNTY CODE(#5.13) file. Routine: XU8P378A 3. Because the Regular C cross reference is defined on both the ABBREVIATION(#1) and VA STATE CODE(#2)fields in the STATE(#5) file, it was possible when doing re-index on either one of these fields for one or the other's values to be indexed but not both, therefore a new style cross reference is being added, ADUALC, for indexing purposes. Routine: XU8P378B 4. New DELete and LAYGO nodes will be added to the following files to prevent deletions and the addition of new entries: File: STATE(#5), Field: NAME(#.01) Sub-File: COUNTY(#5.01), Field: COUNTY(#.01) File: COUNTY CODE(#5.13), Field: FIPS CODE(#.01) A new DELete node will added to the following file: File: POSTAL CODE(#5.12), Field: MAIL CODE(#.01) Routine: XU8P378C 5. Finally, the STATE(#5) file will be synchronized with the COUNTY CODE(#5.13) file. And a scan will be done of the COUNTY CODE(#5.13) file and the STATE(#5) file and a VistA e-mail will be sent to: -The patch installer -New Mail Group: XIP SERVER RESPONSE -GAL group: VHA HEC DQ SUPPORT(hecdqsupport@med.va.gov) Note: this group will be coordinating any further changes to the COUNTY CODE(#5.13) and STATE(#5) files. Routine: XU8P378 New Option ========== NAME: XIPMAILSERVER MENU TEXT: Check file 5.13 & file 5 TYPE: server PACKAGE: KERNEL DESCRIPTION: This is a server option that will check the POSTAL CODE(#5.13) v. the STATE(#5) file. It also checks the STATE(#5) file for any states that are not recognized by the AAC. ROUTINE: XIPMAIL SERVER ACTION: RUN IMMEDIATELY SERVER MAIL GROUP: XIP SERVER RESPONSE UPPERCASE MENU TEXT: CHECK FILE 5.13 & FILE 5 New Mail Group ============== NAME: XIP SERVER RESPONSE TYPE: public ALLOW SELF ENROLLMENT?: YES COORDINATOR: ORMSBY,SKIP DESCRIPTION: This mail group will receive the response message when either a scan of the COUNTY CODE(#5.13) and STATE(#5) whenever a manual scan is requested by doing from the programmer prompt: >D ^XIPMAIL or in response to a request of server: XIPMAILSERVER[Check file 5.13 & file 5] New Sort & Print Templates ========================== NAME: XIP STATE EXPORT SORT BY: @INTERNAL(#2.1)=1;L1// (INTERNAL(#2.1)=1) WITHIN INTERNAL(#2.1)=1, SORT BY: NAME// (User is asked range) NAME: XIP STATE EXPORT DATE CREATED: AUG 30, 2005@09:04 READ ACCESS: @ FILE: STATE WRITE ACCESS: @ DATE LAST USED: AUG 30, 2005 SUB-HEADER SUPPRESSED: YES HEADER (c): @ FIRST PRINT FIELD: VA STATE CODE;C1;X// THEN PRINT FIELD: "^";X// THEN PRINT FIELD: NAME;X// THEN PRINT FIELD: "^";X// THEN PRINT FIELD: ABBREVIATION;X// NAME: XIP STATE/COUNTY EXPORT SORT BY: @INTERNAL(#2.1)=1;L1// (INTERNAL(#2.1)=1) WITHIN INTERNAL(#2.1)=1, SORT BY: @NAME// (User is asked range) WITHIN NAME, SORT BY: @COUNTY// COUNTY SUB-FIELD: INACTIVE DATE// (INACTIVE DATE is null) WITHIN INACTIVE DATE, SORT BY: COUNTY// COUNTY SUB-FIELD: COUNTY// (COUNTY not null) NAME: XIP STATE/COUNTY EXPORT DATE CREATED: AUG 26, 2005@09:10 READ ACCESS: @ FILE: STATE WRITE ACCESS: @ DATE LAST USED: NOV 01, 2005 SUB-HEADER SUPPRESSED: YES HEADER (c): @ FIRST PRINT FIELD: SETPARAM((#.01),"NAME");X// THEN PRINT FIELD: SETPARAM((#1),"ABB");X// THEN PRINT FIELD: SETPARAM((#2),"SCODE");X// THEN PRINT FIELD: COUNTY// THEN PRINT COUNTY SUB-FIELD: PARAM("SCODE");X// THEN PRINT COUNTY SUB-FIELD: "^";X// THEN PRINT COUNTY SUB-FIELD: PARAM("NAME");X// THEN PRINT COUNTY SUB-FIELD: "^";X// THEN PRINT COUNTY SUB-FIELD: PARAM("ABB");X// THEN PRINT COUNTY SUB-FIELD: "^";X// THEN PRINT COUNTY SUB-FIELD: VA COUNTY CODE;X// THEN PRINT COUNTY SUB-FIELD: "^";X// THEN PRINT COUNTY SUB-FIELD: COUNTY;X// THEN PRINT COUNTY SUB-FIELD: "^";X// THEN PRINT COUNTY SUB-FIELD: // THEN PRINT FIELD: // Documentation Changes ===================== -None- Blood Bank Clearance ==================== Clearance - Oct 24, 2005 EFFECT ON BLOOD BANK FUNCTIONAL REQUIREMENTS: Patch XU*8*378 contains changes to a package referenced in VHA OI SEPG SOP 192-023 Review of VISTA Patches for Effects on VISTA Blood Bank Software. This patch does not alter or modify any VistA Blood Bank software design safeguards or safety critical elements functions. RISK ANALYSIS: Changes made by patch XU*8*378 have no effect on Blood Bank software functionality, therefore RISK is none. Remedy Ticket ============= HD64294; HD88920 Thanks to Test Sites ==================== CLARKSBURG, WV ILLIANA HCS PUGET SOUND HCS SALISBURY, NC VA GREATER LOS ANGELES HCS Routine Summary: ================ Checksums shown are OLD Checksums The following routines are included in this patch. The second line of each of these routines now looks like: ;;8.0;KERNEL;**[Patch List]**;Jul 10, 1995;Build 59 Checksums Routine Old New Patch List XIPMAIL N/A 1345878 **378** XIPMAILA N/A 8062720 **378** XIPMAILB N/A 7897343 **378** XIPPOST 3082958 2679868 **292,378** XIPSYNC 2391889 2484461 **328,378** XU8P378 N/A 849486 **378** XU8P378A N/A 6719100 **378** XU8P378B N/A 4819724 **378** XU8P378C N/A 2846052 **378** XU8P378E N/A 6517773 **378** List of preceding patches: 292, 328 Sites should use CHECK^XTSUMBLD to verify checksums. Installation Instructions: ========================== This patch can be installed with VISTA users online. However, it is recommended that it be Queued for a time of generally least activity. TaskMan does not need to be STOPPED or placed in a WAIT state and installation should take less than a minute. ========================================================================== >> Notes << 1. It is recommended that a back up of the data for the STATE(#5) and POSTAL CODE(#5.13) be made prior to the installation of this patch. For example: >D ^%GOGEN Device: Parameters: "WNS"=> Warning: Use a "V" format to avoid problems with control characters. Global ^DIC(5, Global ^XIP(5.13, Global ^ > 2. It is recommended that through review of the "Example Installation With Environment Check Routine Failure" that follows the installation instructions be made prior to the loading and installation of this patch. ========================================================================== 1. Use the 'INSTALL/CHECK MESSAGE' option on the PackMan menu. This option will load the KIDS package onto your system. 2. The patch has now been loaded into a transport global on your system. You now need to use KIDS to install the transport global. 3. On the KIDS menu, under the 'Installation' menu, use the following options: Print Transport Global Compare Transport Global to Current System Verify Checksums in Transport Global Backup a Transport Global 4. On the KIDS menu, under the 'Installation' menu, use the following option: Select Installation Option: Install Package(s) Select INSTALL NAME: XU*8.0*378 ========== Answer with whom you would like to be the coordinator when asked: "Enter the Coordinator for Mail Group 'XIP SERVER RESPONSE':" Answer 'NO' to "Want KIDS to Rebuild Menu Trees Upon Completion of Install?" Answer 'NO' to "Want KIDS to INHIBIT LOGONs during the install?" Answer 'NO' to "Want to DISABLE Scheduled Options, Menu Options, and Protocols?" ========================================================================== Example Installation With Environment Check Routine Failure ========================================================================== Message Xtract KIDS =================== [message dialog] Enter message action (in IN basket): Ignore// Xtract KIDS Select PackMan function: 6 INSTALL/CHECK MESSAGE Line 3 Message #nnn Unloading KIDS Distribution XU*8.0*378 XU*8.0*378 Want to Continue with Load? YES// Loading Distribution... XU*8.0*378 Will first run the Environment Check Routine, XU8P378E Begin STATE(#5) file environment check... IEN^NAME(#.01)^ABBREVIATION(#1)^VA STATE CODE(#2)^[W]arning/[F]ailure Reason 110^MANITOBA^MB^61^[F]Duplicate State ABBREVIATION(#1) 110^MANITOBA^MB^61^[F]Duplicate State VA STATE CODE(#2) 111^GERMANY^AEGM^^[W]Not a recognized VistA State 112^UNITED KINGDOM^AEUK^^[W]Not a recognized VistA State 113^BAHAMAS^AEBAH^^[F]Duplicate State ABBREVIATION(#1) 113^BAHAMAS^AEBAH^^[W]Not a recognized VistA State 114^BAHRAIN^AEBAH^^[F]Duplicate State ABBREVIATION(#1) 114^BAHRAIN^AEBAH^^[W]Not a recognized VistA State 52^FOREIGN COUNTRY^FC^^[W]Not a recognized VistA State 57^CANAL ZONE^MB^61^[F]Duplicate State ABBREVIATION(#1) 57^CANAL ZONE^MB^61^[F]Duplicate State VA STATE CODE(#2) 57^CANAL ZONE^MB^61^[W]Not a recognized VistA State 74^JOHNSTON ATOLL^UM^74^[W]Not a recognized VistA State 90^OTHER^FG^90^[W]Not a recognized VistA State ^FOREIGN COUNTRY^FG^90^[F]State not found in STATE(#5) file ^U.S. MINOR OUTLYING ISLANDS^UM^74^[F]State not found in STATE(#5) file Finished environment check. >> Environment check failed! XU*8.0*378 Build will not be installed Feb 04, 2006@05:47:39 Select PackMan function: Enter message action (in IN basket): Ignore// ========================================================================== Many thanks goes to the test sites their help on this section. >> Notes << The Environment check looks at your STATE(#5) to see if there are any of the following failure conditions: 1. Duplicate NAME(#.01)s. 2. Duplicate ABBREVIATION(#1)s. 3. Duplicate VA STATE CODE(#2)s. 4. Any entries that are not EXACT matches to the above table. If the Environment check routine encounters no problems, skip to section "Rest Of Example Installation". The following is an example of how the above environment check failures, were corrected. DO NOT DELETE any entries, because this could cause broken pointer values in other VistA files. There are three warning types of failure codes: 1. "[W]Not a recognized VistA State", will display if the state NAME, VA STATE CODE or ABBREVIATION are incorrect. If it s a single entry, editing the appropriate field(s) will resolve this failure. In the example below, the standard state file determined that 90 is the standard VA STATE CODE for the state FOREIGN COUNTRY. Use VA FileMan to edit the NAME and ABBREVIATION. IEN^NAME(#.01)^ABBREVIATION(#1)^VA STATE CODE(#2)^[W]arning/[F]ailure Reason 52^OTHER^OT^90^[W]Not a recognized VistA State 2. "[F]Duplicate State NAME(#.01)", will display if multiple entries with the same NAME(#.01) exist. "[F]Duplicate State ABBREVIATION(#1), will display if multiple entries with the same ABBREVIATION(#1) exist. "[F]Duplicate VA STATE CODE(#2)", will display if multiple entries with the same VA STATE CODE(#2) exist. In the duplicate example below, there are two Internal Entry Numbers(IEN) for the same state. Select one of the IEN entries and edit with correct standard NAME and ABBREVIATION codes from the patch standardized listing and "Z" out the rest as shown in the corrective action examples below. Once you correct one of the duplicate entries, it will resolve the "[W]Not a recognized VistA State". IEN^NAME(#.01)^ABBREVIATION(#1)^VA STATE CODE(#2)^[W]arning/[F]ailureReason 64^FEDERATED STATES OF MICRONESIA^FS^64^[F]Duplicate State ABBREVIATION(#1) 64^FEDERATED STATES OF MICRONESIA^FS^64^[F]Duplicate State NAME(#.01) 64^FEDERATED STATES OF MICRONESIA^FS^64^[F]Duplicate State VA STATE CODE(#2) 99^FEDERATED STATES OF MICRONESIA^FM^64^[F]Duplicate State NAME(#.01) 99^FEDERATED STATES OF MICRONESIA^FM^64^[F]Duplicate State VA STATE CODE(#2) ^FEDERATED STATES OF MICRONESIA^FM^64^[F]State not found in STATE(#5) file 99^FEDERATED STATES OF MICRONESIA^FS^64^[F]Duplicate State VA STATE CODE(#2) 99^FEDERATED STATES OF MICRONESIA^FS^64^[W]Not a recognized VistA State 3. "[F]State not found in STATE(#5) file", will display if the state does not match any of the entries in the State file. First check for a SPELLING problem to correct the issue, otherwise use VA Fileman Enter/Edit to add the new entry(s) utilizing the standardized state data listing provided with this patch. NOTE: Please be aware that the Internal Entry Number(IEN) will not necessarily match the VA STATE CODE(#2) value. In the example below see how the "[F]State not found in STATE(#5) file" warning for "JOHNSTON ATOLL" was corrected to "U.S. MINOR OUTLYING ISLANDS". If an IEN is listed in the display, it is referring to the entry in site s STATE file. Otherwise, it is referring to standard AAC State file. In the following example, the Warning message is that the name listed at IEN 107 in SITE s State file is not recognized by AAC Standard file and the Failure message is that the name (correct name) listed is missing in SITE s State file. Once the space is removed from the State name, it takes care of both the Warning and the Failure. 107^U. S. MINOR OUTLYING ISLANDS^UM^74^[W]Not a recognized VistA State ^U.S. MINOR OUTLYING ISLANDS^UM^74^[F]State not found in STATE(#5) file To identify changes that will be necessary to make, it may be useful to import the ^ delimited "environment check" data into an Excel spreadsheet and sort on the State Name column, or on the Abbreviation column or on the VA State Code column. To test whether or not your edits will pass the environment check routine before your start the install again, from programmer mode: D ^XU8P378E =========== If you have any questions regarding how to make corrections, please file a Remedy ticket. ========================================================================== FMD>D P^DI ====== VA FileMan 22.0 Select OPTION: ENTER OR EDIT FILE ENTRIES INPUT TO WHAT FILE: STATE// EDIT WHICH FIELD: ALL// .01 NAME THEN EDIT FIELD: 1 ABBREVIATION THEN EDIT FIELD: 2 VA STATE CODE THEN EDIT FIELD: Select STATE NAME: `57 CANAL ZONE NAME: CANAL ZONE// ZCANAL ZONE ABBREVIATION: MB// ZMB VA STATE CODE: 61// @ SURE YOU WANT TO DELETE? Y (Yes) Select STATE NAME: `74 JOHNSTON ATOLL NAME: JOHNSTON ATOLL// U.S. MINOR OUTLYING ISLANDS ABBREVIATION: UM// VA STATE CODE: 74// Select STATE NAME: `90 OTHER NAME: OTHER// FOREIGN COUNTRY ABBREVIATION: FG// VA STATE CODE: 90// Select STATE NAME: `113 BAHAMAS NAME: BAHAMAS// ABBREVIATION: AEBAH// AEBF VA STATE CODE: Select STATE NAME: `114 BAHRAIN NAME: BAHRAIN// ABBREVIATION: AEBAH// AEBA VA STATE CODE: Select STATE NAME: `52 FOREIGN COUNTRY NAME: FOREIGN COUNTRY// ZFOREIGN COUNTRY ABBREVIATION: FC// VA STATE CODE: Select STATE NAME: Select OPTION: FMD>D ^XU8P378E =========== Begin STATE(#5) file environment check... Finished environment check. ========================================================================== Rest Of Example Installation ========================================================================== FMD>D ^XPDKRN ========= KIDS 8.0 Select KIDS OPTION: INSTALL PACKAGE(S) ================== Select INSTALL NAME: XU*8.0*378 ========== Loaded from Distribution 2/4/06@06:22 => This Distribution was loaded on Feb 04, 2006@06:22 with header of It consisted of the following Install(s): XU*8.0*378 Checking Install for Package XU*8.0*378 Will first run the Environment Check Routine, XU8P378E Begin STATE(#5) file environment check... Finished environment check. Install Questions for XU*8.0*378 Incoming Files: 5 STATE (Partial Definition) Note: You already have the 'STATE' File. Incoming Mail Groups: Enter the Coordinator for Mail Group 'XIP SERVER RESPONSE': [a VistA user] Want KIDS to Rebuild Menu Trees Upon Completion of Install? YES// NO Want KIDS to INHIBIT LOGONs during the install? YES// NO Want to DISABLE Scheduled Options, Menu Options, and Protocols? YES// NO Enter the Device you want to print the Install messages. You can queue the install by enter a 'Q' at the device prompt. Enter a '^' to abort the install. DEVICE: HOME// 0;P-OTHER;80;99999 Telnet Terminal Install Started for XU*8.0*378 : Feb 04, 2006@06:24:12 Build Distribution Date: Feb 04, 2006 Installing Routines:........... Feb 04, 2006@06:24:12 Installing Data Dictionaries: .. Feb 04, 2006@06:24:12 Installing PACKAGE COMPONENTS: Installing PRINT TEMPLATE... Installing SORT TEMPLATE... Installing MAIL GROUP.. Installing OPTION.. Feb 04, 2006@06:24:12 Running Post-Install Routine: ^XU8P378. Begin STATE(#5) file update... Finished STATE(#5) file update. Begin COUNTY CODE(#5.13) file corrections... Finished COUNTY CODE(#5.13) file corrections. Begin COUNTY CODE(#5.13) file pointer corrections... Finished COUNTY CODE(#5.13) file pointer corrections... Executing kill logic ... Deleting index definition ... Creating index definition ... Executing set logic ... Begin updating COUNTY multiple... Adding County: MANITOBA(260) to State: MANITOBA Finished updating COUNTY multiple. Updating Routine file...... Updating KIDS files....... XU*8.0*378 Installed. Feb 04, 2006@06:25:39 Install Message sent #nnnn Routine Information: ==================== The checksums below are new checksums, and can be checked with CHECK1^XTSUMBLD. Routine Name: XIPMAIL Before: n/a After: B2437876 **378** Routine Name: XIPMAILA Before: n/a After: B32407921 **378** Routine Name: XIPMAILB Before: n/a After: B33220563 **378** Routine Name: XIPPOST Before: B10187016 After: B7231902 **292,378** Routine Name: XIPSYNC Before: B5380874 After: B6027849 **328,378** Routine Name: XU8P378 Before: n/a After: B1308591 **378** Routine Name: XU8P378A Before: n/a After: B53936470 **378** Routine Name: XU8P378B Before: n/a After: B7374341 **378** Routine Name: XU8P378C Before: n/a After: B3548121 **378** Routine Name: XU8P378E Before: n/a After: B31143352 **378** ============================================================================= User Information: Entered By : ORMSBY,SKIP Date Entered : MAR 08, 2005 Completed By: SINGH,GURBIR Date Completed: APR 27, 2006 Released By : TILLIS,LEWIS Date Released : MAY 10, 2006 ============================================================================= Packman Mail Message: ===================== $END TXT