HL7 Message Component
The HL7 Message component generates a new ER7-encoded HL7 message with user-defined parameters.
| This component 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:
-
Message type
-
Trigger event
All fields must conform to the HL7 format. Non-conformant fields generate an error message in Mule, and the message is not sent.
| This HL7 message component cannot generate the HL7 message payload, nor incorporate data from an external source for the HL7 message payload. To add a payload, use an HL7 Append Segment component. |
Sample Complete XML
Studio
<hl7:create-message version="2.6" messageType="ADT" triggerEvent="A03" doc:name="sampleName" dateTime="20160123" messageStructure="ADT_A01" receivingApplication="App Name" receivingFacility="Facility Name" sendingApplication="App Name" sendingFacility="Facility Name"/>Mule Runtime
<hl7:create-message version="2.6" messageType="ADT" triggerEvent="A03" dateTime="20160123" messageStructure="ADT_A01" receivingApplication="App Name" receivingFacility="Facility Name" sendingApplication="App Name" sendingFacility="Facility Name"/>Configuration For Studio and Mule Runtime
Studio Visual Editor
General Tab
The generated message type is ADT (patient admissions, transfer, discharge, etc.) and its trigger event is A03 (patient discharge).
The following tables 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 |
Name of the building block as it appears in the flow. |
---- doc:name="sampleName" ---- |
HL7 Version |
HL7 version for the message (2.x supported). |
---- version="2.6" ---- |
Message Type |
3-byte HL7 message type definition. |
---- messageType="ADT" ---- |
Trigger Event |
3-byte HL7 trigger event definition. |
---- triggerEvent="A03" ---- |
Message Structure |
Message structure (if different from Message Type + Trigger Event). |
---- messageStructure="ADT_A01" ---- |
Sending Application |
String that defines the sending application. |
---- sendingApplication="App Name" ---- |
Sending Facility |
String that defines the sending facility. |
---- sendingFacility="Facility Name" ---- |
Receiving Application |
String that defines the receiving application. |
---- receivingApplication="App Name" ---- |
Receiving Facility |
String that defines the receiving facility. |
---- receivingFacility="Facility Name" ---- |
Date/Time |
Date and time in the following format: |
---- dateTime="20130123" ---- |
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 |
Name of the building block as it appears in the flow. |
---- doc:name="sampleName" ---- |
HL7 Version |
HL7 version for the message (2.x supported). |
---- version="2.6" ---- |
Message Type |
3-byte HL7 message type definition. |
---- messageType="ADT" ---- |
Trigger Event |
3-byte HL7 trigger event definition. |
---- triggerEvent="A03" ---- |
Message Structure |
Message structure (if different from Message Type + Trigger Event). |
---- messageStructure="ADT_A01" ---- |
Sending Application |
String that defines the sending application. |
---- sendingApplication="App Name" ---- |
Sending Facility |
String that defines the sending facility. |
---- sendingFacility="Facility Name" ---- |
Receiving Application |
String that defines the receiving application. |
---- receivingApplication="App Name" ---- |
Receiving Facility |
String that defines the receiving facility. |
---- receivingFacility="Facility Name" ---- |
Date/Time |
Date and time in the following format: |
---- dateTime="20130123" ---- |
Standalone
HL7 Message Component Attributes
| Name | Type/Allowed Values | Required | Default | Description |
|---|---|---|---|---|
|
* |
Yes |
|
The version of the HL7 standard |
|
string |
Yes |
- |
The three-letter code designates the HL7 message type (ADT, ORU, etc.) |
|
string |
Yes |
- |
HL7 trigger event (A01, Q06, etc.) |
|
string |
No |
- |
HL7 message structure (if different from messageType + triggerEvent) |
|
string |
No |
|
The ID of the sending application |
|
string |
No |
- |
The ID of the receiving application |
|
string |
No |
- |
The ID of the sending facility |
|
string |
No |
- |
The ID of the receiving facility |
|
string |
No |
Current date and time |
Date and time in the following format: YYYY[MM[DD[HHMM[SS[.S[S[S[S]]]]]]]][+/-ZZZZ] |
Namespace and Syntax
http://www.mulesoft.org/schema/mule/hl7
XML Schema Location
http://www.mulesoft.org/schema/mule/hl7/mule-hl7.xsd