Free MuleSoft CONNECT Keynote & Expo Pass Available!

Register now+
Nav

HL7 EDI Connector Reference

Configurations


Config

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees fit.

Mule Application Namespace ID (MSH-3-1/MSH-5-1)

String

Application Namespace ID for Mule in message header (MSH segment). If this value is set, it effects both send and receive message handling. On the receive side, the MSH Receiving Application identification Namespace ID must match this value. On the send side, this value is used as the MSH Sending Application identification Namespace ID unless overridden in either the send configuration or the message parameters.

Mule Application Universal ID (MSH-3-2/MSH-5-2)

String

Application Universal ID for Mule in message header (MSH segment). If this value is set, it effects both send and receive message handling. On the receive side, the MSH Receiving Application identification Universal ID must match this value. On the send side, this value is used as the MSH Sending Application identification Universal ID unless overridden in either the send configuration or the message parameters.

Mule Application Universal ID Type (MSH-3-3/MSH-5-3)

String

Application Universal ID Type for Mule in message header (MSH segment). If this value is set, it effects both send and receive message handling. On the receive side, the MSH Receiving Application identification Universal ID Type must match this value. On the send side, this value is used as the MSH Sending Application identification Universal ID Type unless overridden in either the send configuration or the message parameters.

Partner Application Namespace ID (MSH-3-1/MSH-5-1)

String

Application Namespace ID for Partner in message header (MSH segment). If this value is set, it effects both send and receive message handling. On the receive side, the MSH Sending Application identification Namespace ID must match this value. On the send side, this value is used as the MSH Receiving Application identification Namespace ID unless overridden in either the send configuration or the message parameters.

Partner Application Universal ID (MSH-3-2/MSH-5-2)

String

Application Universal ID for Partner in message header (MSH segment). If this value is set, it effects both send and receive message handling. On the receive side, the MSH Sending Application identification Universal ID must match this value. On the send side, this value is used as the MSH Receiving Application identification Universal ID unless overridden in either the send configuration or the message parameters.

Partner Application Universal ID Type (MSH-3-3/MSH-5-3)

String

Application Universal ID Type for Partner in message header (MSH segment). If this value is set, it effects both send and receive message handling. On the receive side, the MSH Sending Application identification Universal ID Type must match this value. On the send side, this value is used as the MSH Receiving Application identification Universal ID Type unless overridden in either the send configuration or the message parameters.

Schema definitions

Array of String

List of paths for schemas to be used by module. The paths may be either for file system or classpath.

x

Event and message to message structure map path

String

Path to a YAML file defining the mapping from event code to message code to message structure identifier. If working with multiple message structures this mapping definition supports using MSH-9-1 and MSH-9-2 to determine the message structure when MSH-9-3 is not present in a message. If only a single message structure is present in the schema(s) that message structure is used for parsing all messages, and if MSH-9-3 is present in a message the MSH-9-1 and MSH-9-2 values are ignored.

HL7 Message character encoding

Enumeration, one of:

  • ASCII

  • BIG_5

  • EUC_KR

  • EUC_TW

  • GB_18030

  • ISO_8859_1

  • ISO_8859_15

  • ISO_8859_2

  • ISO_8859_3

  • ISO_8859_4

  • ISO_8859_5

  • ISO_8859_6

  • ISO_8859_7

  • ISO_8859_8

  • ISO_8859_9

  • JIS0208

  • JIS_X0201

  • JIS_X0212

  • UTF_16

  • UTF_32

  • UTF_8

Character encoding for HL7 messages. This is used as the default for receive messages, when MSH-18 is not present. It is also used as the default for send messages, when MSH-18 is not present in the send message data.

ASCII

Disable numeric prefixes for data keys

Boolean

Use segment and group identifiers directly as keys in data, rather than prefixing with position values.

true

Required processing ID

Enumeration, one of:

  • DEBUGGING

  • PRODUCTION

  • TRAINING

Value to match for MSH-11-1 processing ID. If set, only messages with the specified processing ID will be accepted for processing; messages with other processing ID values, or with no processing ID specified, will be rejected with an exception.

Pattern for generic extension segment names

String

Java regular pattern for segment names to be treated as generic extension segments. If specified, segment names matching this pattern are allowed anywhere in the message and are converted to maps of string values for elements and composites.

Fail when required value missing

Boolean

Fail when a required value is missing flag. If true, a message with this error is rejected; if false, the value is ignored and the message is not rejected. In either case the error is logged and reported in an ERR segment.

false

Fail when value length outside allowed range

Boolean

Fail when receive value length outside allowed range flag. If true, a message with this error is rejected; if false, the value is used anyway and the message is not rejected. In either case the error is logged and reported in an ERR segment.

false

Fail when invalid character in value

Boolean

Fail when receive value contains invalid characters flag. If true, a message with this error is rejected; if false, the character is either passed through or substituted and the message is not rejected. In either case the error is reported in an ERR segment.

false

Fail when too many repeats of value

Boolean

Fail when receive value is repeated too many times. If true, a message with this error is rejected; if false, the value is accepted and the message is not rejected. In either case the error is reported in an ERR segment.

false

Fail when unknown segment in message

Boolean

Fail when an unknown segment is present in a message. If true, a message with this error is rejected; if false, the segment is ignored and the message is not rejected. In either case the error is reported in an ERR segment.

false

Fail when segment out of order in message set

Boolean

Fail when a segment is out of order in a message set. If true, a message with this error is rejected; if false and the segment can be reordered the message is not rejected. In either case the error is reported in an ERR segment.

false

Fail when unused segment included in message set

Boolean

Fail when a segment marked as Unused is included in a message set. If true, a message with this error is rejected; if false, the message is not rejected and the unused segment is ignored. In either case the error is reported in an ERR segment.

false

Fail when too many repeats of segment

Boolean

Fail when a segment occurs too many times in a message set. If true, a message with this error is rejected; if false, the message is not rejected. In either case the error is reported in an ERR segment.

false

Connection Type

Parameters

Name Type Description Default Value Required

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Associated Operations

  • read

  • write

Operations

Read

<hl7:read>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Read Content

Binary

#[payload]

Target Variable

String

The name of a variable to store the output of the operation.

Target Value

String

An expression that evaluates the operation’s output and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

  • config

Throws

  • HL7:RETRY_EXHAUSTED

  • HL7:UNKNOWN

  • HL7:PARSE

  • HL7:SCHEMA

  • HL7:CONNECTIVITY

  • HL7:WRITE

Write

<hl7:write>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Write Content

Object

#[payload]

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure to use repeatable streams and their behavior.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression that evaluates the operation’s output and stores the outcome of that expression in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

  • config

Throws

  • HL7:RETRY_EXHAUSTED

  • HL7:UNKNOWN

  • HL7:PARSE

  • HL7:SCHEMA

  • HL7:CONNECTIVITY

  • HL7:WRITE

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

  • reconnect

  • reconnect-forever

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

How much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means do not expand the buffer, and if the buffer gets full, raise a STREAM_MAXIMUM_SIZE_EXCEEDED error.

Max Buffer Size

Number

The maximum amount of memory to use. If more memory is needed, the STREAM_MAXIMUM_SIZE_EXCEEDED error occurs. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it starts to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed