HL7 Module 7.1 | Understanding and Using HL7 Module | Installing and Using HL7 Module | webMethods HL7 Module Services | WmHL7 Package | wm.ip.hl7.tn.transport:mllp
 
wm.ip.hl7.tn.transport:mllp
Delivers HL7 version 2.x messages via the MLLP transport. The service is either invoked directly, or it is invoked internally by the wm.ip.hl7.tn.service:send service when the tnProtocol parameter is set to MLLP. The service obtains the values for hostname, port, and timeout from the receiver Trading Networks partner profile.
Note:
If the input to the service is message, the mllp service uses the value specified for connectionAlias and this parameter is mandatory. If the input to the service is bizdoc, the details of the connection alias are taken from the trading partner profile.
Input Parameters
bizDoc
Object The BizDocEnvelope of the message.
message
Object Optional. The incoming HL7 message as a string, stream, or bytes. When the input HL7 message object is a string, you should initialize the string object with the desired charset encoding.
connectionAlias
String The qualified namespace of the MLLP connection to the MLLP server, in the format folder:connectionName. For example, connections:mllp_v2_host
charsetEncoding
String Optional. Used to determine the encoding when reading the HL7 message. If no value is specified, the charsetEncoding to be used is determined based on the information in the TPA. For more information, see the flow charts in Determining the Encoding of HL7 Messages.
Valid values for this parameter are the Java charset encoding values supported by the HL7 standard.
For information about the charset encoding supported by the HL7 standard, see Code Table: 0211 (Alternate Character Sets).
Note:
The charsetEncoding input parameter is different from the encoding mentioned in the HL7 message MSH.18 field. HL7 Module does not use the MSH.18 field encoding to parse or process the HL7 message.
Output Parameters
serviceOutput
String The output of the delivery service. Parameters are:
*status String The outcome of the delivery. Valid values are:
*success - The delivery is successful.
*fail - The delivery has failed.
*statusMessage String The status message from the last attempt to deliver the document.
*transportTime String The total time (in milliseconds) it took to deliver the document.
output
Document Contains the response parameter.
response String When the send service sends an ACK message, this parameter contains the acknowledgement sent in response to the ACK message.