HAPI FHIR 3.2.0

Jan 13, 2018 - HAPI FHIR 3.2.0 Released - The next release of HAPI has now been uploaded to the Maven repos and GitHub's releases section.

This is a fairly light release, with only a small number of new features, and a few bugfixes. See the changelog for a full list of changes.

• Support for using SearchParameter resources to define custom parameters in the JPA server has been backported to DSTU2, meaning that DSTU2 servers can now user this functionality (previously only DSTU3/R4 supported this)
• Several tweaks and enhancements to the server interceptor framework have been added
• Multitenancy support has been added to the server framework (note that this is only the plain server framework at this point, not the JPA server)
• The R4 structures have been synced to the latest definitions in anticipation of the January FHIR Connecathon (see Downloads for version details)
• Several bugfixes have been made

Thanks to everyone who contributed to this release!

- James Agnew

HAPI FHIR 3.1.0

HAPI FHIR 3.1.0 has been released!

This release brings several interesting things:

• Support for Android has been restored, and improved while we're at it! The use of a special "uberjar" with its own classifier is no longer required, hapi-fhir-android works as a normal Gradle dependency in your Android build. See the HAPI FHIR Android Integration Test for an example.
• Support for the Cache-Control header has been added for JPA server searches, allowing a client to request that cached results not be used.
• A number of bugs were fixed and performance improvements were made (see the changelog for a full list)
• Spring has been upgraded to the 5.0 series.
• Some initial refactoring has occurred towards enabling ElasticSearch support in JPA server. Note that any existing JPA projects will need to add an additional property in their Spring config called hibernate.search.model_mapping. See this line in the example project.
• Support for Spring Boot has been added to many of the modules of the libaray. See the Spring Boot Samples for examples of how to use this.

Thanks to everyone who contributed to this release!

HAPI FHIR 3.0.0

Sep 27, 2017 - HAPI FHIR 3.0.0 Released - The next release of HAPI has now been uploaded to the Maven repos and GitHub's releases section.

This is a massive release, and includes a huge number of enhancements, fixes, and new features. Unfotunately it also brings a few breaking API changes so we are calling it version 3.0.0 (we are also moving to SemVer versioning).

As always, the changelog has the full list of changes in this release. I am outlining a few of the important ones here:

FHIR R4 and DSTU1 Support

Support for FHIR R4 (current working draft) has been added (in a new module called hapi-fhir-structures-r4) and support for FHIR DSTU1 (hapi-fhir-structures-dstu) has been removed. Removing support for the legacy DSTU1 FHIR version was a difficult decision, but it allows us the opportunitity to clean up the codebase quite a bit, and remove some confusing legacy parts of the API (such as the legacy Atom Bundle class).

A new redesigned table of HAPI FHIR versions to FHIR version support has been added to the Download Page

Module Restructuring

HAPI FHIR's modules have been restructured for more consistency and less coupling between unrelated parts of the API.

A new complete list of HAPI FHIR modules has been added to the Download Page. Key changes include:

• HAPI FHIR's client codebase has been moved out of hapi-fhir-base and in to a new module called hapi-fhir-client. Client users now need to explicitly add this JAR to their project (and non-client users now no longer need to depend on it)
• HAPI FHIR's server codebase has been moved out of hapi-fhir-base and in to a new module called hapi-fhir-server. Server users now need to explicitly add this JAR to their project (and non-server users now no longer need to depend on it)
• As a result of the client and server changes above, we no longer need to produce a special Android JAR which contains the client, server (which added space but was not used) and structures. There is now a normal module called hapi-fhir-android which is added to your Android Gradle file along with whatever structures JARs you wish to add. See the Android Integration Test to see a sample project using HAPI FHIR 3.0.0. Note that this has been reported to work by some people but others are having issues with it! In order to avoid delaying this release any further we are releasing now despite these issues. If you are an Android guru and want to help iron things out please get in touch. If not, it might be a good idea to stay on HAPI FHIR 2.5 until the next point release of the 3.x series.
• A new JAR containing FHIR utilities called hapi-fhir-utilities has been added. This JAR reflects the ongoing harmonization between HAPI FHIR and the FHIR RI codebases and is generally required in order to use HAPI at this point (if you are using a dependency manager such as Maven or Gradle it will be brought in to your project automatically as a dependency)

Package Changes

In order to allow the reoganizations and decoupling above to happen, a number of important classes and interfaces have been moved to new packages. A sample list of these changes is listed below. When upgrading to 3.0.0 your project may well show a number of compile errors related to missing classes. In most cases this can be resolved by simply removing the HAPI imports from your classes and asking your IDE to "Organize Imports" once again. This is an annoying change we do realize, but it is neccesary in order to allow the project to continue to grow.

• IGenericClient moved from package ca.uhn.fhir.rest.client to package ca.uhn.fhir.rest.client.api
• IRestfulClient moved from package ca.uhn.fhir.rest.client to package ca.uhn.fhir.rest.client.api
• AddProfileTagEnum moved from package ca.uhn.fhir.rest.server to package ca.uhn.fhir.context.api
• IVersionSpecificBundleFactory moved from package ca.uhn.fhir.rest.server to package ca.uhn.fhir.context.api
• BundleInclusionRule moved from package ca.uhn.fhir.rest.server to package ca.uhn.fhir.context.api
• RestSearchParameterTypeEnum moved from package ca.uhn.fhir.rest.server to package ca.uhn.fhir.rest.api
• EncodingEnum moved from package ca.uhn.fhir.rest.server to package ca.uhn.fhir.rest.api
• Constants moved from package ca.uhn.fhir.rest.server to package ca.uhn.fhir.rest.api
• IClientInterceptor moved from package ca.uhn.fhir.rest.client to package ca.uhn.fhir.rest.client.api
• ITestingUiClientFactory moved from package ca.uhn.fhir.util to package ca.uhn.fhir.rest.server.util

Fluent Client Search Change

Because the Atom-based DSTU1 Bundle class has been removed from the library, users of the HAPI FHIR client must now always include a Bundle return type in search calls. For example, the following call would have worked previously:

Bundle bundle = client.search().forResource(Patient.class)
  .where(new TokenClientParam("gender").exactly().code("unknown"))
  .prettyPrint()
  .execute();

This now needs an explicit returnBundle statement, as follows:

Bundle bundle = client.search().forResource(Patient.class)
  .where(new TokenClientParam("gender").exactly().code("unknown"))
  .prettyPrint()
  .returnBundle(Bundle.class)
  .execute();

Thanks to everyone who contributed to this release, either by submitting pull requests, suggesting new features, or filing bug requests!

- James Agnew

HAPI FHIR 2.5

June 8, 2017 - HAPI FHIR 2.5 Released - The next release of HAPI has now been uploaded to the Maven repos and GitHub's releases section.

This release brings number of bugfixes and improvements. Most importantly for many users, this release brings a significant performance enhacement to the JPA server for searches. Essentially our search module has been rewritten to stream results back to the client as soon as they become available, and to reuse previous cached search results for a period of time. This cacheing behaviour in the JPA server is important to consider, since it does mean that your clients can see stale search results for a short period of time under some circumstances. The default cache period is 1 minute, but this can be changed or even disabled through configuration.

As always, the changelog has the full list of changes in this release. Thanks to everyone who contributed to this release, either by submitting pull requests, suggesting new features, or filing bug requests!

• James Agnew

HAPI FHIR 2.4

April 19, 2017 - HAPI FHIR 2.4 Released - The next release of HAPI has now been uploaded to the Maven repos and GitHub's releases section.

This release brings the STU3 definitions up to the final R3 (aka STU3) definitions (FHIR 3.0.1)! Happy R3 everybody!

As always, the changelog has the full list of changes in this release. Thanks to everyone who contributed to this release, either by submitting pull requests, suggesting new features, or filing bug requests!

We were later than we would have liked in delivering this release, as we are focusing heavily on performance improvements in the JPA module. We were hoping to have our performance branch merged in time for this release, but it needs a bit more time to stabilize. We will be releasing the initial snapshot builds of HAPI FHIR 2.5-SNAPSHOT immediately following this release. Please try these out if you want to test the JPA module with significant performance improvements when searching large datasets, or under heavy load.

- James Agnew

HAPI FHIR 2.3

March 17, 2017 - HAPI FHIR 2.3 Released - The next release of HAPI has now been uploaded to the Maven repos and GitHub's releases section.

This release brings the STU3 definitions up to the latest definitions (FHIR 1.9.0 - SVN 11501). It also brings in the latest validator fixes, as well as a number of other useful enhancements and fixes, including:

• A new experimental module for converting from DSTU2/2.1 structures to STU3 structures
• Support in the JPA server for custom search parameters (STU3 only for now)
• Many other performance fixes, enhancements, and bugfixes

As always, the changelog has the full list of changes in this release. Thanks to everyone who contributed to this release, either by submitting pull requests, suggesting new features, or filing bug requests!

- James Agnew

HAPI FHIR 2.2

December 20, 2016 - HAPI FHIR 2.2 Released - The next release of HAPI has now been uploaded to the Maven repos and GitHub's releases section.

This release is mainly to bring the STU3 definitions up to the latest definitions (FHIR 1.8.0 - SVN 10528) and is the version that should be used for the upcoming San Antonio Connectathon.

This release also introduces a new JAR (and associated Maven dependency library) called hapi-fhir-structures-dstu2.1. This module provides the structure classes for FHIR 1.4.0 (Montreal spanshot, sometimes referred to as DSTU2.1) which is used by a number of projects.

This release also brings a few miscellaneous bug fixes, and a few validation enhancements. As always, the changelog has the full list.

Note, to build this release from source, use commit 0ec61533a8d3f4c36fb38c09000f867349940157. The GitHub tag for this release accidentally points to the commit before this one.

• James Agnew

HAPI FHIR 2.1

November 11, 2016 - HAPI FHIR 2.1 Released - The next release of HAPI has now been uploaded to the Maven repos and GitHub's releases section.

This release brings several primary changes:

• STU3 definitions have been updated to the latest definitions (FHIR 1.7.0 - SVN 10129)
• Add support for FHIR Patch operation (thanks to Peter Girard of McKesson for his help on this!)
• Android library has been streamlined to use the OkHttp client by default (no more fighting with out-of-date Apache HttpClient. Thanks to Matt Clarke of Orion Health for his help on this!)
• The STU3 client now supports both the Conformance resource (which is going away) and the new CapabilityStatement (which replaces it). This should allow for a bridge while servers are migrated to the new resource type being returned by the /metadata endpoint.
  This release also brings a number of bugfixes and also quite a few enhancements. As always, the changelog has the full list of changes in this version. Among the enhancements in this release are:

As always, we welcome new contributions and contributors! Please feel free to get in touch if you are interested in getting involved with HAPI but don't know where to start.

• James Agnew

HAPI FHIR 2.0

August 30, 2016 - HAPI FHIR 2.0 Released - The next release of HAPI has now been uploaded to the Maven repos and GitHub's releases section.

This release brings several primary changes:

• The JSON parser used by HAPI's parser module has been switched from JSR353/JSONP to Google GSON. This should be an invisible change for most users (the only thing that broke for us was that a few extra spaces are inserted in pretty-printed encoding and this broke some overly sensitive unit tests). Gson is a much more active project than JSONP and should be better supported in the future.
• STU3 definitions have been updated to the FHIR 1.6.0 2016 September Ballot Candidate definitions (aka the 2016 Baltimore Connectathon version).
• Content-Types emitted by the library have been updated to use the new content type strings proposed for use as of STU3 (when using HAPI in STU3 mode). E.g. application/fhir+xml insead of the previous application/xml+fhir

This release also brings a number of bugfixes and also quite a few enhancements. As always, the changelog has the full list of changes in this version. Among the enhancements in this release are:

As always, we welcome new contributions and contributors! Please feel free to get in touch if you are interested in getting involved with HAPI but don't know where to start.

- James Agnew

HAPI FHIR 1.6

July 7, 2016 - HAPI FHIR 1.6 Released - The next release of HAPI has now been uploaded to the Maven repos and GitHub's releases section.

This release brings a number of bugfixes and also quite a few enhancements. As always, the changelog has the full list of changes in this version. Among the enhancements in this release are:

• Significant enhancements to FhirConetxt startup performance (especially on Android)
• Support for STU3 terminology services in the JPA module, including support for importing SNOMED CT and LOINC
• Update of the STU3 resources and validator to the latest snapshot
• Plenty of bug fixes

As always, thanks to everyone who contributed to this release, either though pull requests, bug reports, suggestions, and helping us test new features.

Also, a few quick community notes:

On DSTU3 naming: FMG has decided to rename the upcoming FHIR DSTU3 (draft standard for trial use) release to STU3 (standard for trial use). In order to avoid breaking existing software, we will NOT be renaming the hapi-fhir-structures-dstu3 module of HAPI. We will be updating documentation on the site to reflect the new name wherever it won't be confusing, but be aware that this is a potential source of confusion.

On the HAPI FHIR website: Regular visitors to our site will probably already have noticed that we recently moved the site to a new URL ( http://hapifhir.io ). This was done mostly to help make HAPI's URL a bit easier to remember.

On the future: For the next release, we are planning on moving away from the javax.json (JSR 353) library in favour of using Google GSON. JSR 353 seemed like a good choice when we started HAPI, but it has basically been abandoned and no longer seems like a good choice (especially given the headaches it causes on Android). This hopefully means that the next release will be able to do away with the "special" Android shade-jar releases and all of the Gradle file gymnastics that are required in order to use them.

As always, we welcome new contributions and contributors! Please feel free to get in touch if you are interested in getting involved with HAPI but don't know where to start.

- James Agnew