HRI Releases

This page lists the releases with notes for the HRI with information about how to upgrade from one version to the next. If upgrading multiple versions, check the upgrade notes of all versions in between. Note that the HRI has an overall release number, which is included here. Individual components of the HRI use the overall major and minor release number as a prefix to their release number, in order to make it easy to identify which versions of components are compatible with each other. For example, v2.1-2.1.5 of the Management API is compatible with v2.1-1.0.1 of Flink validation FHIR, because they both have the v2.1 prefix.

Unless stated otherwise in the release notes of a specific version, upgrading the HRI should be achievable without downtime. If you are only upgrading to a new patch version, simply upgrade your existing deployment with the patched version. Otherwise, the new version can be deployed and configured separately in a different namespace while the old HRI version is still active, and the old HRI version can be deleted when migration is complete. In this case, be sure to use the same Elasticsearch and Event Streams instances for both of the HRI versions. Again, please see the upgrade notes for all versions between your current and target versions for any additional requirements.

v2.x

Version 2.x uses IBM Functions to deploy the Management API and includes validation processing. It is deprecated as of March 2022. Please upgrade to the latest version at your earliest convenience.

v2.2.1

Release notes

An HRI patch release to update Golang packages to their latest versions to address vulnerabilities.

v2.2.0

Release notes

Validation processing was removed due to Log4j vulnerabilities in the older Flink version. To use validation update to the latest HRI version. This version is scheduled to be deprecated on March 01, 2022.

v2.1.6

Release notes

First Alvearie release using new GitHub Actions workflow. Upgraded to Flink 1.10.3, other minor dependency updates.

v2.1.5

Release notes

Initial open source release of v2.x.

Upgrading

This release does not contain breaking changes. Data Integrators and Consumers will maintain access to old batches. However, please note that there are changes to the Elasticsearch mapping template, which must be applied to all existing indices (one for every tenant). Below is a series of upgrade tasks.

1. The Elasticsearch index mappings need to be updated to account for the new expectedRecordCount, actualRecordCount, invalidThreshold, and invalidRecordCount fields. recordCount is considered deprecated as of v2.0.0 and expectedRecordCount should be used instead.
2. Download the new index template from GitHub
3. Follow these instructions to upgrade all the existing Elasticsearch indices with the batch.json index template downloaded in the prior step.

The expectedRecordCount, actualRecordCount, invalidThreshold, and invalidRecordCount fields have also been added to the Batch API and Notification Message model, so Data Integrators and Consumers may need to update their integration tools to prevent parsing errors. Additional Batch Notification messages and status values have also been added. For more information, refer to the Batch Status Transitions documentation.

v1.x

Version 1.x uses IBM Functions to deploy the Management API and does not include validation processing. It is deprecated as of March 2022. Please upgrade to the latest version at your earliest convenience.

v1.2.7

Release notes

An HRI patch release to update Golang packages to their latest versions to address vulnerabilities.

v1.2.6

Release notes

First Alvearie release using new GitHub Actions workflow. There were no substantive changes to the API or deployed code.

v1.2.5

Release notes

Initial open source release of v1.x.