Configuring the IBM Master Data Management HL7 message broker rule engine

Configure the IBM Master Data Management HL7 message broker rule engine to define how HL7 v2 messages are transformed, routed, and responded to by the message broker.

Before you begin

Before you begin, ensure that the message broker application is configured with the appropriate data types and instance metadata. For more information, see Configuring the HL7 message broker application.

Download the default models, algorithms, and rules to help you to configure the HL7 message broker. The downloadable archive file contains the following default configuration files:

rule-engine-configuration.json
patient-model.json
patient-algorithm.json

About this task

The message broker uses a JSON-based rule engine configuration to define how HL7 v2 messages are processed. This configuration drives all field mappings, transformation events, and interaction handle definitions. IBM Master Data Management provides a default rule engine configuration with default mappings that align with standard HL7 PID (patient identification) segments.

The rule engine configuration includes:

Field mappings: Define how HL7 message fields map to IBM Master Data Management attributes.
Transformation events: Specify data transformations to apply before processing.
Interaction handles: Define how different HL7 message types are processed and responded to.

To configure the rule engine:

Procedure

Prepare your rule engine configuration in JSON format.

You can use the default rule engine configuration (rule-engine-configuration.json) provided in the downloadable archive, or create a custom configuration based on your business requirements.
Use the PUT rule engine API to upload the configuration:
```
PUT /mdm/v1/message_broker/rule_engine/{record_type}
```
Replace {record_type} with the record type you configured in the instance metadata (for example, patient).
In the request body, include your rule engine configuration JSON.

Use message_type as hl7_v2 for interacting with HL7 v2.5 message structures.

Results

The rule engine is configured and ready to process HL7 messages according to your defined mappings and transformations.

What to do next

After configuring the rule engine, you can configure specific interaction handles for different query types:

After configuring query capabilities, you can configure client authentication to secure communication with external systems. For more information, see Configuring HL7 message broker client authentication.