Nav
You are viewing an older version of this section. Click here to navigate to the latest version.

HL7 Delete Segment Component Reference

Working with instances of HAPI message objects, this component deletes a segment from an HL7 message. 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 Delete Segment component.

This 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  documentation main page.

Configuration

Minimum required configuration:

  • Segment name

XML Element

hl7:delete-segment

Sample Complete XML

<hl7:delete-segment segmentName="PID" repetition="2" doc:name="Delete Segment"/>
<hl7:delete-segment segmentName="PID" repetition="2"/>

Configuration For Studio and Mule Runtime

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.

[source] ---- doc:name="Sample Name" ----

Segment Name

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

[source] ---- segmentName="PID" ----

Repetition

Repetition index of the segment, if any.

[source] ---- repetition"2" ----

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.

[source] ---- doc:name="Sample Name" ----

Segment Name

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

[source] ---- segmentName="PID" ----

Repetition

Repetition index of the segment, if any.

[source] ---- repetition"2" ----

HL7 Delete Segment Component Attributes

Name

Type/Allowed values

Required

Default

Description

segment

string

yes

-

HL7 segment to delete

segmentName

string

yes

-

Name of the HL7 segment to delete

repetition

string

no

0

The repetition index of the segment, or * (wildcard) if all segments of that name should be deleted

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

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 Delete Segment component.