HL7 Module 10.5 | Understanding and Using HL7 Module | Installing and Using HL7 Module | webMethods HL7 Module Services | WmHL7 Package | wm.ip.hl7.tn.tpa.rec:HL7TPA
 
wm.ip.hl7.tn.tpa.rec:HL7TPA
An IS document that contains a set of variables used for processing HL7 version 2.x messages. This document is associated with the TPA generated by the wm.ip.hl7.tn.tpa:createHL7TPA service.
Parameters
hl7ProtocolAgreement
Settings related to the transport protocol.
*Acknowledgement Settings related to the Acknowledgement.
*ackProtocol Optional. The transport protocol to use when sending the Acknowledgment to the sender. The default value is blank.
*For HTTP, set to Primary HTTP or Secondary HTTP.
*For HTTPS, set to Primary HTTPS or Secondary HTTPS.
*For E-mail, set to Primary SMTP or Secondary SMTP.
*For FTP, set to Primary FTP or Secondary FTP.
*For MLLP, set to MLLP.
*sendACK Optional. Specifies whether to send an acknowledgement for the received message, regardless of the value in the MSH-15 field, or if the MSH-15 field is not provided. Valid values:
*Default - HL7 Module will use the value in the MSH-15 field to determine whether to send an acknowledgment, as per the HL7 standard. This is the default.
*Always - HL7 Module will always send an acknowledgment for the message it received, regardless of whether the MSH-15 field is present or what value it has, and without depending on any other constraints from the message.
*Never - HL7 Module will never send an acknowledgment, regardless of whether the MSH-15 field is present or what value it has.
*ackMode String When you select HTTP as the transport protocol in the ackProtocol parameter in the HL7TPA document, the service sends an Accept Acknowledgment to the Sender using either a synchronous, or an asynchronous mode based on the value you specify. Valid values:
*Async - Acknowledges receiving the message by sending an ACK as a separate transaction. This is the default.
*Sync - Acknowledges receiving the message by sending the ACK in the content part of the HTTP response. The HTTP response status code is 200.
hl7MessageScheme
Optional. Settings related to the message scheme.
*schemeID Optional. The message scheme ID to use for an HL7 message associated with this TPA. For example, com.example.custom.scheme
hl7Properties
Optional. Settings related to the configuration properties.
Note:
The default HL7 Module TPA has only one sub-parameter for the hl7Propertiesparameter, charsetEncoding. The default value for the charsetEncoding parameter is UTF-8.
*name The property name used for configuring a charsetEncoding. The value for this parameter is charsetEncoding.
*value Any Java character encoding supported by the HL7 standard.