User Guide > Integrating Health Care Data > Health Care Components and Schemas > HL7 Batch Iterator
Was this helpful?
HL7 Batch Iterator
The HL7 Batch Iterator 1.1.0 supports the complete processing of incoming batches as defined by the HL7 standard.
The HL7 Batch Iterator receives one or more batch messages and returns an individual message from the batch.
A batch usually consists of a single type of message. However, the HL7 definition does not restrict a batch to only one message type.
The structure of a HL7 batch file is:
[FHS] (file header segment) { [BHS] (batch header segment)
 { [MSH (zero or more HL7 messages)
 ....
 ....
 ....
 ] }
 [BTS] (batch trailer segment)
 }
 [FTS] (file trailer segment)
Note:  A batch message may not always have header and trailer segments.
HL7 Batch Iterator Properties
 
Property Name
Description
Message From
Specifies the format of batch message fragments:
• DJMessage (default) - Use this format if memory is a constraint and your batch message fragments are small.
• File - Use this format if memory is not a constraint and your batch-message fragments are very large.
The default value is DJMessage.
File Location
Full path name to the HL7 message file.
Supported Actions
 
Action
Description
PutMessage
Receives HL7 batch-message fragments in the following formats:
• Flat file format - Use this format if memory is not a constraint and your batch-message fragments are very large.
• DJMessage body - Use this format if memory is a constraint and your batch- message fragments are small.
These fragments are then stored in memory.
GetMessage
Returns individual HL7 messages in a DJ Message variable. Each GetMessage may have the following properties:
• FHS - if FHS is in the HL7 file.
• BHS - if BHS is in the HL7 batch message.
• MessageNumber - Message sequence in HL7 batch staring with 1.
• TotalMessage - Total number of messages in HL7 batch.
• BatchNumber - Batch sequence in a HL7 file staring with 1.
• TotalBatch - Total number of batches in the HL7 file.
• SourceName - HL7 batch file name. If input is a physical file and if the file name is defined in BHS (BHS.9), then this property is skipped.
Disconnect
Break the connection with the component source.
Supported Action Parameters
Action
Parameter
Description
PutMessage,
GetMessage
Message
Provide a DJMessage for the Message parameter. The DJMessage body will be used to either "put" data into the Aggregator component, or "get" data from the Aggregator component, depending on which Action is selected (PutMessage, GetMessage). A new DJMessage can be created by clicking in the Message parameter field, and then selecting Add new DJMessage from the drop-down menu.
Supported Action Properties
There are no supported action properties.
Error Conditions
This transformer returns the following error messages.
Error Code
Error Name
Description
Reason
4
ERR_READERR
Error during reading of messages from a DJMessage body.
This error code is returned when an exception is encountered at the time of reading messages from a DJMessage body or URL.
8
ERR_WRITERR
Error at the time of storing the messages to Message Cache.
This error code is returned when an exception is encountered at the time of storing a message.
0
ERR_OK
On completion of a particular message Batch.
This error code is returned when batch messages are read from source and parsed into individual messages.
86
ERR_MSG_END
Error when there are no more message in Batch.
This error code is returned when the present batch has no more messages.
Last modified date: 10/22/2024