Configuring the IBM Master Data Management HL7 message broker application

Configure the IBM Master Data Management HL7 message broker application by publishing data types and updating instance metadata to connect the message broker to your data model.

Before you begin

Before you begin, ensure that the message broker service is enabled and deployed. For more information, see Enabling the HL7 message broker service.

About this task

The message broker application requires data types and instance metadata configuration to process HL7 messages. IBM Master Data Management provides default data models and algorithms with predefined patient record types and patient_entity entity types. You can use these configurations as provided or customize them to match your business requirements. Download the default HL7 data models and algorithms.

To configure the HL7 message broker application:

Procedure

Publish the data types for your IBM Master Data Management instance.
You can use the default patient data model (patient-model.json) and algorithm (patient-algorithm.json) provided by IBM, or publish your own custom data types.
Note: If you choose to customize the default data models, ensure that the persist_comp_view parameter remains set to false. The HL7 message broker does not support persisted entity composite views.
```
"persist_comp_view": false
```
From the IBM Master Data Management Model service APIs, call the GET Instance Metadata API to retrieve the current instance metadata:
```
GET /mdm/model/v1/instance_metadata
```
In the response body, add the following broker section to configure the message broker:
```
"broker": [
  {
    "message_type": "hl7_v2",
    "record_type": "patient"
  }
]
```
The message_type value specifies the HL7 version (use hl7_v2 for HL7 v2.5 messages). The record_type value must match the record type defined in your published data model.
Call the PUT Instance Metadata API with the modified payload:
```
PUT /mdm/model/v1/instance_metadata
```

Results

The message broker is configured to use the specified record type from your data model. The message broker can now process HL7 messages and map them to the appropriate data structures.

What to do next

After configuring the message broker application, configure the rule engine to define how HL7 messages are transformed and routed. For more information, see Configuring the HL7 message broker rule engine.