Skip to content

Releases: LinuxForHealth/FHIR

LinuxForHealth FHIR Server 5.1.1

16 Dec 03:00
15ceac5
Compare
Choose a tag to compare

This version of the LinuxForHealth FHIR Server supports HL7 FHIR versions 4.0.1 and 4.3.0.

This release includes dependency updates and important changes to the fhir-smart AuthzPolicyEnforcement interceptor.

Changed

Fixed

Security

Migration Considerations

If upgrading from a version prior to 5.1.0, be sure to review the applicable migration considerations:

Note: for schema migrations, only the latest version of the fhir-persistence-schema tool must be run.

Using the Release

Run or extend the Docker image from https://github.com/LinuxForHealth/FHIR/pkgs/container/fhir-server or download fhir-install-5.1.1.zip and install as described at https://linuxforhealth.github.io/FHIR/guides/FHIRServerUsersGuide.

Executable jar files for the fhir-persistence-schema, fhir-swagger-generator, fhir-bucket, and fhir-path projects are also available:

Usage is documented in the corresponding README files:

For Maven users, all project binaries are posted to Maven Central with a groupId of org.linuxforhealth.fhir and a version of 5.1.1.

LinuxForHealth FHIR Server 5.1.0

11 Nov 22:38
19a7759
Compare
Choose a tag to compare

This version of the LinuxForHealth FHIR Server supports HL7 FHIR versions 4.0.1 and 4.3.0.

This release fixes a 5.0.0 regression for resource types with long searchable strings and includes updates to validation and search paging.

Added

Changed

Fixed

Security

Migration Considerations

To migrate from a prior version to version 5.1.0:

  1. Analyze configuration changes and prepare for the upgrade
    • #3716 introduces fhirServer/security/validateSecurityContext; currently it only affects fhir-smart behavior
  2. Deploy the new server.

If upgrading from a version prior to 5.0.0, be sure to review the applicable migration considerations:

Note: for schema migrations, only the latest version of the fhir-persistence-schema tool must be run.

Using the Release

Run or extend the Docker image from https://github.com/LinuxForHealth/FHIR/pkgs/container/fhir-server or download fhir-install-5.1.0.zip and install as described at https://linuxforhealth.github.io/FHIR/guides/FHIRServerUsersGuide.

Executable jar files for the fhir-persistence-schema, fhir-swagger-generator, fhir-bucket, and fhir-path projects are also available:

Usage is documented in the corresponding README files:

For Maven users, all project binaries are posted to Maven Central with a groupId of org.linuxforhealth.fhir and a version of 5.1.0.

LinuxForHealth FHIR Server 5.0.0

15 Sep 20:44
f383bd6
Compare
Choose a tag to compare

The first release of the LinuxForHealth FHIR Server (formerly the IBM FHIR Server)!

This version of the LinuxForHealth FHIR Server supports HL7 FHIR versions 4.0.1 and 4.3.0.

This release introduces support for HL7 FHIR version 4.3 (sometimes called "R4B") and removes support for select 4.0 resource types that have been removed in the specification.

It also introduces experimental support for:

  1. the Citus distributed PostgreSQL backend for scale-out scenarios; and
  2. asynchronous search parameter indexing for improved ingestion performance

Both of these experimental features have important limitations to be aware of:

  1. Citus search limitations
  2. Async indexing impacts data consistency

Added

Changed

Removed

Fixed

Security

Migration Considerations

To migrate from a prior version to version 5.0.0:

  1. Analyze configuration changes and prepare for the upgrade
    • Due to the package rename (com.ibm -> org.linuxforhealth), fhirServer/persistence/factoryClassname and fhirServer/audit/serviceClassName values must be updated in each fhir-server-config.json
    • fhirServer/bulkdata/core/batchIdEncryptionKey was renamed to fhirServer/bulkdata/core/batchIdEncodingKey
  2. Stop the server (or otherwise prevent write requests).
  3. Perform a database back up.
  4. Run the fhir-persistence-schema-5.0.0-cli.jar --update-schema command.
  5. Deploy the new server.
  6. Perform a complete re-indexing.

Special considerations for upgrading to 5.0.0:

  • Due to the package rename (com.ibm -> org.linuxforhealth), all META-INF/service files must be renamed. This impacts all FHIRRegistryResourceProvider (e.g. packaging for IGs) and FHIRPersistenceInterceptor implementations.
  • There is no support for migrating data from an existing (single-node) PostgreSQL installation to a distributed Citus backend.
  • fhir-persistence-schema: Prior to LinuxForHealth FHIR Server version 5.0.0, the default value for --db-type was db2. As of version 5.0.0, there is no longer a default value and --db-type must be specified every time.

If upgrading from a version prior to 4.11.0, be sure to review the applicable migration considerations:

Note: for schema migrations, ...

Read more

LinuxForHealth FHIR Server 5.0.0 RC2

29 Aug 21:40
f0b2cd8
Compare
Choose a tag to compare
Pre-release

The second release candidate of the LinuxForHealth FHIR Server (formerly the IBM FHIR Server).

This version of the LinuxForHealth FHIR Server supports HL7 FHIR versions 4.0.1 and 4.3.0.

This release fixes minor issues found in the first release candidate.

The full release notes for this release candidate have been merged into the official 5.0.0 Release.

LinuxForHealth FHIR Server 5.0.0 RC1

22 Aug 15:45
12699ad
Compare
Choose a tag to compare
Pre-release

The first release candidate of the LinuxForHealth FHIR Server (formerly the IBM FHIR Server).

This version of the LinuxForHealth FHIR Server supports HL7 FHIR versions 4.0.1 and 4.3.0.

This release introduces support for HL7 FHIR version 4.3 (sometimes called "R4B") and removes support for select 4.0 resource types that have been removed in the specification.

It also introduces experimental support for:

  1. the Citus distributed PostgreSQL backend for scale-out scenarios; and
  2. asynchronous search parameter indexing for improved ingestion performance

Both of these experimental features have important limitations to be aware of:

  1. Citus search limitations
  2. Async indexing impacts data consistency

The full release notes for this release candidate have been merged into the official 5.0.0 Release.

IBM FHIR Server 4.11.1

26 Apr 12:31
dfef557
Compare
Choose a tag to compare

This version of the IBM FHIR Server supports HL7 FHIR Specification version v4.0.1.

Changed

Fixed

Using the Release

Run or extend the Docker image from https://hub.docker.com/r/ibmcom/ibm-fhir-server or download fhir-install-4.11.1.zip and install as described at https://ibm.github.io/FHIR/guides/FHIRServerUsersGuide.

Note: starting with version 4.11.0, we will periodically rebuild our docker images in an attempt to keep vulnerabilities out of the base image.

If upgrading from a version prior to 4.11.0, be sure to review the applicable migration considerations:

Note: for schema migrations, only the latest version of the fhir-persistence-schema tool must be run.

Check the Assets section for downloads.
For Maven users, all project binaries are posted to Maven Central with a version of 4.11.1.

IBM FHIR Server 4.11.0

06 Apr 19:10
a195cfc
Compare
Choose a tag to compare

This version of the IBM FHIR Server supports HL7 FHIR Specification version v4.0.1.

This release drops support for Java 8, adds support for the system and type-level history interactions, introduces resource payload offloading to Azure Blob Storage, and includes a large number of bug fixes and Java API changes.

The release packages OpenLiberty 22.0.0.3. This version enables users to configure unauthenticated access to protected resources (#1020). However, it also includes a known issue that affects the OpenAPI UI: https://www.ibm.com/support/pages/apar/PH44666

Added

Changed

Deprecated

Removed

Fixed

Read more

IBM FHIR Server 4.10.2

02 Dec 13:48
154adb6
Compare
Choose a tag to compare

This version of the IBM FHIR Server supports HL7 FHIR Specification version v4.0.1.

Changed

Removed

Fixed

Using the Release

Run or extend the Docker image from https://hub.docker.com/r/ibmcom/ibm-fhir-server or download fhir-install-4.10.2.zip and install as described at https://ibm.github.io/FHIR/guides/FHIRServerUsersGuide.

If upgrading from a version prior to 4.10.0, be sure to review the applicable migration considerations:

Note: for schema migrations, only the latest version of the fhir-persistence-schema tool must be run.

Check the Assets section for downloads.
For Maven users, all project binaries are posted to Maven Central with a version of 4.10.2.

IBM FHIR Server 4.10.1

23 Nov 20:06
a68a54f
Compare
Choose a tag to compare

This version of the IBM FHIR Server supports HL7 FHIR Specification version v4.0.1.

This release bumps to OpenLiberty 21.0.0.11 to fix an intermittent NullPointerException we were seeing on IBM FHIR Server 4.10.0 with OpenLiberty 21.0.0.9.

Changed

Fixed

Using the Release

If upgrading from a version prior to 4.10.0, be sure to review the applicable migration considerations:

Note: for schema migrations, only the latest version of the fhir-persistence-schema tool must be run.

For Maven users, all project binaries are posted to Maven Central with a version of 4.10.1.

IBM FHIR Server 4.10.0

17 Nov 18:55
7e6616c
Compare
Choose a tag to compare

This version of the IBM FHIR Server supports HL7 FHIR Specification version v4.0.1.

This release reduces the default initial heap size and introduces experimental CQL support, a $member-match implementation framework with a simplistic default strategy, and numerous other enhancements and fixes.
With this release, we now package multiple versions of the US Core (3.1.1 and 4.0.0) and CARIN for BlueButton (1.0.0 and 1.1.0) implementation guides and we've introduced new configuration options for controlling which profile versions are used for validation and which parameter versions are used for search.

Added

Changed

Deprecated

Removed

Fixed

Security

Migration Considerations

To migrate from a prior version of the IBM FHIR Server to version 4.10.0:

  1. Analyze configuration changes and prepare for the upgrade
    • fhirServer/core/checkControlCharacters defaults to true
    • fhirServer/resources/<resourceType>/profiles/allowUnknown default to true; set to false for backwards compatibility if (and only if) you were using fhirServer/resources/<resourceType>/profiles/atLeastOne
    • fhirServer/resources/<resourceType>/profiles/notAllowed; default is allow all
    • fhirServer/resources/<resourceType>/profiles/defaultVersions; if you were previously using US Core 3.1.1 or CARIN for BlueButton 1.0.0 then be sure to set those versions as the default for each relevant profile to ensure backwards-compatibility
  2. Stop the server (or otherwise prevent write requests).
  3. Perform a database back up.
  4. Run the fhir-persistence-schema-4.10.0-cli.jar --update-schema command. If using a non-admin user (recommended), also perform the --grant-to action.
  5. Deploy the new server.
  6. Re-indexing should not be required except for rare circumstances related to updated case-sensitivity logic for token search parameters that target code values.

Special considerations for upgrading to 4.10.0:

  • This release includes a backwards-breaking change for users that have extended the IBM FHIR Server with custom operations and/or interceptors. Specifically, the FHIRPersistenceInterceptor and FHIROperation SPI c...
Read more