Loading...
Loading...
This data type enables powerful and flexible parsing and manipulation of HL7 v2.x messages. It features two modes, strict and non-strict. The strict mode parses messages into and from XML according to the official XSD, and enables automatic validation against the HL7 specifications. The non-strict mode parses messages into a simple, consistent XML structure consisting of the segment/field/component/subcomponent hierarchy, and enables quick and easy transformation in most use-cases.
The data type also features an automatic response (ACK) generator, and a response validator that can mark messages as failed when a negative acknowledgement is received or when the message control IDs do not match. It also has a batch adapter that can split messages based on the MSH segment, even while streaming over a TCP connection.
Serialization / Template Serialization / Deserialization Properties
| Name | Default Value | Description |
|---|---|---|
| Parse Field Repetitions | Enabled | Parse field repetitions (applies to Non-Strict Parser only). |
| Parse Subcomponents | Enabled | Parse subcomponents (applies to Non-Strict Parser only). |
| Use Strict Parser | Disabled | Parse messages based on strict HL7 specifications. |
| Validate in Strict Parser | Disabled | Validate messages using HL7 specifications (applies to Strict Parser only). |
| Strip Namespaces | Enabled | Strips namespace definitions from the transformed XML message (applies to Strict Parser only). |
| Segment Delimiter | \r | This is the input delimiter characters expected to occur after each segment. |
| Convert Line Breaks | Enabled | Convert all styles of line breaks (CRLF, CR, LF) in the raw message to the segment delimiter. |
Batch Properties
| Name | Default Value | Description |
|---|---|---|
| Split Batch By | MSH Segment | Select the method for splitting the batch message. This option has no effect unless Process Batch is enabled in the Source Settings. The following options are available:
|
| JavaScript | Enter JavaScript that splits the batch, and returns the next message. This script has access to 'reader', a Java BufferedReader, to read the incoming data stream. The script must return a string containing the next message, or a null/empty string to indicate end of input. For additional information, see JavaScript Batch Script. |
Response Generation Properties
| Name | Default Value | Description |
|---|---|---|
| Segment Delimiter | \r | These are the delimiter character(s) that will be used after each segment. This option has no effect unless an "Auto-generate" item has been selected in the response settings. |
| Successful ACK Code | AA | The ACK code to respond with when the message processes successfully. This value supports Velocity Variable Replacement with values from the current connector message. |
| Successful ACK Message | The ACK message to respond with when the message processes successfully. This value supports Velocity Variable Replacement with values from the current connector message. | |
| Error ACK Code | AE | The ACK code to respond with when an error occurs during message processing. This value supports Velocity Variable Replacement with values from the current connector message. |
| Error ACK Message | An Error Occurred Processing Message. | The ACK message to respond with when an error occurs during message processing. This value supports Velocity Variable Replacement with values from the current connector message. |
| Rejected ACK Code | AR | The ACK code to respond with when the message is filtered. This value supports Velocity Variable Replacement with values from the current connector message. |
| Rejected ACK Message | Message Rejected. | The ACK message to respond with when the message is filtered. This value supports Velocity Variable Replacement with values from the current connector message. |
| MSH-15 ACK Accept | Disabled | This setting determines if Mirth should check the MSH-15 field of an incoming message to control the acknowledgment conditions. The MSH-15 field specifies if a message should be always acknowledged, never acknowledged, or only acknowledged on error. |
| Date Format | yyyyMMddHHmmss.SSS | This setting determines the date format used for the timestamp in the generated ACK. The default value is "yyyyMMddHHmmss.SSS". |
Response Validation Properties
| Name | Default Value | Description |
|---|---|---|
| Successful ACK Codes | AA,CA | The ACK code(s) to expect when the message is accepted by the downstream system. By default, the message status will be set to SENT. Specify multiple codes with a list of comma separated values. |
| Error ACK Codes | AE,CE | The ACK code(s) to expect when an error occurs on the downstream system. By default, the message status will be set to ERROR. Specify multiple codes with a list of comma separated values. |
| Rejected ACK Codes | AR,CR | The ACK code(s) to expect when the message is rejected by the downstream system. By default, the message status will be set to ERROR. Specify multiple codes with a list of comma separated values. |
| Validate Message Control Id | Enabled | Select this option to validate the Message Control Id (MSA-2) returned from the response. |
| Original Message Control Id | Destination Encoded | Select the source of the original Message Control Id used to validate the response. If Destination Encoded is selected, the Id will be extracted from the MSH-10 field of the destination's encoded content. If Map Variable is selected, the Id will be retrieved from the destination's connector map or the channel map. |
| Original Id Map Variable | This field must be populated if the Original Message Control Id is set to Map Variable. The Id will be read from this variable in the destination's connector map or the channel map. |