**************************************************************** INSTALL NOTES FOR IMMUNIZATION DATA EXCHANGE INTERFACE ================================================================ PREFIX: BYIM - IMMUNIZATION DATA EXCHANGE INTERFACE CURRENT VERSION: 3.0 Patch 10 PRIORITY: MANDATORY Release Date: October 2026 ================================================================ **** NOTE ***** NOTE **** NOTE **** NOTE **** NOTE **** NOTE *** **************************************************************** READ THE ENTIRE NOTES FILE PRIOR TO ATTEMPTING ANY INSTALLATION! **************************************************************** **** NOTE ***** NOTE **** NOTE **** NOTE **** NOTE **** NOTE *** ================================================================================ 1.0 GENERAL INFORMATION 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 with State immunization registry. The RPMS side of Immunization Interface Management Menu (IIMM) sends the complete immunization history for each patient to the respective state registry BYIM v3.0 Patch 10 changes: Patch 10 contains various technical and user adjustments to comply with development and functional requirements and user requests. Feature Description ------- --------------------------------------------------- 75649 Modify BYIM site parameter protection indicator field language. 105434 Update multiple births algorithm 110413 Use VISIT file pointer for finding refusal date and value 110504 Check for test versus production database flag 129892 Alert Message with Daily Summary Report 131749 Messaging process improvements 138184 Remove the disable journal command 2.0 Installation Notes 2.1 Prefix: BYIM 2.2 Current Version: Version 3.0 through Patch 9 2.3 Contents of Distribution byim0300.10k - KIDS file byim0300.10n - Patch release notes 2.4 System Requirements Kernel (XU) v8.0 p1018 or later FileMan (DI) v22.0 p1018 or later Generic Interface (GIS) v3.01 p17 or later Immunization Data Exchange (BYIM) v3.0 p9 2.5 Before You Begin a) Print and read all notes/readme files. b) Make a copy of this distribution for offline storage. c) It is recommended that the terminal output during the installation be captured. This will insure a printed audit trail if any problems should arise. To capture terminal output during the installation, use an auxport printer attached to the terminal on which you are performing the installation. d) Make sure you have the correct database privileges. e) If your site is set up to transmit immunization data exports to your state immunization registry, you ensure the following: 1) Work with your IT staff to make sure the GIS - OUTPUT CONTROLLER and FORMAT CONTROLLER are running. 2.6 Post Installation Action a)  Update the Ensemble/IRIS local production. 1) Drop out of RPMS to a programmers prompt and run the command below. 2) D UDTPROD^BYIMRTN          3) Note :This routine call will add three Business Services to the Local production while removing one Business Service.  It also changes the class of the Email Alerts Business Operation.   b)  Add new Error Summary task 1) From the Ensemble/IRIS management portal home page, select System Operation | Task Manager | New Task 2) Set the Task name field to, BYIM Error Summary 3) Set the Description field to, Creates a Summary email for the errors generated today within the BYIM local production 4) Set the Namespace to run task in field to, your BYIM namespace 5) Set the Task type field to, BYIM.Task.AlertSummary 6) Set the Run task as this user field to, _SYSTEM 7) select the Next button 8) Set the Run once at this time field to, a time in the afternoon/ evening. This summary pulls information from the alerts created for the day it runs, it is suggested to run this task no later than 11:00 pm and no earlier than 4:00 PMlocal time. 9) Note: there will only be a summary report email created if the site experiences errors during the day the task runs. 3.0 Installation Instructions 3.1 Select Option Name: XPD MAIN (KIDS Menu). 3.2 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 byim0300.10k. For example: /usr/import/byim0300.10k c) At the 'OK to continue with Load?' prompt, type 'Y' and press Enter. d) At the 'Want to Continue with Load?' prompt, press Enter (Yes). e) At the 'Want to RUN the Environment Check Routine?' prompt, press Enter (Yes). 3.3 Select Installation Option 6, Install Package(s). Install name: BYIM*3.0*10 3.4 At the 'DEVICE: ' prompt, do one of the following: Press Enter to print the output to your terminal, or Enter the auxport printer to print the output on paper. 4.0 Sample Installation CMBB>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: Installa tion 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: c:\users\patches\byim\byim0300.10k KIDS Distribution saved on Aug 11, 2026@12:12:56 Comment: BYIM Immunization Data Exchange Version 3.0 Patch 10 This Distribution contains Transport Globals for the following Package(s): BYIM*3.0*10 Distribution OK! Want to Continue with Load? YES// Loading Distribution... Build BYIM*3.0*10 has an Environmental Check Routine Want to RUN the Environment Check Routine? YES// BYIM*3.0*10 Will first run the Environment Check Routine, BYIMPATC Checking Environment for the installation of BYIM IMMUNIZATION DATA EXCHANGE v3.0, Patch 10. Systems Requirements Package/Vers/Patch: Version Patch ------------------- ----------- --------- XU v8.0 p1018: present present DI v22.0 p1018: present present GIS v3.01 p17 : present present BYIM v3.0 p9 : present present ENVIRONMENT OK. Press RETURN: 1 Use INSTALL NAME: BYIM*3.0*10 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: 6 Install Package(s) Select INSTALL NAME: BYIM*3.0*10 Loaded from Distribution 8/11/26@12:1 5:33 => BYIM Immunization Data Exchange Version 3.0 Patch 10 ;Created on Aug This Distribution was loaded on Aug 11, 2026@12:15:33 with header of BYIM Immunization Data Exchange Version 3.0 Patch 10 ;Created on Aug 11, 202 6@12:12:56 It consisted of the following Install(s): BYIM*3.0*10 Checking Install for Package BYIM*3.0*10 Will first run the Environment Check Routine, BYIMPATC Checking Environment for the installation of BYIM IMMUNIZATION DATA EXCHANGE v3.0, Patch 10. Systems Requirements Package/Vers/Patch: Version Patch ------------------- ----------- --------- XU v8.0 p1018: present present DI v22.0 p1018: present present GIS v3.01 p17 : present present BYIM v3.0 p9 : present present ENVIRONMENT OK. Press RETURN: 1 Install Questions for BYIM*3.0*10 Incoming Files: 90480 IZ PARAMETERS (Partial Definition) Note: You already have the 'IZ PARAMETERS' File. 90480.2 IZ HL7 MESSAGES (Partial Definition) Note: You already have the 'IZ HL7 MESSAGES' File. 90480.95 BYIM CLASS TRANSPORT (including data) Note: You already have the 'BYIM CLASS TRANSPORT' File. I will OVERWRITE your data with mine. Enter the Device you want to print the Install messages. Enter a '^' to abort the install. DEVICE: HOME// Virtual Install Started for BYIM*3.0*10 : Aug 11, 2026@12:15:45 Build Distribution Date: Aug 11, 2026 Installing Routines: Aug 11, 2026@12:15:45 Running Pre-Install Routine: V3P10PRE^BYIMPATC Installing Data Dictionaries: Aug 11, 2026@12:15:45 Installing Data: Aug 11, 2026@12:15:45 Running Post-Install Routine: V3P10PST^BYIMPATC Starting local production Pre-Install routine Starting local production Post-Install routine Importing BYIM version 3 patch 10 Ensemble/IRIS classes List started on 08/11/2026 12:15:45 Listing file C:\InterSystems\HealthShare\mgr\Temp\UgYozine8RX94Q.xml as xml List finished successfully. Load started on 08/11/2026 12:15:45 Loading file C:\InterSystems\HealthShare\mgr\Temp\OOVfsFbPtCtXpg.xml as xml Imported class: BYIM.Adapter.Inbound.Global Imported class: BYIM.Adapter.Inbound.GlobalQBP Imported class: BYIM.Adapter.Inbound.GlobalVXU Imported class: BYIM.Operations.HTTPclient Imported class: BYIM.Operations.SOAPclient Imported class: BYIM.Operations.VPNclient Imported class: BYIM.Operations.eMail Imported class: BYIM.Processes.HL7 Imported class: BYIM.Processes.ProccessIssue Imported class: BYIM.Services.API Imported class: BYIM.Services.Global Imported class: BYIM.Services.GlobalQBP Imported class: BYIM.Services.GlobalVXU Imported class: BYIM.Services.TaskEntry Imported class: BYIM.Task.AlertSummary Imported class: BYIM.Util.CleanUp Imported class: BYIM.Util.Functions Imported class: BYIM.Util.Install Imported class: BYIM.Util.STAT Compiling 19 classes Compiling class BYIM.Adapter.Inbound.Global Compiling class BYIM.Adapter.Inbound.GlobalQBP Compiling class BYIM.Adapter.Inbound.GlobalVXU Compiling class BYIM.Operations.SOAPclient Compiling class BYIM.Operations.HTTPclient Compiling class BYIM.Operations.eMail Compiling class BYIM.Operations.VPNclient Compiling class BYIM.Services.Global Compiling class BYIM.Services.API Compiling class BYIM.Services.GlobalQBP Compiling class BYIM.Task.AlertSummary Compiling class BYIM.Util.CleanUp Compiling class BYIM.Util.Functions Compiling class BYIM.Services.GlobalVXU Compiling class BYIM.Util.STAT Compiling class BYIM.Util.Install Compiling class BYIM.Services.TaskEntry Compiling class BYIM.Processes.HL7 Compiling class BYIM.Processes.ProccessIssue Compiling table BYIM_Processes.HL7_MessagesReceived Compiling table BYIM_Processes.HL7_MessagesSent Compiling table BYIM_Processes.ProccessIssue_MessagesReceived Compiling table BYIM_Processes.ProccessIssue_MessagesSent Compiling table BYIM_Processes.HL7__SynchronizedResponses Compiling table BYIM_Processes.ProccessIssue__SynchronizedResponses Compiling table BYIM_Processes.ProccessIssue Compiling table BYIM_Processes.HL7 Compiling routine BYIM.Operations.SOAPclient.1 Compiling routine BYIM.Adapter.Inbound.GlobalQBP.1 Compiling routine BYIM.Adapter.Inbound.Global.1 Compiling routine BYIM.Operations.VPNclient.1 Compiling routine BYIM.Operations.HTTPclient.1 Compiling routine BYIM.Adapter.Inbound.GlobalVXU.1 Compiling routine BYIM.Operations.eMail.1 Compiling routine BYIM.Processes.HL7MessagesReceived.1 Compiling routine BYIM.Processes.HL7SynchronizedResponses.1 Compiling routine BYIM.Processes.HL7MessagesSent.1 Compiling routine BYIM.Services.API.1 Compiling routine BYIM.Processes.ProccessIssueSynchronizedResponses.1 Compiling routine BYIM.Processes.ProccessIssueMessagesReceived.1 Compiling routine BYIM.Services.Global.1 Compiling routine BYIM.Processes.ProccessIssueMessagesSent.1 Compiling routine BYIM.Task.AlertSummary.1 Compiling routine BYIM.Services.GlobalQBP.1 Compiling routine BYIM.Services.GlobalVXU.1 Compiling routine BYIM.Services.TaskEntry.1 Compiling routine BYIM.Util.CleanUp.1 Compiling routine BYIM.Util.Functions.1 Compiling routine BYIM.Util.Install.1 Compiling routine BYIM.Processes.ProccessIssue.1 Compiling routine BYIM.Util.STAT.1 Compiling routine BYIM.Processes.HL7.1 Compiling class BYIM.Processes.HL7.Context Compiling class BYIM.Processes.ProccessIssue.Context Compiling class BYIM.Processes.HL7.Thread1 Compiling class BYIM.Processes.ProccessIssue.Thread1 Compiling table BYIM_Processes_HL7.Context Compiling table BYIM_Processes_HL7.Thread1 Compiling table BYIM_Processes_HL7.Context__ResponseHandlers Compiling table BYIM_Processes_HL7.Thread1__ChildThreads Compiling table BYIM_Processes_ProccessIssue.Context Compiling table BYIM_Processes_ProccessIssue.Context__ResponseHandlers Compiling table BYIM_Processes_HL7.Thread1__PendingResponses Compiling table BYIM_Processes_ProccessIssue.Thread1 Compiling table BYIM_Processes_ProccessIssue.Thread1__PendingResponses Compiling table BYIM_Processes_ProccessIssue.Thread1__ChildThreads Compiling routine BYIM.Processes.HL7.Thread1ChildThreads.1 Compiling routine BYIM.Processes.HL7.ContextResponseHandlers.1 Compiling routine BYIM.Processes.ProccessIssue.ContextResponseHandlers.1 Compiling routine BYIM.Processes.HL7.Context.1 Compiling routine BYIM.Processes.HL7.Thread1.1 Compiling routine BYIM.Processes.HL7.Thread1PendingResponses.1 Compiling routine BYIM.Processes.ProccessIssue.Context.1 Compiling routine BYIM.Processes.ProccessIssue.Thread1ChildThreads.1 Compiling routine BYIM.Processes.ProccessIssue.Thread1PendingResponses.1 Compiling routine BYIM.Processes.ProccessIssue.Thread1.1 Load finished successfully. BYIM*3.0*10 -------------------------------------------------------------------------------- Updating 90480.95 record Compilation started on 08/11/2026 12:15:47 with qualifiers 'ck' Compiling class BYIM.Productions.Local Compiling routine BYIM.Productions.Local.1 Compilation finished successfully in 0.056s. Updating Routine file... Updating KIDS files... BYIM*3.0*10 Installed. Aug 11, 2026@12:15:47 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: CMBB>D UDTPROD^BYIMRTN CMBB> 4.1  Remember to perform the step listed in section 2.6 Post Installation. CMBB>D UDTPROD^BYIMRTN 5. POINT OF CONTACT OIT User Support (IHS) Phone: 1-888-830-7280 (toll free) Web: https://www.ihs.gov/itsupport/ Email: itsupport@ihs.gov