ParseHL7 Header Activity

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

The acknowledgment 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 acknowledgment message specifies the acknowledged status: AA.
  • If the header of the input HL7 string message is invalid, this activity does not generate an acknowledgment message and generates an exception. To generate an acknowledgment message, you must design a proper workflow.

Example

Refer to the associated example:

General

The General tab contains the following field:

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. It can contain one or more HL7 messages.

Output

The following table lists the fields on the Output tab:
Output Item Datatype Description
Messages string message

The HL7 message.

ackMsg

The auto-generated acknowledgment 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 errors that might occur when you use this activity.

Error Schema Element Datatype Description
msg string Error message description.
msgCode string The error code.

It represents ActiveMatrix BusinessWorks Plug-in for HL7 with FHIR and Foresight® Translator and Foresight® Instream errors.

For more information about error codes, see HL7 Error Codes.