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

HL7 Endpoint Reference

The HL7 Endpoint creates a channel to receive or send HL7 messages over MLLP. In a running Mule application, the HL7 Endpoint listens and sends data on specified ports; the channel that the HL7 Inbound Endpoint uses for communication can be configured through a Global Element template, which the endpoint references.

If you place an HL7 endpoint at the beginning of a flow, Studio automatically defines it as an inbound endpoint. If you place the endpoint in the middle or the end of a flow, Studio defines it as an outbound endpoint.

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

Configuration

The HL7 Endpoint contains four tabs, explained in this section. To configure the properties for any building block in your flow, double-click the building block in the Message Flow canvas. Studio displays the building block’s Pattern Properties panel in which you can configure the element. Alternatively, add an hl7:inbound-endpoint or hl7:outbound-endpoint element to the XML configuration (see code below).

XML Elements

As an inbound endpoint:

hl7:inbound-endpoint

As an outbound endpoint:

hl7:outbound-endpoint

Sample Complete XML

<hl7:inbound-endpoint host="localhost" port="50609" responseTimeout="10000" doc:name="HL7" disableTransportTransformer="true" exchange-pattern="request-response" tracking:enable-default-events="true"/>
<hl7:inbound-endpoint host="localhost" port="50609" responseTimeout="10000" disableTransportTransformer="true" exchange-pattern="request-response"/>

Configuration For Studio and Mule Runtime

General Tab

hl7-endpoint-general

Name

Description

XML

Display Name

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

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

Host

Name of the host to which the endpoint must connect.

[source] ---- host="hostname" ----

Port

Port number for the connection.

[source] ---- port="50609" ----

Advanced Tab

hl7-endpoint-advanced

Name

Description

XML

Enable default events tracking

(Boolean) Enables Business Events for the Endpoint.

[source] ---- tracking:enable-default-events="true" ----

Address

The complete URI location of the host to which the Endpoint must connect.

This parameter is mutually exclusive of the following other parameters:

* Studio: Host (General tab), XML: host="" * Studio: Port (General tab), XML: port="" * Studio: Endpoint Reference (References tab), XML: ref=""

---- address="hl7://localhost:50609" ----

Response Timeout

The timeout for a response, in milliseconds.

---- responseTimeout="10000" ----

Encoding

String encoding for incoming or outgoing messages.

---- encoding="UTF-8" ----

Disable Transport Transformer

(Boolean) Do not apply default transformations for this endpoint.

To facilitate processing, an HL7 endpoint in Mule automatically applies default transformations to messages it receives. These default transformations make the message contents more “Mule friendly.”

Use Disable Transport Transformer if you want the HL7 endpoint to strictly maintain the data format of messages it receives

---- disableTransportTransformer="true" ----

MIME Type

MIME type of the message.

---- mimeType="text/plain" ----

Exchange Patterns

Select between two possible exchange patterns:

* one-way: An inbound endpoint only receives data and not send anything back to the originating application. An outbound endpoint only sends data. * request-response: Allows two-way communication between the endpoint and the external application.

---- exchange-pattern="one-way" ----

References Tab

hl7-endpoint-references

Name

Description

XML

Connector Reference

References an HL7 connector configured as a Global Element.

[source] ---- connector-ref="HL7connectorName" ----

Endpoint Reference

Allows you to reference an HL7 endpoint configured as a Global Element.

This parameter is mutually exclusive with the following other parameters:

* Studio: Host (General tab), XML: host="" * Studio: Port (General tab), XML: port="" * Studio: Address (Advanced tab), XML: address=""

[source] ---- ref="HL7endpointName" ----

Global Transformers (Request section)

Add transformers that the endpoint applies to information it receives. Use the Add icon next to the Global Transformers field to select transformers to add.

[source] ---- transformer-refs="HL7_Encoding_Transformer XML_to_Maps" ----

Global Transformers (Response section)

Add transformers that the endpoint applies to information it receives. Use the Add icon next to the Global Transformers field to select transformers to add.

[source] ---- responseTransformer-refs="Maps to XML HL7_Encoding_Transformer" ----

Transformers to be applied (Request and Response sections)

Use the edit icons to edit, reorder or remove selected transformers.

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.

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

Host

Name of the host to which the endpoint must connect.

[source] ---- host="hostname" ----

Port

Port number for the connection.

[source] ---- port="50609" ----

Enable default events tracking

(Boolean) Enables Business Events for the Endpoint.

[source] ---- tracking:enable-default-events="true" ----

Address

The complete URI location of the host to which the Endpoint must connect.

This parameter is mutually exclusive of the following other parameters:

* Studio: Host (General tab), XML: host="" * Studio: Port (General tab), XML: port="" * Studio: Endpoint Reference (References tab), XML: ref=""

[source] ---- address="hl7://localhost:50609" ----

Response Timeout

The timeout for a response, in milliseconds.

[source] ---- responseTimeout="10000" ----

Encoding

String encoding for incoming or outgoing messages.

[source] ---- encoding="UTF-8" ----

Disable Transport Transformer

(Boolean) Do not apply default transformations for this endpoint.

To facilitate processing, an HL7 endpoint in Mule automatically applies default transformations to messages it receives. These default transformations make the message contents more “Mule friendly.”

Use Disable Transport Transformer if you want the HL7 endpoint to strictly maintain the data format of messages it receives

[source] ---- disableTransportTransformer="true" ----

MIME Type

MIME type of the message.

[source] ---- mimeType="text/plain" ----

Exchange Patterns

Select between two possible exchange patterns:

* one-way: An inbound endpoint only receives data and doesn’t send anything back to the originating application. An outbound endpoint only sends data. * request-response: Allows two-way communication between the endpoint and the external application.

[source, code, linenums] ---- exchange-pattern="request-response" exchange-pattern="one-way" ----

Connector Reference

Allows you to reference an HL7 connector configured as a Global Element.

[source] ---- connector-ref="HL7connectorName" ----

Endpoint Reference

Allows you to reference an HL7 endpoint configured as a Global Element.

This parameter is mutually exclusive with the following other parameters:

* Studio: Host (General tab), XML: host="" * Studio: Port (General tab), XML: port="" * Studio: Address (Advanced tab), XML: address=""

[source] ---- ref="HL7endpointName" ----

Global Transformers (Request section)

Add transformers that the endpoint applies to information it receives. Use the Add icon next to the Global Transformers field to select transformers to add.

[source] ---- transformer-refs="HL7_Encoding_Transformer XML_to_Maps" ----

Global Transformers (Response section)

Add transformers that the endpoint applies to information it receives. Use the Add icon next to the Global Transformers field to select transformers to add.

[source] ---- responseTransformer-refs="Maps to XML HL7_Encoding_Transformer" ----

HL7 Endpoint Attributes

Name Type Required Default Description

host

string

no

-

The host of the TCP socket.

port

port number

no

-

The port of the TCP socket.

Namespace and Syntax

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

XML Schema Location

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