*******************************************************************
INSTALLATION NOTES FOR IMMUNIZATION DATA EXCHANGE INTERFACE Patch 7
================================================================
PREFIX:   BYIM - IMMUNIZATION DATA EXCHANGE INTERFACE
CURRENT VERSION:  2.0   Patch 7    PRIORITY: MANDATORY

Release Date: June 2015

================================================================
**** NOTE ***** NOTE **** NOTE **** NOTE **** NOTE **** NOTE *** 
****************************************************************
READ THE ENTIRE NOTES FILE PRIOR TO ATTEMPTING ANY INSTALLATION!
****************************************************************
**** NOTE ***** NOTE **** NOTE **** NOTE **** NOTE **** NOTE *** 
 
 
GENERAL INFORMATION
 
	a)  Print all notes/readme files.
 
	b)  It is recommended that the terminal output during the
        installation be captured.  This will insure a printed
        audit trail if any problems should arise.
    

Immunization Interface Management (BYIM), also known as Immunization
Data Exchange, is a two-way Generic Interface System (GIS) HL7 interface
that allows the exchange of immunization data for patients of all ages
with State immunization registries. 

The RPMS side of Immunization Interface Management Menu (IIMM) sends
the complete immunization history for each patient to the respective state
registry. IIMM is also capable of receiving and processing immunization
data that is returned from the State registries. 


1.0	Patch 7 adds the following changes:


1.01	Send PV1-7 "Assigning Authority" to the Immunization Registry.

1.02	Send PV1-9 "Assigning Authority" to the Immunization Registry.

1.03	Send ORC-17.1 "Identifier" to the Immunization Registry using
	the ASUFAC as the ORC-17.1 identifier to ensure character
	length remains within standard.

1.04	Send ORC-17.3 "Name of Coding System" to the Immunization
	Registry using the "RPMS" as the ORC-17.3 coding system.

1.05	Truncate PID-3.4 "Assigning Authority" to 20 characters.

1.06	Truncate first ORC Segment ORC-3.2 to 20 characters.

1.07	Truncate first RXA Segment RXA-11.4 to 20 characters.

1.08	Default to use "Family Name" if no NOK name on file in RPMS when
	sending NK1-2.1 data type.

1.09	Default to use "Last Name" if no "Responsible Person Record" on
	file in RPMS when sending NK1-2.1 data type.

1.10	Default to use "Given Name" when sending NK1-2.1 data type if not
	on file.

1.11	Change logic to get publication date from V IMMUNIZATION if
	available.



2.0	Installation Notes

2.1	Prefix: BYIM

2.2	Current Version: 2.0 through Patch 6

Note: Read entire notes file prior to attempting any installation.

2.3	Contents of Distribution

	byim0200.07k - KIDS file
	byim0200.07b - GIS Global file
	byim0200.07n - Patch release notes

2.4	System Requirements

	Kernel v 8.0 or later
	FileMan v 21/22
	IHS PCC Suite v2.0  with latest patches
	IHS/VA Utilities (XB/ZIB) v3.0 with latest patches
	Patient Information Management (PIMS) v5.3 with latest patches
	Generic Interface (GIS) v3.0 with latest patches
	BYIM Immunization Data Exchange Version 2.0 Patch 6
	IHS Immunization System (BI) v8.5 with latest patches

For sites with the ability to transmit immunization data to/from their
state immunization registry automatically, the SMM.

Note:	The site must have an account with their State Immunization
Registry for HTTPS secured transfer of the immunization data to the state.

2.5	Before You Begin

Make a copy of this distribution for offline storage.

Print all notes/readme files.

We recommend that you create a printed audit trail, in case there are
any problems with the installation.

To capture terminal output during the installation, use an auxport printer
attached to the terminal on which you are performing the installation.

Make sure you have the correct database privileges.
If your site is set up to transmit immunization data to/from your state
immunization registry, you must complete the following steps:



3.0	Installation Instructions

3.1	At a programmer prompt, kill the global ^INXPORT.

	>K ^INXPORT

3.2	Do a global restore of the byim0200.07b file.

Cache install:

	a)	At the prompt, type D ^%GI.

	b)	At the “Device” prompt, enter the path followed by the
		global file name. 

		For example: 	Unix:	 /usr/import/byim0200.07b
				Windows: d:\import\byim0200.07b

	c)	At the “Input option” prompt, type A.

	d)	At the next three prompts, press the Enter key to continue.

3.3	Select Option Name: XPD MAIN (KIDS Menu).

3.4	Select the Kernel Installation & Distribution System option:
	Installation.

	a)	Select Installation Option 1, Load a Distribution.

	b)	Enter the path filename of the Host File, byim0200.07k.
		For example: /usr/import/byim0200.07k

	c)	At the “OK to continue with Load?” prompt, type Y and
		press the Enter key.

	d)	At the “Want to Continue with Load?” prompt, press
		Enter (Yes).

	e)	At the “Want to RUN the Environment Check Routine?”
		prompt, press the Enter key (Yes).

3.5	Select Installation Option 6, Install Package(s).
	Install name: BYIM*2.0*7

3.6	At the “DEVICE:” prompt, do one of the following:
	Press the Enter key to print the output to your terminal, or
	Enter the auxport printer to print the output on paper.


4.0	Sample Installation

 
ETRN>K ^INXPORT
 
ETRN>D ^%GI
 
Global input
 
Device: z:\documents\byim0200.07b
Parameters? "RS" =>
Globals were saved on 28 May 2015  10:57 PM   Cache
with description:
 
Input option: a
^INXPORT
ETRN>
 
ETRN>D ^XUP
 
Setting up programmer environment
This is a TEST account.
 
Terminal Type set to: C-VT100
 
Select OPTION NAME: XPD MAIN       Kernel Installation & Distribution System
 
 
          Edits and Distribution ...
          Utilities ...
          Installation ...
          Patch Monitor Main Menu ...
 
 

Select Kernel Installation & Distribution System Option: Installation
 
 
   1      Load a Distribution
   2      Verify Checksums in Transport Global
   3      Print Transport Global
   4      Compare Transport Global to Current System
   5      Backup a Transport Global
   6      Install Package(s)
          Restart Install of Package(s)
          Unload a Distribution
 
 
Select Installation Option: Load a Distribution
Enter a Host File: z:\documents\byim0200.07k
 
KIDS Distribution saved on May 28, 2015@22:55:19
Comment:  BYIM Immunization Data Exhange Version 2.0 Patch 7
 
This Distribution contains Transport Globals for the following Package(s):
OK to continue with Load? NO// y  YES
 
Distribution OK!
 
Want to Continue with Load? YES//
Loading Distribution...
 
Build BYIM*2.0*7 has an Environmental Check Routine
Want to RUN the Environment Check Routine? YES//
   BYIM*2.0*7
Will first run the Environment Check Routine, BYIMIMM
 
Use INSTALL NAME: BYIM*2.0*7 to install this Distribution.
 
 
 
   1      Load a Distribution
   2      Verify Checksums in Transport Global
   3      Print Transport Global
   4      Compare Transport Global to Current System
   5      Backup a Transport Global
   6      Install Package(s)
          Restart Install of Package(s)
          Unload a Distribution
 
 
Select Installation Option: 2  Verify Checksums in Transport Global
Select INSTALL NAME:    BYIM*2.0*7     Loaded from Distribution     Loaded from
Distribution  5/28/15@22:58:43
     =>  BYIM Immunization Data Exhange Version 2.0 Patch 7  ;Created on May 2
 
This Distribution was loaded on May 28, 2015@22:58:43 with header of
    BYIM Immunization Data Exhange Version 2.0 Patch 7  ;Created on May 28, 2015
@22:55:19
   It consisted of the following Install(s):
     BYIM*2.0*7
 
Want each Routine Listed with Checksums: Yes//   YES
DEVICE: HOME//   CONSOLE
 
 

 
 
PACKAGE: BYIM*2.0*7     May 28, 2015 10:58 pm                         PAGE 1
-------------------------------------------------------------------------------
 
 
BYIMD     Calculated    9550701
BYIMIMM   Calculated  199850524
BYIMIMM1  Calculated  206634284
BYIMIMM2  Calculated  184224499
BYIMIMM3  Calculated  215622730
BYIMIMM4  Calculated  147292105
BYIMIMM5  Calculated   34391424
BYIMIMM6  Calculated   57875197
BYIMMU2   Calculated   95740137
BYIMMU21  Calculated  105034120
BYIMPORT  Calculated  194889555
BYIMRT    Calculated  212683201
BYIMSEG1  Calculated  201347527
BYIMSEGS  Calculated  195728389
BYIMXIS   Calculated    6176319
 
   15 Routines checked, 0 failed.
 
 
 
   1      Load a Distribution
   2      Verify Checksums in Transport Global
   3      Print Transport Global
   4      Compare Transport Global to Current System
   5      Backup a Transport Global
   6      Install Package(s)
          Restart Install of Package(s)
          Unload a Distribution
 
 
Select Installation Option: 6  Install Package(s)
Select INSTALL NAME:    BYIM*2.0*7     Loaded from Distribution     Loaded from
Distribution  5/28/15@22:58:43
     =>  BYIM Immunization Data Exhange Version 2.0 Patch 7  ;Created on May 2
 
This Distribution was loaded on May 28, 2015@22:58:43 with header of
    BYIM Immunization Data Exhange Version 2.0 Patch 7  ;Created on May 28, 2015
@22:55:19
   It consisted of the following Install(s):
     BYIM*2.0*7
Checking Install for Package BYIM*2.0*7
Will first run the Environment Check Routine, BYIMIMM
 
 
Install Questions for BYIM*2.0*7
 
Incoming Files:
 
 
   90480     IZ PARAMETERS
Note:  You already have the 'IZ PARAMETERS' File.
 
 
   90480.1   IZ EXPORTS
Note:  You already have the 'IZ EXPORTS' File.
 
 
   90480.2   IZ REAL-TIME QUERY
Note:  You already have the 'IZ REAL-TIME QUERY' File.
 
 
   90480.3   IZ TRANSPORT FILES
Note:  You already have the 'IZ TRANSPORT FILES' File.
 
 
   90480.4   IZ OBX SEGMENTS
Note:  You already have the 'IZ OBX SEGMENTS' File.
 
 
   90480.5   IZ NOS TABLE  (including data)
Note:  You already have the 'IZ NOS TABLE' File.
I will OVERWRITE your data with mine.
 
 
   90480.6   IZ RELATIONSHIP MAPPING
Note:  You already have the 'IZ RELATIONSHIP MAPPING' File.
 
 
   90480.7   IZ CDC RELATIONSHIP CODES  (including data)
Note:  You already have the 'IZ CDC RELATIONSHIP CODES' File.
I will OVERWRITE your data with mine.
 
 
   90480.8   IZ CONTRAINDICATION CODES  (including data)
Note:  You already have the 'IZ CONTRAINDICATION CODES' File.
I will OVERWRITE your data with mine.
 
Incoming Mail Groups:
 
Enter the Coordinator for Mail Group 'BYIM EXPORT/IMPORT GROUP': LOVE,TOM//
 
 
 
 
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//   CONSOLE
 

 
 
                                   BYIM*2.0*7
*******************************************************************************
 
 Installing LIST TEMPLATE
 
 Installing OPTION
               May 28, 2015@22:59
 
 Running Post-Install Routine: P7^BYIMIMM2
 
 Updating Routine file...
 
 Updating KIDS files...
 
 BYIM*2.0*7 Installed.
               May 28, 2015@22:59
 
 Not a VA primary domain
 
 NO Install Message sent
*******************************************************************************
          **************************************************************
  100%    *             25             50             75               *
Complete  **************************************************************
 
 
 
Install Completed
 
 
 
 
   1      Load a Distribution
   2      Verify Checksums in Transport Global
   3      Print Transport Global
   4      Compare Transport Global to Current System
   5      Backup a Transport Global
   6      Install Package(s)
          Restart Install of Package(s)
          Unload a Distribution
 
 

Select Installation Option:




5.0	Contact Information

If you have any questions or comments regarding this distribution,
please contact OIT User Support (IHS).

Phone:	(888) 830-7280 (toll free)

Web: http://www.ihs.gov/helpdesk/

Email:	support@ihs.gov
