Contact Us 1-800-596-4880
  1. Homepage
  2. Healthcare Toolkit (2.0)

  3. HL7 Append Segment Component Reference

HL7 Append Segment Component Reference

The Append Segment component adds a segment to an HL7 message. Like the HL7 Delete Segment component, it works with instances of HAPI message objects. If your HL7 message is not a HAPI message object, you must use the HL7 Encoding Transformer to convert it before it passes through the Append Segment component.

The HL7 Append Segment component is part of the Mule Healthcare Toolkit, which includes transformers, components, and connectors for receiving, processing, and sending HL7 messages. For details and a full list of available tools, consult the Toolkit’s main documentation page.

Configuration

Minimum required configuration:

  • Segment name

  • Segment contents

XML Element

hl7:append-segment

Sample Complete XML

Studio

<hl7:append-segment segmentName="PID" segment="segment="||12345||DOE^JANE^E||19550711|F|123
SAMPLE AVENUE^^CITYNAME^CA^21" doc:name="Append Segment" repetition="2" isNonStandard="false" validation="STRONG"/>

Mule Runtime

<hl7:append-segment segmentName="PID" segment="segment="||12345||DOE^JANE^E||19550711|F|123
SAMPLE AVENUE^^CITYNAME^CA^21" repetition="2" isNonStandard="false" validation="STRONG"/>

Configuration For Studio and Mule Runtime

Studio Visual Editor

hl7 append

General

The following tables list and describe configurable parameters for this building block. In this table, Name refers to the parameter name as it appears in the Pattern Properties window. The XML column lists the corresponding XML attribute.

Name

Description

XML

Display Name

The name of the building block as it appears in the flow.

---- doc:name="Sample Name" ----

Segment Name

(Required) 3-byte identifier of the segment to add.

---- segmentName="PID" ----

Segment

(Required) ER7-encoded value of the segment to append.

[source,text,linenums] ---- segment="||12345||DOEJANEE||19550711|F|123 SAMPLE AVENUE^CITYNAMECA^21" ----

Repetition

Repetition index for the segment, if any.

---- repetition="2" ----

Is Non Standard

(Boolean) Allows you to select whether the segment adheres strictly to the HL7 standard. If true, Mule does not check the segment for standard compliance.

---- isNonStandard="false" ----

Strong / Weak Validation

Allows you to select between STRONG or WEAK HL7 message validation (leave blank for no validation).

* STRONG: Checks that all message structure components are present, and that the message is well-formed * WEAK: Only checks that the message is well-formed

---- validation="STRONG" ----

XML Editor

To access the Studio XML Editor, click the Configuration XML tab under the canvas.

The table below describes all configurable parameters for this building block.

Name

Description

XML

Display Name

The name of the building block as it appears in the flow.

---- doc:name="Sample Name" ----

Segment Name

(Required) 3-byte identifier of the segment to add.

---- segmentName="PID" ----

Segment

(Required) ER7-encoded value of the segment to append.

[source,text,linenums] ---- segment="||12345||DOEJANEE||19550711|F|123 SAMPLE AVENUE^CITYNAMECA^21" ----

Repetition

Repetition index for the segment, if any.

---- repetition="2" ----

Is Non Standard

(Boolean) Allows you to select whether the segment adheres strictly to the HL7 standard. If true, Mule does not check the segment for standard compliance.

---- isNonStandard="false" ----

Strong / Weak Validation

Allows you to select between STRONG or WEAK HL7 message validation (leave blank for no validation).

* STRONG: Checks that all message structure components are present, and that the message is well-formed. * WEAK: Only checks that the message is well-formed.

---- validation="STRONG" ----

Standalone

HL7 Append Message Component Attributes

Name Type/Allowed values Required Default Description

segment

string

yes

-

HL7 segment to append to the message

segmentName

string

yes

-

Name of the HL7 segment to append

repetition

string

no

0

Repetition index of the segment

nonStandard

boolean

no

-

Set to true if the segment to append is non-standard

validation

* STRONG * WEAK

no

WEAK

Enable/disable default HAPI HL7 message validation during sending/receiving.

* STRONG: Validation enabled * WEAK: validation disabled

Namespace and Syntax

http://www.mulesoft.org/schema/mule/hl7

XML Schema Location

http://www.mulesoft.org/schema/mule/hl7/mule-hl7.xsd

Transform to HAPI Object

If the HL7 message that you wish to modify is not a HAPI object, transform it to a HAPI object with the HL7 Encoding Transformer, which you can place immediately before the Append Segment component.