IBM FHIR Server 4.8.3

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

This release focuses on fixing bugs, improving performance, and adding support for customizable compartment definitions.

Added

• Support for non-validating builders / parsers
• Support for MIME-type parameter fhirVersion
• Ability to configure headers in RemoteTermServiceProvider configuration
• Support customizable compartment definitions

Changed

• Skip "parse validation" while reading resources from the database
  • we expect this change to be a noticeable performance improvement for read, vread, history, and update interactions
• Avoid redundant reads during update interaction
• resolve function in FHIRPATH expression
  • introduced fhirServer/core/serverResolveFunctionEnabled (default=false) for controlling whether the server should resolve references from the database when evaluating FHIRPath expressions
• The default fhir-server-config file-based bulk storageProvider should point to an existing directory
• Set more specific batch bundle action in audit event when possible
• Add warning to fhir-persistence-schema about the plan to remove the Resource and DomainResource table groups

Deprecated

• FHIRParser.PROPERTY_IGNORE_UNRECOGNIZED_ELEMENTS
  • use FHIRParser.setIgnoringUnrecognizedElements(boolean) instead
• fhirServer/search/useStoredCompartmentParam
  • we already changed the default from false to true in 4.6.1; this is a notice that we plan to remove this config option in the future
• All of the following schema tables

  DOMAINRESOURCE_DATE_VALUES
  DOMAINRESOURCE_LATLNG_VALUES
  DOMAINRESOURCE_LOGICAL_RESOURCES
  DOMAINRESOURCE_NUMBER_VALUES
  DOMAINRESOURCE_QUANTITY_VALUES
  DOMAINRESOURCE_RESOURCE_TOKEN_REFS
  DOMAINRESOURCE_RESOURCES
  DOMAINRESOURCE_STR_VALUES
  RESOURCE_DATE_VALUES
  RESOURCE_LATLNG_VALUES
  RESOURCE_LOGICAL_RESOURCES
  RESOURCE_NUMBER_VALUES
  RESOURCE_QUANTITY_VALUES
  RESOURCE_RESOURCE_TOKEN_REFS
  RESOURCE_RESOURCES
  RESOURCE_STR_VALUES
  

• The fhir-server-distribution.zip name (deprecated in 4.8.0)

Fixed

• IBM FHIR Server CapabilityStatement is invalid
• Trouble with the Liberty OpenAPI feature
• Deadlock during concurrent updates on Derby
• XAER_OUTSIDE when BulkData Export on Patient is run twice
• Error on bulk data status call where import did not import anything.
• Missing identifier modifier in FHIRParameters.Modifier enum
• FHIRClient.getWebTarget(String baseURL) throws NPE
• FHIR Persistence schema updateSchema has a second call to the updateProc which shouldn't be necessary.
• Unable to disambiguate inherited fields in fhir-model
• CARIN BB service-date doesn't search on ExplanationOfBenefit.item.servicedDate
  • this fix requires a reindex of previously-ingested ExplanationOfBenefit resources in order to take affect
• CARIN BB Institutional EOB 'adjudication-has-amount-type-slice' constraints are not specified correctly

Migration Considerations

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

1. Analyze configuration changes and prepare for the upgrade:
   • #2296 introduces fhirServer/core/serverResolveFunctionEnabled (default=false) for controlling whether the server should resolve references from the database when evaluating FHIRPath expressions (e.g. for constraint evaluation)
   • Derby and Db2 dataSource elements should now have isolationLevel="TRANSACTION_READ_COMMITTED"
     • This setting is not needed for PostgreSQL dataSources
2. Deploy the new server.
3. If using the CARIN for BlueButton implementation guide, a reindex of ExplanationOfBenefit resources is required for #2460.

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

• 4.8.2 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://hub.docker.com/r/ibmcom/ibm-fhir-server or download fhir-install-4.8.3.zip and install as described at https://ibm.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:

• fhir-persistence-schema-4.8.3-cli.jar
• fhir-swagger-generator-4.8.3-cli.jar
• fhir-bucket-4.8.3-cli.jar
• fhir-path-4.8.3-cli.jar

Usage is documented in the corresponding README files:

• https://github.com/IBM/FHIR/tree/master/fhir-persistence-schema
• https://github.com/IBM/FHIR/tree/master/fhir-swagger-generator
• https://github.com/IBM/FHIR/tree/master/fhir-bucket
• https://github.com/IBM/FHIR/tree/master/fhir-path

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

4.8.3 is the first release in which we've decided not to re-release the fhir-examples module (as there are no updates since 4.8.2). We will likely split this module into a separate repo with its own release cadence at some point in the future.