User Guide > Integrating Health Care Data > Health Care Components and Schemas > HL7 Batch Aggregator
Was this helpful?
HL7 Batch Aggregator
The HL7 Batch Aggregator component aggregates MSH messages into an HL7 batch with BHS header and BTS trailer. HL7 batch can further aggregate into HL7 batch file by another MCF component HL7 Batch File Aggregator.
HL7 Batch Aggregator Properties
You can specify the following properties when you create an instance of this component in the Configuration tab > Message Components section.
Property
Description
Message From
Specifies the format of MSH 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.
BHS.3 Batch Sending Application
Uniquely identifies the sending application among all other applications within the network enterprise. The network enterprise consists of applications that participate in the exchange of HL7 messages within the enterprise.
BHS.4 Batch Sending Facility
Contains the address of one of several occurrences of the same application within the sending system.
BHS.5 Batch Receiving Application
Uniquely identifies the receiving application among all other applications within the network enterprise. The network enterprise consists of all those applications that participate in the exchange of HL7 messages within the enterprise.
BHS.6 Batch Receiving Facility
Identifies the receiving application among multiple identical instances of the application running on behalf of different organizations.
BHS.7 Batch Creation Date/Time
Contains the date/time that the sending system created the message. If the time zone is specified, it will be used throughout the message as the default time zone. Select any of the following formats:
• yyyyMMdd
• yyyyMMddHHmm
• yyyyMMddHHmmss
• yyyyMMddHHmmssZZZZ
BHS.8 Batch Security
Implement security features.
BHS.9 Batch Name/Id/Type
Used by the application processing the batch.
BHS.9 Write Message to File?
If this property is defined and the option is set to true, then writes message to file. Default is False.
BHS.10 Batch Comment
Batch comment.
BHS.11 Batch Control Id
Uniquely identify a particular batch. It can be echoed back in BHS-12 Reference Batch Control ID if an answering batch is needed.
BHS.12 Reference Batch Control Id
Contains the value of BHS-11 Batch Control ID when this batch was originally transmitted. Not present if this batch is being sent for the first time.
BHS.13 Batch Sending Network Address
Identifier of the network location the message was transmitted from. This field should only be populated when the underlying communication protocol does not support identification of sending network locations.
BHS.14 Batch Receiving Network Address
Identifier of the network location the message was transmitted to. This field should only be populated when the underlying communication protocol does not support identification receiving network locations.
BTS.2 Batch Comment
Comment Field.
BTS.3 Batch Totals
Contains the batch total. If more than a single batch total exists, this field may be repeated.
Supported Actions
Action
Description
PutMessage
Receives HL7 MSH-message fragments in the following formats:
• Flat File Format (default) - 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.
The default value is DJMessage.
GetMessage
Returns one HL7 batch message.
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.
Override Properties
You can override the values provided for the BHS.1 and BHS.2 in the PutMessage action using the Batch .Field.Separator and Batch.Encoding.Characters DJMessage properties, respectively. Both are hidden properties. These fragments are then stored in memory.
Errors
This transformer returns the following error messages:
Action
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