The WSO2 ESB HL7 inbound protocol is a multi-tenant capable alternative to the WSO2 ESB HL7 transport. The HL7 inbound endpoint implementation is fully asynchronous and is based on the Minimal Lower Layer Protocol(MLLP) implemented on top of event driven I/O.
...
In the above inbound endpoint configuration, you will see that the endpoint is defined using the HL7 protocol and that all requests coming into this endpoint are directed to the main sequence.
HL7 inbound endpoint parameters
The following table provides information on the HL7 inbound endpoint parameters you can set:
| Parameter | Description | Default Value | Possible Values |
|---|---|---|---|
| inbound.hl7.Port | The port on which you need to run the MLLP listener. | N/A | You need to specify this. |
| inbound.hl7.AutoAck | Whether or not an auto acknowledgement should be sent on message receipt. If set to false, you can define the type of HL7 acknowledgement to be sent. For more information, see HL7 inbound endpoint mediation level properties. | true | true | false |
| inbound.hl7.ValidateMessage | This enables HL7 message validation. | true | true | false |
| inbound.hl7.TimeOut | The timeout interval in milliseconds to trigger a NACK message. | 10000 | [0..9]* |
| inbound.hl7.CharSet | The character set used for encoding and decoding messages. Some multi-byte character encodings (e.g. UTF-16, UTF-32) may result in byte values equal to the MLLP framing characters or byte values lower than 0x1F, resulting in errors. | UTF-8 | ISO-8859-1 UTF-8 US-ASCII |
| inbound.hl7.BuildInvalidMessages | If the inbound.hl7.ValidateMessage parameter is set to false and the incoming message is invalid, this parameter specifies whether the raw message received through the MLLP transport should be passed onto the mediation layer. | false | true | false |
| inbound.hl7.PassthroughInvalidMessages | If the inbound.hl7.BuildInvalidMessages parameter is set to true, this parameter notifies the Axis2 HL7 transport sender whether to use the raw message. | false | true | false |
| inbound.hl7.MessagePreProcessor | An implementation of the org.wso2.carbon.inbound.endpoint.protocol.hl7.HL7MessagePreprocessor interface can be defined here. It provides an extension point to intercept incoming messages before any type of message parsing occurs. | N/A | Fully qualified class name. |
| Anchor | ||||
|---|---|---|---|---|
|
Following are the mediation level properties that you can set in the HL7 inbound endpoint:
...
| Property | Description |
|---|---|
<property name="HL7_RESULT_MODE" value="ACK|NACK" scope="default"/> | This is use to define the type of HL7 acknowledgement to be sent. If the inbound.hl7.AutoAck parameter is set to true this property has no effect. |
<property name="HL7_NACK_MESSAGE" value="<ERROR MESSAGE>" scope="default" /> | This is used to define a custom error message to be sent if you have set the property HL7_RESULT_MODE as NACK. |
<property name="HL7_APPLICATION_ACK" value="true" scope="default"/> | If the inbound.hl7.AutoAck parameter is set to false and no immediate auto generated ACK is sent back to the client, this property defines whether we should automatically generate the ACK for the request once the mediation flow is complete. If both the inbound.hl7.AutoAck parameter and this property are set to false, you need to generate an ACK message in the correct format as a response. |
Tuning the HL7 inbound endpoint
The HL7 inbound endpoint can be configured using the <ESB_HOME>/repository/conf/hl7.properties file.
...