Settings for HL7 Sequence Managers

Ensemble HL7 Version 2 Development Guide

Server:docs1

Instance:LATEST

User:UnknownUser


	[ Home ] > [ Ensemble Interoperability ] > [ Ensemble HL7 Version 2 Development Guide ] > [ Reference ] > [ Settings for HL7 Sequence Managers ]		Go to:		Search:

Provides reference information for settings of an HL7 sequence manager.

Summary

HL7 sequence managers have the following settings:

Group	Settings
Additional Settings	Enabled Duplicated Message Check, Perform Sequence Number Check On, Perform Output Transformation On, Output Sequence Number Index Field, Output Target Config Names, Message Wait Timeout, Passthrough Message Types, Out Of Sequence Message Notice Type, Out Of Sequence Message Target, Duplicated Message Notice Type, Duplicated Message Target, Output Facility Application, Message Resendable Time Window, Large Gap Size, Bypass Check On Internal Resent

Group

Settings

Additional Settings

Enabled Duplicated Message Check, Perform Sequence Number Check On, Perform Output Transformation On, Output Sequence Number Index Field, Output Target Config Names, Message Wait Timeout, Passthrough Message Types, Out Of Sequence Message Notice Type, Out Of Sequence Message Target, Duplicated Message Notice Type, Duplicated Message Target, Output Facility Application, Message Resendable Time Window, Large Gap Size, Bypass Check On Internal Resent

The remaining settings are common to all business processes. See “Settings for All Business Processes” in Configuring Ensemble Productions.

Bypass Check On Internal Resent

If this setting is true, the sequence manager bypasses checks on internal resent messages.

Duplicated Message Notice Type

Specifies the message type for a duplicated message notice. Specify either WorkflowRequest or OriginalMessage

Duplicated Message Target

The configured Name of an item within the production, usually a business operation. If specified, this is where the sequence manager sends any duplicate messages that it receives.

Enable Duplicated Message Check

If True, the sequence manager checks to see if any incoming messages are duplicates of a previously received message. It does this by checking the following three fields in the MSH segment of each message:

MSH:3 SendingApplication
MSH:4 SendingFacility
MSH:10 MessageControlId

A sequence manager can check for duplicate messages and messages out of sequence, duplicate messages or messages out of sequence, or neither. This makes Enable Duplicated Message Check entirely independent of Perform Sequence Number Check On in that either, one, or both of these settings may be True.

Large Gap Size

A number that indicates a significant gap in the sequence of messages; the default is 100.

A late message is a message that arrives with a sequence number larger than the previously received message in the sequence, but not exactly sequential. For example, when message 102 arrives after message 101, 102 is not late; it is the next message in sequence. However, when message 110 arrives after message 101, 110 is a late message.

When there is a late message, and the sequence numbering gap between the preceding and subsequent messages is less than the configured Large Gap Size, this is a small gap. A gap larger than this is a large gap.

For any small gap, the sequence manager waits for Message Wait Timeout seconds to see if messages arrive to fill the gap. If the messages arrives within the waiting period, the sequence manager aligns them in their proper sequence. If they do not arrive and the Message Wait Timeout expires, the sequence manager stops waiting and sends whatever it has for messages in the current sequence.
When there is a large gap, the sequence manager does not wait for any period of time. It immediately sends an alert, then sends whatever it has for messages in the current sequence.

Message Resendable Time Window

Time window during which the sequence manager considers a duplicate message to be a duplicate. The reason for the Message Resendable Time Window is that sometimes a duplicate message is not a mistake. Sometimes it is the result of deliberately resending a message sequence.

Suppose a message arrives and the sequence manager detects that it is a duplicate of a previously received message. In this case:

If it has been more than Message Resendable Time Window seconds since the sequence manager first saw this message, it interprets the new arrival as a deliberately resent copy. The sequence manager begins tracking the messages in this resent sequence independently from its tracking of the main sequence of messages.

Suppose the sequence manager is processing a sequence that includes numbers such as 1001, 1002, 1003, and 1004, but at the same time it begins receiving messages with the sequence numbers 1, 2, and 3. If the older messages with smaller sequence numbers were first received more than Message Resendable Time Window seconds ago, the sequence manager interprets them as messages in a resent sequence, rather than as messages out of sequence. It begins tracking the main sequence and the resent sequence simultaneously. While doing so, it keeps the two sequences separate, appropriately ignoring gaps between unrelated sequence numbers such as 2 and 1001.
If it has been less than Message Resendable Time Window seconds since the sequence manager first saw this message, the new arrival is understood to be a true duplicate, and the sequence manager handles it appropriately. See Enable Duplicated Message Check.

The default Message Resendable Time Window is 300 seconds (5 minutes).

Message Wait Timeout

For definitions of large gaps, small gaps, and late messages, see the Large Gap Size setting.

For any small gap, the sequence manager waits for Message Wait Timeout seconds to see if messages will arrive to fill the gap between the preceding message and the late message. If they do not arrive and the Message Wait Timeout expires, the sequence manager stops waiting and sends whatever it has for messages in the current sequence.

The default Message Wait Timeout is 60.

Out Of Sequence Message Notice Type

Specifies the message type for an out-of-sequence message notice. Specify either WorkflowRequest or OriginalMessage

Out Of Sequence Message Target

The configured Name of an item within the production, usually a business operation. If specified, this is where the sequence manager sends any out-of-sequence message notices.

Output Facility Application

Specifies the facility and application to be used in the message transformation when Perform Output Transformation On is set to Sender or Receiver.

The format for the Output Facility Application value is:

Facility :Application

Output Sequence Number Index Field

Controls the fields on which the output sequence number is incremented. Specify one of the following values:

Sender — The index fields are MSH:3 SendingApplication and MSH:4 SendingFacility.
Receiver — The index fields are MSH:5 ReceivingApplication and MSH:6 ReceivingFacility.
Auto — The value of this setting is controlled by the Perform Output Transformation On setting. If Perform Output Transformation On is Receiver, then Output Sequence Number Index Field is Receiver. Otherwise, Output Sequence Number Index Field is Sender.

Output Target Config Names

A comma-separated list of configured items within the production. If specified, this list identifies the destinations to which the sequence manager will send any message that passes its tests.

Passthrough Message Types

A comma-separated list of message types that are exempt from duplicate checks, sequence checks, or output transformations. The sequence manager always passes these messages through unchanged. The default list is:

QBP_Q21,QBP_Q22,RSP_K21,RSP_K22,ACK

Perform Output Transformation On

Specifies fields to transform before sending out a message. The output transformation provides new facility, application, and sequence number fields as described in the following list, then sends the message to its configured targets. Possible values for Perform Output Transformation On are:

Sender — This is the default. The sequence manager copies Facility and Application from the Output Facility Application setting and assigns a new sequence number. The result is that the following fields are changed in the outgoing message:
- MSH:3 SendingApplication
- MSH:4 SendingFacility
- MSH:13 SequenceNumber
Receiver — The sequence manager copies Facility and Application from the Output Facility Application setting and assigns a new sequence number. The result is that the following fields are changed in the outgoing message:
- MSH:5 ReceivingApplication
- MSH:6 ReceivingFacility
- MSH:13 SequenceNumber
None — The sequence manager does not perform any transformation before sending the message.

Perform Sequence Number Check On

Specifies the fields to check to see if any of the incoming messages are out of sequence. If so, the sequence manager resequences the messages and sends them to its configured targets.

Possible values are:

Sender — This is the default. The sequence manager checks:
- MSH:3 SendingApplication
- MSH:4 SendingFacility
- MSH:13 SequenceNumber
SendingFacility — The sequence manager checks:
- MSH:4 SendingFacility
- MSH:13 SequenceNumber
SendingApplication — The sequence manager checks:
- MSH:3 SendingApplication
- MSH:13 SequenceNumber
Receiver — The sequence manager checks:
- MSH:5 ReceivingApplication
- MSH:6 ReceivingFacility
- MSH:13 SequenceNumber
ReceivingFacility — The sequence manager checks:
- MSH:6 ReceivingFacility
- MSH:13 SequenceNumber
ReceivingApplication — The sequence manager checks:
- MSH:5 ReceivingApplication
- MSH:13 SequenceNumber
None — The sequence manager does not check for messages out of sequence.

A sequence manager can check for duplicate messages and messages out of sequence, duplicate messages or messages out of sequence, or neither. This makes Enable Duplicated Message Check entirely independent of Perform Sequence Number Check On in that, either one, or both of these settings may be True.