---
schema_version: "1"
id: 1ef861cf21e701ccfa6e31aeb96eb956ed5b1870db7891c0d23f1c7ddb154d2d
title: HL7 EDI Connector Release Notes
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/release-notes/connector/hl7-connector-release-notes-mule-4.md
canonical_url: https://docs.mulesoft.com/release-notes/connector/hl7-connector-release-notes-mule-4
source_site: docs.mulesoft.com
content_type: documentation
content_hash: fb3a07fc2f338178fb32f3673c0e36f3b213cb8a975a17ccb9679a9f63c6890d
description: MuleSoft Documentation Site
latest: true
---
---
product: Release Notes
version: master
---

# HL7 EDI Connector Release Notes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Support Category:
[Premium](https://www.salesforce.com/en-us/wp-content/uploads/sites/4/documents/legal/Agreements/versioning-back-support-policy.pdf)

Guide: [Hl7 Connector User Guide](https://docs.mulesoft.com/hl7-connector/latest/)

## 5.0.0

**October 5, 2026**

### What’s New

- HL7 EDI Connector now requires Mule 4.6.24 or later.

- The **Enforce Acknowledgment ERR Segment Repeatability** field lets you enforce the repeatability
  of the Acknowledgment ERR segment.

For more information, see the
[Configurations section](https://docs.mulesoft.com/hl7-connector/latest/hl7-connector-reference#Configurations) of the
HL7 EDI Connector Reference.

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.6.24 and later</p></td></tr><tr><td><p>OpenJDK</p></td><td><p>8, 11, and 17</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

<table><colgroup><col> <col></colgroup><thead><tr><th>Issue Resolution</th><th>ID</th></tr></thead><tbody><tr><td><p>The error location elements now use the correct data types when the connector is configured with a lax acknowledgment schema.</p></td><td><p>W-16684549</p></td></tr></tbody></table>

## 4.3.0

**December 4, 2025**

### What’s New

- The connector can now accept empty arrays for optional repeatable fields in the input payload when
  writing HL7 messages. For more information, see
  [HL7 Connector Reference](https://docs.mulesoft.com/hl7-connector/latest/hl7-connector-reference).

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>OpenJDK</p></td><td><p>8, 11, and 17</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

## 4.2.12

**January 22, 2024**

### What’s New

- This connector is now compatible with Java 17.

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>OpenJDK</p></td><td><p>8, 11, and 17</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

<table><colgroup><col> <col></colgroup><thead><tr><th>Issue Resolution</th><th>ID</th></tr></thead><tbody><tr><td><p>The connector can now read and write subcomponents of subcomponents.</p></td><td><p>W-14454305</p></td></tr></tbody></table>

## 4.2.11

**July 11, 2023**

### What’s New

- The `org.yaml.snakeyaml` library is upgraded to version 2.0 to address reported security
  vulnerabilities.

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

<table><colgroup><col> <col></colgroup><thead><tr><th>Issue Resolution</th><th>ID</th></tr></thead><tbody><tr><td><p>The carriage return and line feed characters are now escaped correctly.</p></td><td><p>W-13478241, W-13478259</p></td></tr></tbody></table>

## 4.2.10

**October 20, 2022**

### What’s New

- The `org.yaml.snakeyaml` library is upgraded to version 1.32 to address reported security
  vulnerabilities.

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

## 4.2.9

**March 28, 2022**

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

<table><colgroup><col> <col></colgroup><thead><tr><th>Issue</th><th>ID</th></tr></thead><tbody><tr><td><p>The connector can now use custom ACK .esl files.</p></td><td><p>W-10801278</p></td></tr></tbody></table>

## 4.2.8

**March 3, 2022**

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

<table><colgroup><col> <col></colgroup><thead><tr><th>Issue</th><th>ID</th></tr></thead><tbody><tr><td><p>Extension segments are now written back into an HL7 message if they are present in the payload map.</p></td><td><p>W-10671665</p></td></tr><tr><td><p>The <strong>Disable numeric prefixes for data keys</strong> configuration field now works as expected for the <strong>Write</strong> operation when set to <code>false</code>.</p></td><td><p>W-10581096</p></td></tr></tbody></table>

## 4.2.7

**January 3, 2022**

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

<table><colgroup><col> <col></colgroup><thead><tr><th>Issue</th><th>ID</th></tr></thead><tbody><tr><td><p>Upgraded library dependencies.</p></td><td><p>CONN-9577</p></td></tr></tbody></table>

## 4.2.6

**December 20, 2021**

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

<table><colgroup><col> <col></colgroup><thead><tr><th>Issue</th><th>ID</th></tr></thead><tbody><tr><td><p>Upgraded library dependencies.</p></td><td><p>CONN-9577</p></td></tr></tbody></table>

## 4.2.5

**December 1, 2021**

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

<table><colgroup><col> <col></colgroup><thead><tr><th>Issue</th><th>ID</th></tr></thead><tbody><tr><td><p>When a segment was reused in an Lax schema, the parser sometimes incorrectly threw a <code>segment out of order</code> error.</p></td><td><p>SE-23264</p></td></tr><tr><td><p>When a segment had no position assigned in the schema, the parser sometimes assigned an incorrect position, which caused a <code>segment out of order</code> error.</p></td><td><p>SE-23264</p></td></tr><tr><td><p>When a <code>too many segment loops</code> error occurred, the segment and its position were not always accurate.</p></td><td><p>CONN-9426</p></td></tr></tbody></table>

## 4.2.4

**October 25, 2021**

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

<table><colgroup><col> <col></colgroup><thead><tr><th>Issue</th><th>ID</th></tr></thead><tbody><tr><td><p>When subcomponents were present in an element of the <code>varies</code> type, the index of the subcomponent did not reset correctly.</p></td><td><p>SE-22918</p></td></tr><tr><td><p>The segment position provided in the Errors list was not always correct.</p></td><td><p>SE-23050</p></td></tr><tr><td><p>When the MSH segment contained an error, the parser did not add it to the Errors list.</p></td><td><p>SE-23050</p></td></tr><tr><td><p>In some cases, the parser incorrectly added +1 to the Segment Sequence (ELD-02) in the Acknowledgment.</p></td><td><p>SE-23050</p></td></tr><tr><td><p>The parse property <code>Fail when a value length is outside an allowed range</code> did not work as expected.</p></td><td><p>CONN-8933</p></td></tr><tr><td><p>The parse property <code>Fail when an invalid character is in a value</code> did not work as expected.</p></td><td><p>CONN-8933</p></td></tr><tr><td><p>The parse property <code>Fail when there are too many repeats of a value</code> did not work as expected.</p></td><td><p>CONN-8933</p></td></tr><tr><td><p>The parse property <code>Fail when an unused segment is included in a message</code> did not work as expected.</p></td><td><p>CONN-8933</p></td></tr><tr><td><p>The parse property <code>Fail when there are too many repeats of a segment</code> did not work as expected.</p></td><td><p>CONN-8933</p></td></tr><tr><td><p>When an invalid character error was present, the parser duplicated it in the Acknowledgment (ERR).</p></td><td><p>CONN-8933</p></td></tr></tbody></table>

## 4.2.3

**October 4, 2021**

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

<table><colgroup><col> <col></colgroup><thead><tr><th>Issue</th><th>ID</th></tr></thead><tbody><tr><td><p>When an element of type <code>varies</code> had a list of components and the first component was empty, the element was skipped and not parsed.</p></td><td><p>SE-22379</p></td></tr><tr><td><p>The connector did not report the error when the number of repeated segments or simple elements exceeded the <strong>count</strong> value.</p></td><td><p>SE-22794</p></td></tr><tr><td><p>The parser property <code>Fail when there are too many repeats of a segment</code> did not work as expected. Now the MSA01 (Acknowledgment Code) changes accordingly.</p></td><td><p>SE-22794</p></td></tr></tbody></table>

## 4.2.2

**July 15, 2021**

### Compatibility

HL7 EDI Connector 4.2.2 is compatible with the following:

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issue

- The **Write** operation did not generate error details in some cases. (SE-21190)

## 4.2.1

**November 12, 2020**

### Compatibility

HL7 EDI Connector 4.2.1 is compatible with the following:

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issue

- In certain error cases, the specific error was not displayed. (SE-18505)

- An incorrect error message was generated when there was a field that contained a `~` character.
  (SE-18506)

## 4.2.0

**October 15, 2020**

### Compatibility

HL7 EDI Connector v4.2.0 is compatible with the following:

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Features

- Added segment terminator character configuration support. Supported values: '\\r' (CR) (default)
  and '\\n' (LF)

## 4.1.1

**May 4, 2020**

### Compatibility

HL7 EDI Connector v4.1.0 is compatible with the following:

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issue

- When (~) arrays were sent with null values, the connector parser skipped the rest of the file.
  (SE-15176).

- Upgraded Scala to version 2.12.10

- Upgraded Log4j to version 2.11.0

## 4.1.0

**April 14, 2020**

### Compatibility

HL7 EDI Connector v4.1.0 is compatible with the following:

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issue

- Added support for repeated values in extensions segments (Z\* segments). (SE-15044)

- Corrected parser handling of repeated values where some repeats are empty. (SE-15176)

## 4.0.4

**February 13, 2020**

### Compatibility

HL7 EDI Connector v4.0.4 is compatible with the following:

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.0 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issue

- Incompatibilities with JRE 11 have been fixed. (SE-14449).

## 4.0.3

**December 14, 2019**

### Compatibility

HL7 EDI Connector v4.0.3 is compatible with the following:

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.0 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

- Corrected the handling of eventMessageMap paths with a leading '/' character, as it was not found
  on the classpath. (SE-13668)

- Corrected the MSH handling for versions 2.2 and 2.3 which resulted in the error:
  "com.mulesoft.flatfile.lexical.LexicalException: No message structure found in eventMessageMap for
  message null/null". (SE-13668)

- All standard schemas now use a minimum length of 0 for simple values, rather than 1. Using a 1
  caused empty strings to be padded with a blank when written to the output. (SE-12757)

- Corrected the `ORU_R01` schema structure definition in version 2.4, as this was unusable due to
  repeated definitions. (SE-11806) The `hl7-simplify-4.0.2.jar` execution was not working properly.
  (SE-14016)

### Known Issues

Schemas are present for message structures for older versions (up to and including 2.3.1) that are
not used in HL7. HL7 reuses message structures for different event types. For example, there is no
`ADT_A08` message structure because this is a combination of an ADT message type for `A08` event
reuses the `ADT_A01` message structures. This issue is considered of low severity because it does
not result in any errors in either sending or receiving data, but may mislead the user to set an
incorrect message structure name for the `MSH.9/MSG.3` "message structure" field of the header. It
is left as a known issue so as to avoid breaking existing applications.

## 4.0.2

**December 14, 2018**

### Compatibility

HL7 EDI Connector v4.0.2 is compatible with the following:

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.0 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

- Corrected DataSense metadata. Removed the "Heading" level shown in DataSense that was not actually
  used in data.

- Added support for all standard escape sequences. However escape sequences that change character
  encoding are not supported.

- Fixed writing a String value to a timestamp field. By default this expects XMLGregorianCalendar,
  but a correctly formatted String is also supported.

- Corrected handling of MSH-18 character encoding field, allowing either a simple String or a list
  of Strings, depending on the schema version.

## 4.0.1

**August 30, 2018**

### Compatibility

HL7 EDI Connector v4.0.0 is compatible with the following:

<table><colgroup><col> <col></colgroup><thead><tr><th>Application/Service</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule</p></td><td><p>4.1.0 and later</p></td></tr><tr><td><p>HL7</p></td><td><p>v2.1, v2.2, v2.3.1, v2.3, v2.4, v2.5, v2.5.1, v2.6, 2.7, 2.7.1, 2.8, 2.8.1</p></td></tr></tbody></table>

### Fixed Issues

- Added delimiter character configuration support

- Corrected writer to use delimiters from configuration if not supplied in write data map

- Fixed issue with write exceptions being lost

- Corrected ACK schema to use list for repeating composite values where appropriate.

### Known Issues

- HL7 EDI Connector doesn’t support Design Center.

## 4.0.0

**January 31, 2018**

This release adapts HL7 for use with Mule 4 and Studio 7.

### Known Issues

- Setting default delimiter characters for writing is not supported in the configuration. You can
  set the delimiters in the output data.

- Anypoint Studio requires more memory than allowed by the default settings to support HL7 schema
  definitions. See the Connector Guide for details on changing the Studio memory settings.

- HL7 EDI Connector doesn’t support Design Center.

## See Also

- [Salesforce Help](https://help.salesforce.com)

- [MuleSoft Services](https://www.mulesoft.com/support-and-services)

- [Known Issues](https://help.salesforce.com/s/issues)