Contact Us 1-800-596-4880

HL7 Profile Validator Filter

You can require HL7 messages to conform to message profiles, also known as conformance profiles. A message profile defines constraints for an HL7 message which go beyond the HL7 specification, and are useful to customize HL7 messages for specific applications, institutions, and regions.

The HL7 Profile Validator Filter validates an HL7 message in accordance to the user-specified HL7 message profile. If the message does not conform to the specified profile, Mule throws an exception.

This filter is part of the Mule Healthcare Toolkit, which includes transformers, components and endpoints 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:

  • HL7 conformance profile specification

XML Element

hl7:profile-validator-filter

Sample Complete XML

Studio

<hl7:profile-validator-filter profile="classpath:sample_profile.xml" doc:name="HL7 Profile Validator Filter"/>

Mule Runtime

<hl7:profile-validator-filter profile="classpath:sample_profile.xml"/>

Configuration For Studio and Mule Runtime

Studio Visual Editor

General Tab

hl7_validator
Name Description XML

Name

Name of the building block as it appears in the flow.

---- doc:name="sampleName" ----

Profile

HL7 conformance profile against which Mule validates a message. This can be an XML file in the application’s classpath, or an XML string containing the profile.

---- profile="classpath:profile.xml" ----

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

Name

Name of the building block as it appears in the flow.

---- doc:name="sampleName" ----

Profile

HL7 conformance profile against which Mule validates a message. This can be an XML file in the application’s classpath, or an XML string containing the profile.

---- profile="classpath:profile.xml" ----

Standalone

HL7 Profile Validator Filter Attributes

Name

Type/Allowed values

Required

Default

Description

profile

string

Yes

-

The location of the conformance profile in the application classpath (for example, classpath:ADT_A31.xml) or an XML string containing the conformance profile.

Namespace and Syntax

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

XML Schema Location

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

HL7 Profiles

For information about HL7 profiles, see the documentation for the ProfileParser Java class.