Healthcare Mirroring
InterSystems IRIS for Health® and HealthShare Health Connect® use the same core mirroring technology as InterSystems IRIS to provide high availability and disaster recovery. However, these products also include additional components that require special consideration during mirror setup and maintenance. This topic describes those additional requirements and the extra steps needed to ensure proper mirror operation.
Most configuration tasks, such as creating a mirror set, defining failover and DR async members, and managing mirror status, follow the instructions in the High Availability Guide. This page adds healthcare-specific requirements needed to ensure that interoperability and healthcare configuration data are correctly synchronized across all mirror members.
When configuring mirroring for healthcare products, additional setup is required to:
-
Mirror the HSSYS database, which stores interoperability configuration and other healthcare system data not mirrored automatically.
-
Enable the HS_Services user and update its password and interoperability credential.
-
Schedule and verify the Mirror Monitor Agent task that synchronizes configuration data in IRISSYS.
-
Use the Installer Wizard to create a Foundation namespace with the correct mirrored database configuration.
The following steps are required for reliable mirroring and recoverability in InterSystems IRIS for Health and Health Connect deployments. These actions must be completed as described on this page:
Completing these steps ensures that mirrored healthcare systems remain stable and synchronized.
For an overview of standard mirroring concepts and setup, see Mirroring Overview and Managing Mirroring. The following sections describe how to apply these concepts when configuring healthcare mirroring.
Prerequisites
Before configuring healthcare mirroring, ensure your existing InterSystems IRIS for Health or Health Connect mirror is correctly configured and operational.
Base Mirror Configuration
Healthcare mirroring assumes a stable base mirror configuration:
-
Confirm that your mirror set, failover members, and any DR async members are configured according to the general mirroring procedures in Configuring Mirroring.
-
Verify that mirroring and journaling are functioning normally on all members.
Version and Instance Compatibility
All mirror members must meet the InterSystems IRIS instance compatibility requirements. These include version alignment, locale and character-width compatibility, and consistent database block size settings.
For details, see InterSystems IRIS Instance Compatibility.
Mirror Health Validation
Before performing any healthcare-specific setup, verify that all mirrored databases report a Caught Up or Synchronized status in the Mirror Monitor of all backup failover and async mirror members.
If mirror members are not fully synchronized, follow the Activate and Catch Up the Mirrored Database procedure in Restore a Mirrored Database from Backup. Ensure that all members are fully synchronized before proceeding with healthcare-specific mirroring steps.
Network Host Name Configuration
To ensure reliable connectivity for mirrored healthcare systems, configure a network host name that provides a consistent connection point for downstream systems. This can be a virtual IP (VIP) or a proxy address that always directs traffic to the active primary mirror member. Configure the network host name after creating and activating the Foundation namespace.
For detailed instructions and platform-specific considerations, see Configuring a Mirror Virtual IP (VIP).
After configuration, verify the network host name by opening the Installer Wizard and selecting Configure Network Name. The displayed value should match the VIP or proxy hostname used for the mirror.
Foundation Namespaces
To begin healthcare mirroring, create a Foundation namespace using the Installer Wizard. The Foundation namespace contains healthcare interoperability configurations and mappings required by InterSystems IRIS for Health and Health Connect.
See Create and Activate a Foundation Namespace for complete instructions.
Configuring Mirror Members for Healthcare Environments
This section describes how to configure healthcare-specific components on each mirror member. These steps ensure that interoperability services and system configurations remain synchronized across mirror members.
Enable and Update the HS_Services User
The HS_Services user provides the credentials used by interoperability components in mirrored healthcare systems. The user must be enabled and synchronized across all mirror members.
To enable the user and update its password, follow the procedure below on the primary mirror member:
-
Open the Management Portal and switch to the HSSYS namespace.
-
Navigate to System Administration > Security > Users.
-
Find the HS_Services user in the list of user definitions.
-
Click the Profile option in the HS_Services user row.
-
In the HS_Services user profile, select Edit User and navigate to the General tab.
-
Select Enter new password and set a secure password.
-
Select the User enabled option.
-
Click Save to update the user definition.
After completing these steps on the primary member, repeat the procedure on all other mirror members, setting the password to match the one configured on the primary.
Once the HS_Services user is enabled and synchronized with a secure password on all mirror members, update the associated interoperability credential on the primary mirror member:
-
Verify that the current namespace is HSSYS.
-
Navigate to Interoperability > Configure > Credentials in the Management Portal.
-
Locate and select the HS_Services credential.
-
Confirm that the User Name is HS_Services.
-
Enter the same password defined for the HS_Services user account. The HS_Services user definition password and interoperability credential must match.
-
Click Save to apply the changes.
For more information, see Defining Credentials.
Schedule the Mirror Monitor Agent
The Mirror Monitor Agent synchronizes configuration data stored in IRISSYS between the primary and non-primary mirror members. Scheduling this task ensures that application-generated configuration changes, such as updates to roles, resources, mappings, and CSP applications, remain consistent across all members.
The Mirror Monitor Agent replicates only changes made by the InterSystems IRIS for Health or Health Connect applications. It does not synchronize manual modifications made directly through the Management Portal (for example, user-created roles or CSP applications).
Information about the Mirror Monitor Agent can be viewed from the Health menu in the top banner, next to the Installer Wizard. This interface displays details about configuration steps that have been run. To ensure the displayed information remains accurate, a virtual IP (VIP) must be configured and operational. The VIP allows backup and DR members to notify the primary member of completed steps, ensuring the dashboard remains synchronized. For more information about VIPs, see Network Host Name Configuration.
To automatically configure and schedule this task, as well as mirror the HSSYS database, use the HSSYS Mirroring Utility.
Alternatively, manually schedule the task on each mirror member:
-
Open the Terminal.
-
Switch to the HSSYS namespace:
ZN "HSSYS" -
Schedule the Mirror Monitor Agent task by running:
do ##class(HS.Util.Mirror.Task).Schedule("HSSYS") -
Confirm that the task is scheduled to run every five minutes.
To verify the task:
-
In the Management Portal, navigate to System Operation > Task Manager > Task Schedule on each member.
-
Verify that the Task Schedule lists a task named Mirror Monitor Launch Task configured to run every five minutes in the HSSYS namespace.
-
Check that the next scheduled run time is within the expected interval.
Mirroring the HSSYS Database
The HSSYS database contains InterSystems IRIS system-level data required for InterSystems IRIS for Health and Health Connect. It includes information about Foundation namespaces, the Mirror Monitor Agent, and other healthcare configuration and interoperability settings. This database must be mirrored to maintain consistency across all mirror members.
Even if FHIR or other advanced healthcare features are not used and the system only processes HL7 messages, the HSSYS database must still be mirrored. The system assumes that HSSYS is mirrored, and omitting it can cause failures during upgrade or configuration steps.
The HSSYS Mirroring Utility can automatically perform HSSYS mirroring and validation. It also schedules the Mirror Monitor Agent. The following sections describes how to mirror HSSYS manually.
Add the HSSYS Database to the Mirror
To add the HSSYS database to the mirror configuration, follow this procedure on the primary member:
-
Open the Management Portal and navigate to System Administration > Configuration > System Configuration > Local Databases.
-
Choose Add to Mirror, select HSSYS, and then click Add.
-
Verify that the HSSYS database now appears in the list of mirrored databases.
Make the HSSYS Database Available to all Members
After adding HSSYS to the mirror on the primary member, follow the standard procedures for making mirrored databases available on other members, activating, and catching up.
See Copying an Existing Mirrored Database to Additional Members for the supported methods.
If required, after completing your chosen method, mount and synchronize the HSSYS database following the standard mirrored database procedures described in Restore a Mirrored Database from Backup.
Verify HSSYS Mirroring
On each mirror member:
-
In the Management Portal, navigate to System Operation > Mirror Monitor.
-
Confirm that the HSSYS database appears in the mirrored database list.
-
Verify that its mirror status shows Caught Up.
Additional Healthcare Database Considerations
When configuring healthcare mirroring, pay attention to which databases should or should not be mirrored:
-
Do not mirror HSLIB.
HSLIB contains code specific to InterSystems IRIS for Health and Health Connect features. This database must remain unmirrored to ensure proper operation on each member.
-
You must mirror HSSYS.
HSSYS stores interoperability configuration and other healthcare system data that must remain synchronized across all mirror members.
-
Optionally mirror HSCustom.
HSCustom contains user-defined code and extensions, separate from data, and may be optionally mirrored to keep code consistent across members.