When you enter the HL7 Message Modifier filter's configuration options for the first time, you are presented with a page that prompts you to load sample messages.

Loading a Sample Message

You can manage sample messages by performing the following actions:

Adding a Sample Message

To add a new sample message:

  1. Click the Sample Messages link at the top or select the icon (if no message has been selected) to display the Sample Message Manager dialog: 

  2. Enter a message name in the Message Name field.
  3. Either upload a sample message file using the Filename Browser or enter the message contents manually in the Sample Message Contents field.
  4. Click the Add as a New Message link to add the message to the sample message list.
  5. Select the Close button to exit the Sample Message Manager dialog.

Selecting a Sample Message

To select a sample message to test your changes, select the message name from the drop-down list next to the Sample Messages link.

Editing a Sample Message

To edit a sample message:

  1. In the Sample Message Manager, click the message name in the Loaded Sample Messages Table. The icon appears next to the name to indicate it is being edited.
  2. Edit the sample message in the Sample Message Contents field or change the message name in the Message Name field.
  3. Click the Apply changes to Message link to save the changes in the message.
  4. Select the Close button to exit the Sample Message Manager dialog.

Cloning a Sample Message

To clone an existing sample message:

  1. In the Sample Message Manager, click the message name in the Loaded Sample Messages Table. The icon appears next to the name to indicate it is being edited.
  2. Change the message name in the Message Name field.
  3. Edit the message in the Sample Message Contents field if required.
  4. Click the Add as a New Message link to add the message to the sample message list.
  5. Select the Close button to exit the Sample Message Manager dialog.

Deleting a Sample Message

To delete a sample message, select the icon.

Modifying a Change Group

After you have loaded (or selected) a sample message, the sample input message and its modified version (sample result) are displayed. You can then add or modify change groups by performing the following actions:

Configuration Element

Description

Navigation Panel

Contains the All Changes link, Add New Change Group button and user-created change groups.

Sample Input Message Panel

If Message is toggled on, a read-only version of the input sample message is displayed.

If Properties is toggled on, then a list of properties and variables referenced in your changes (rules) is displayed along with input boxes alongside them enabling you to modify the test values they store.

Sample Result Panel

If Message is toggled on, the result of applying all changes defined under the selected change group to the sample message in the Sample Input Message Panel. Changes are highlighted in green.

If you modify a field to a value which includes the field separator (in other words, turning one field into multiple fields, for example, value1|value2|value3), the highlighting will not work properly from that point onwards. This limitation does not apply to values that include only component and sub-component separators.

If Properties is toggled on, then a read-only list of modified properties is displayed.

Change Group Name Field

Mandatory field used to enter the change group name.

Change Group Description Field

Recommended field used to enter a change group description.

Define A Segment to Modify Link

Click to display the Define A Segment to Modify dialog. Refer to Defining a Segment for details.

Sample Messages Link

Click to display the Sample Message Manager. Refer to Loading a Sample Message for details.

Sample Messages Selector

A drop-down list that allows you to select a loaded sample message.

Add New Change Group Button

Select to add a new change group.

Adding a Change Group

To create a new change group:

  1. Select the  button. A new change group called Untitled is added to the Navigation Panel.
  2. Enter a change group name into the Change Group Name field.
  3. It is recommended you enter a description of the change group in the Description field.
  4. If this is the first change group being added to the filter, add a sample message. Refer to Adding a Sample Message for details.
  5. Click the Ok link to save your changes or the Cancel link to discard them. A page that lists the change group's details (in read-only mode) is displayed.
  6. To add a segment to your change group for modification, refer to Adding a Segment for details.

Viewing a Change Group

To view a change group, click on its name in the Navigation Panel.

Editing a Change Group

To edit the change group name or description, click the Edit link.

Deleting a Change Group

To delete a change group, select the icon which appears when you hover the mouse over the change group name in the Navigation Panel.