User Guide > Designing and Executing Processes > Health Care Components and Schemas > HL7 Batch File Aggregator
Was this helpful?
HL7 Batch File Aggregator
The HL7 Batch Files Aggregator component aggregates multiply batches into an HL7 batch file with FHS header and FTS trailer.
HL7 Batch File 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 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.
FHS.3 File Sending Application
Uniquely identifies the sending 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.
FHS.4 File Sending Facility
Describes the sending application, FHS-3 File Sending Application.
FHS.5 File 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.
FHS.6 File Receiving Facility
Identifies the receiving application among multiple identical instances of the application running on behalf of different organizations.
FHS.7 File Creation Date/Time
Contains the date/time when the sending system created the message. Select any of the following format:
• yyyyMMdd
• yyyyMMddHHmm
• yyyyMMddHHmmss
• yyyyMMddHHmmssZZZZ
FHS.8 File Security
Used to implement security features.
FHS.9 File Name/Id
Batch File Name or Id.
FHS.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.
FHS.10 File Comment
Contains the free text field.
FHS.11 File Control Id
Used to uniquely identify a particular file.
FHS.12 Reference File Control Id
Contains the value of FHS-11-file control ID when this file was originally transmitted. Not present if this file is being transmitted for the first time.
FHS.13 File Sending Network Address
Identifier of the network location from where the message was transmitted. Identified by an OID or text string (e.g., URI).
FHS.14 File Receiving Network Address
Identifier of the network location to where the message was transmitted. Identified by an OID or text string. (e.g., URL).
Note:  This field must be populated when the underlying communication protocol does not support identification receiving network locations.
FTS.2 File Trailer Comment
Batch File Comment.
Supported Actions
Action
Description
PutMessage
Receives HL7 batch-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 file 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 FHS.1 and FHS.2 in the PutMessage action using the File.Field.Separator and File.Encoding.Characters DJMessage properties.
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