ParseHL7 Header

Use the ParseHL7 Header activity to parse the header of a set of HL7 string messages and generate acknowledgements.

The acknowledgement is generated as a part of the output message; it returns the following information:

If the header of the input HL7 string message is valid, the first field of the MSA segment in the acknowledgement message specifies the acknowledge status: AA.
If the header of the input HL7 string message is invalid, this activity will not generate an acknowledgement message and will throw an exception. To generate an acknowledgement message, you need to design a proper workflow.

Examples

Refer to the associated examples:

Receive Process

General

The General tab contains the following fields.

Field	Literal Value/Module Property/Process Property?	Description
Name	No	The name to be displayed as the label for the activity in the process.

Description

The Description tab is used to provide a short description for the activity.

Input

The input for the activity are HL7 messages. This can contain one or more HL7 messages.

Output

The Output tab contains the following fields.

Output Item	Datatype	Description
Messages	string	message The HL7 message. ackMsg The auto-generated acknowledgement for the incoming message. responseID The value of the second field in the MSA segment of the incoming message. This MSA segment is present only if the incoming message is a response message. This field is optional; the request message does not have an MSA segment.
Header	string	All the header field values.

Output Item

Datatype

Description

Messages

string

message

The HL7 message.

ackMsg

The auto-generated acknowledgement for the incoming message.

responseID

The value of the second field in the MSA segment of the incoming message.

This MSA segment is present only if the incoming message is a response message. This field is optional; the request message does not have an MSA segment.

Header

string

All the header field values.

Fault

The Fault tab lists exceptions that are thrown by this activity.

Error Schema Element	Datatype	Description
msg	string	Error message description.
msgCode	string	The error code. It represents TIBCO ActiveMatrix BusinessWorks™ Plug-in for HL7 and TIBCO Foresight® Translator and TIBCO Foresight® Instream® errors. See Error Codes for details.