HL7 Module 10.5 | Understanding and Using HL7 Module | Installing and Using HL7 Module | webMethods HL7 Module Services | WmHL7 Package | wm.ip.hl7.service:convertIDataToHL7
 
wm.ip.hl7.service:convertIDataToHL7
Converts an IS document type of a specific HL7 version into its respective HL7 version 2.x message format representation with the specified encoding type.
Input Parameters
messageValues
Document The IS document to be converted into HL7 message format.
messageType
String The name of the message schema definition. For example, ADT_A01.
Important:
The messageType parameter is case sensitive. By default all HL7 message schema definitions use the uppercase.
messageVersion
String The HL7 message version. Valid values: 2.1, 2.2. 2.3, 2.3.1,2.4,2.5,2.5.1, 2.6,and 2.7.
encoding
String Optional. The encoding type of the HL7 message. Valid values are:
*ER7 - The output message must be in HL7 ER7 format. This is the default.
*XML - The output message must be in HL7 XML format.
returnAsBytes
String Optional. Specifies the return format of the HL7 message. Valid values are:
*true - Returns the string representation of the HL7 message.
*false - Returns the bytes representation of the HL7 message. This is the default.
validate
String Optional. Specifies whether to perform syntactic, semantic and code table validation during the conversion process.
Note:
If code tables are disabled, no code table validation will be performed even if validate is set to true.
Note:HL7 Module performs mandatory field validation in the MSH segment even when validate is set to false.
Valid values are:
*true - The following operations will be performed:
*Check if all required elements are present in the input data.
*Validate code tables.
*Validate field data. This is the default.
*false - Disables validation.
formatXML
String Optional. When the encoding parameter is set to XML, the formatXML parameter specifies if the output HL7 data must be in properly indented XML layout or not. Valid values are:
*true - The XML format will be indented consistently, based on the logical nesting depth of the tags.
*false - No XML format will be applied. The data will be presented as a single text entity. This is the default.
messageScheme
Document Optional. Specifies settings related to the message scheme. Parameters are:
*schemeID String Optional. The unique message scheme ID to use for conversion.
*To use custom message definitions do one of the following:
*Specify a value for the schemeID parameter. HL7 Module uses the message schemas that correspond to the schemeIDvalue. In this case, the values that you specify for some or all of the other messageScheme parameters will be ignored.
*Do not specify a value for the schemeID parameter, but provide values for the remaining messageScheme parameters. In this case, HL7 Module extracts the schemeID from the TPA. The module uses the message schemas that correspond to the schemeID extracted from the TPA.
*To use the default message definitions provided with HL7 Module do one of the following:
*Specify wm.ip.hl7.docType (the schemeID for the default XML schemas provided with HL7 Module).
*Do not specify values for any of the messageScheme parameters.
*senderID String Optional. The external sender ID for the input HL7 message.
*senderIDType String Optional. The external sender ID type for the input HL7 message.
*receiverID String Optional. The external receiver ID for the input HL7 message.
*receiverIDType String Optional. The external receiver ID type for the input HL7 message.
Output Parameters
messageString
String Conditional. The string representation of the HL7 message for the specified messageType and messageVersion. The format of the output is either ER7 or XML-encoded, based on the value you have specified for the encoding parameter.
messageBytes
Object Conditional. The bytes representation of the HL7 message for the specified messageType and messageVersion. The format of the output is either ER7 or XML-encoded, based on the value you have specified for the encoding parameter.
errors
Document Conditional. Specifies whether any parsing or invalid message errors occurred.
warnings
Document List When the validation flag is turned on, lists the validation warnings (if any).