Using the HL7 Binding Component

Communication Controls

The last page of the HL7 Binding Wizard, the Communication Controls page, provides configuration properties for the communication controls and recourse actions that control the sending and receiving of messages over a TCP/IP connection. These properties are defined by the Communication Control WSDL Extensibility Element, and help establish the Quality of Service (QoS) between the HL7 external system and HL7 endpoints.

The communication controls differ for inbound or outbound endpoints, therefore different pages are provided for inbound or outbound.

The recourse actions supported by the HL7 Binding Component can include the following values:

Each property in the table below allows you to enable or disable the control, select a value, and select a recourse action. If you do not enable the control, any setting you configure for that control are ignored.

Table 1 Inbound Communication Controls

Property 

Description 

MAX_NAK_SENT 

The maximum number of NAKs, the binding component sends to the client before executing the recourse action. A negative acknowledgment is sent from the HL7 inbound endpoint when the received message from client is invalid. An invalid message, according to the HL7 specification, is one that fails MSH segment validation or has an invalid sequence number.  

  • Value: An integer indicating the appropriate maximum number.

  • Recourse Actions: Suspend and Reset.

MAX_CANNED_NAK_SENT 

The maximum number of canned NAKs, the binding component sends to the client before executing the configured recourse action. This communication control deals with the case where the message received from client is invalid as per the HL7 specification rules for that particular message. 

  • Value: An integer indicating the appropriate maximum number.

  • Recourse Actions: Suspend and Reset.

Each property in the table below allows you to enable or disable the control, select a value, and select a recourse action. If you do not enable the control, any setting you configure for that control are ignored.

Table 2 Outbound Communication Controls

Property 

Description 

MAX_CONNECT_RETRIES 

The maximum number of connection retires the binding component will attempt before executing the recourse action.  

  • Value: The value is presented in the format: n1;n2,n1;n2,..., where n1 is the number of retry attempts to connect, and n2 is the interval (in seconds) between retry attempts. If the value of n1 is –1, it indicates that the number of retry attempts is indefinite.

  • Recourse Actions: Suspend and Error.

TIME_TO_WAIT_FOR_A_RESPONSE 

The amount of time the binding component waits for a response from the external system before executing the configured recourse action. 

  • Value: An integer indicating the time interval in seconds.

  • Recourse Actions: Resend, Reset, and Suspend.

MAX_NO_RESPONSE 

The maximum number of timeouts the binding component allows, while waiting for the response from external HL7 system, before executing the configured recourse action. This Communication Control is used in relationship with TIME_TO_WAIT_FOR_A_RESPONSE. The binding component resends the last sent message for each timeout until the configured maximum number of timeouts is exceeded. 

  • Value: An integer indicating the maximum allowable number of “no-responses” from the external HL7 system.

  • Recourse Actions: Suspend and Reset.

NAK_RECEIVED 

The recourse action the binding component will implement upon receiving a NAK from external system. There is no set value for this property other than enable and the selected recourse action. 

  • Recourse Action: Resend, Reset, and Skipmessage.

MAX_NAK_RECEIVED 

The maximum number of NAKs (negative acknowledgments) that the binding component accepts before it executes the configured recourse action. 

  • Value: An integer indicating the maximum number of NAKs allowed.

  • Recourse Actions: Suspend, Reset, and Skipmessage.