User Guide > Integrating Health Care Data > Health Care Components, Connectors, and Schema > HL7 Message Structure Validation Invoker
Was this helpful?
HL7 Message Structure Validation Invoker
The HL7 Message Structure Validation Invoker validates the structure of the HL7 Message with the applicable schema for a given version. The process is as follows:
1. Message is parsed to retrieve the message type and the version from the message header (MSH) segment of the incoming message.
2. Component loads the schema based on this information and validates the message structure using the schema.
3. After successful validation, the message is saved in the cache memory as a value object.
4. Target message of the Execute action is populated with the Message Control ID of the message as a key. This key is used to retrieve the value object from the cache.
HL7 Message Structure Validation Invoker Properties
 
Property
Default Value
Description
Schema Base Path
-
Location of the schema library, which the component loads for a specific schema version and message type.
Supported Actions
 
Action
Description
Execute
Runs any expression that you specify.
Supported Action Parameters
 
Action
Parameter
Description
Execute
SourceMessage
Sets the HL7 message and the DJMessage properties. These values are set before they are passed to the acknowledgment component.
Execute
TargetMessage
Contains the generated acknowledgement message.
Supported Action Properties
There are no action properties for this invoker.
Error Conditions
The following table provides the error information set by the HL7 Message Structure Validation Invoker.
Error Code
Description
Reason
100
Segment sequence error
Possible reasons:
• A required segment is missing
• An error in the segment sequence in the message.
101
Required field missing
A mandatory field is missing in the segment.
103
Table value not found
The value does not match with the allowable value specified in the code table for a field.
150
Max length error
The length of the field value exceeds the maxlength specified in the schema.
200
Unsupported message type
The specified message type is not supported for this HL7 version.
201
Unsupported event code
The specified event code not supported for this HL7 version.
203
Unsupported version ID
The specified version ID is not supported.
207
Application internal error
Some internal error occurred during validation.
For example, the component could not find the schema library file for the specified message type and version.
The following table provides the error conditions supported by the HL7 Message Structure Validation Invoker.
Error Code
Error Name
Description
Reason
89
ERR_ HEADERDER_VALIDATION
Error at the time of Header Validation
This error code is returned when an exception is encountered at the time of structure validation of a message
85
ERR_SYNTAXCHECK
Error at the time of Syntax check
This error code is returned when an exception is encountered at the time of checking the syntax of a message
88
ERR_STRUCTURAL_VALIDATION
Error at the time of structure validation
This error code is returned when an exception is encountered at the time of structure validation of a message
87
ERR_MSG_CONTINUATION
Error on receiving incomplete message parts
This error code is returned when the present message part is not the last part of a Message sequence
50
ERR_UNSPECIFIED
Unspecified error
Unknown error condition
4
ERR_READERR
Error was encountered reading file or table
The error code is returned when the component cannot locate the schema
0
ERR_OK
On structure validation
This error code is returned when a HL7 Message is passed against any kind of validation
Last modified date: 08/02/2023