HAPI FHIR 1.5

April 20, 2016 - HAPI FHIR 1.5 Released - The next release of HAPI has now been uploaded to the Maven repos and GitHub's releases section. This release corrects a security vulnerability as described below. All users are recommended to upgrade.

This release brings a number of bugfixes and a few bigger things. As always, the changelog has the full list of changes in this version. Some changes of note include:

• This release fixes a security vulnerability in the XML parser. See GitHub Issue #339 for information.
• This release adds support for the current draft STU3 structure definitions, known as FHIR 1.4.0 (or the Montreal Connectathon Snapshot). See the downloads page for information on the various versions of FHIR supported by HAPI FHIR.
• A new JAX-RS based client has been added.
• A Server Security Interceptor has been added.
• The JPA server has been enhanced so that search results are now paged into the database instead of simply to memory. This makes the server much more scalable to supporting larger result sets, larger volumes of queries, and operation across multiple nodes in a cluster.

HAPI FHIR 1.4

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

This release has taken a lot longer than originally planned. Mainly this is because we have taken a number of huge steps towards integrating HAPI FHIR with the HL7.org Java Reference Implementation. This effort will mean great things for all Java FHIR developers from now on, as it will bring a rich set of tools to everyone. See the DSTU3/RI page for information on this effort.

This release brings a number of bugfixes and a few bigger things. As always, the changelog has the full list of changes in this version. Some changes of note include:

• This release adds support for the current draft DSTU3 structure definitions, which were called DSTU2.1 until the decision in January by HL7 to call the next release DSTU3. See the downloads page for information on the various versions of FHIR supported by HAPI FHIR.
• Two great new modules to HAPI FHIR have been contributed to the project! A huge thanks to both contributors for their ongoing efforts.
• A new OSGi module (hapi-fhir-osgi-core) has been contributed by Akana. This module was originally added in the 1.3 release cycle but was cleaned up for use in 1.4.
• A new adapter (hapi-fhir-jaxrsserver-base) which allows the RESTful server to be used in JAX-RS environment was contributed by AGFA Healthcare.
• The Command-Line tool (hapi-fhir-cli) has been given options to start the server and uploader tools in either DSTU2 or DSTU3 mode. Both are supported by the same tool installation.
• Several of HAPI's library dependencies have been upgraded to the latest version (see the first entry in the changelog)

And just a reminder, if you haven't yet filled out the HAPI FHIR Community Survey, we would really appreciate if you did so!

HAPI FHIR 1.3

November 15, 2015 - HAPI FHIR 1.3 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 a few bigger things. As always, the changelog has the full list of changes in this version. Some changes of note include:

• FHIR DSTU2 definitions have been updated to v1.0.2 of the FHIR specification (see the downloads page for FHIR version support information)
• The JPA server now uses Lucene (via Hibernate Search) as an added indexing mechanism. This allows the server to support fulltext searching via the _content and _text search parameters.
• The JPA server has been converted from using Spring XML configuration to using Spring Java configuration. Existing JPA server users are recommended to look at the hapi-fhir-jpaserver-example project to see how the configuration looks now.
• A new Command-Line Tool called hapi-fhir-cli has been created. This tool has a bunch of cool features, including the ability to start up a fully functional FHIR server with a single command. A big thanks to David Hay for his help in testing this!
• Several of HAPI's library dependencies have been upgraded to the latest version (see the first entry in the changelog)

And just a reminder, if you haven't yet filled out the
HAPI FHIR Community Survey, we
would really appreciate if you did so!

HAPI FHIR 1.2

September 18, 2015 - HAPI FHIR 1.2 and Community Survey - We are very pleased the release of HAPI FHIR 1.2. This release brings support for the FHIR DSTU2 QA definitions (also known as FHIR 1.0.0). See the download page for information on support for different versions of FHIR within different versions of HAPI FHIR.

As always, the changelog has the full list of changes in this version.

We are also launching the 2015 HAPI FHIR Community Survey today. This 10 question survey will only take a minute, and it helps us to understand who uses HAPI and what you need. Please take a moment to fill it out!

HAPI FHIR 1.1

July 13, 2015 - HAPI FHIR 1.1 Released - HAPI 1.1 has been released! As always, you can see the complete list of what has changed by consulting the changelog, and the download page has information on where to get it.

HAPI FHIR 1.1 is the first release with support for the HL7.org "reference implementation" structures. This is an exciting development for us, as it means the beginning of our move to bring the two Java implementations of FHIR together into one library. As a part of this harmonization, we have made a few minor API changes. Specifically, a few methods that previously returned IResource or IdDt will now return parent interfaces of these classes: IBaseResource and IIdType respectively. Existing code can simply cast to IResource and IdDt as these classes are still in use, but new code may wish to take advantage of the new "RI" structures. During the next development cycle we will be integrating features from the HL7.org Java FHIR packages into HAPI, such as the instance/profile validator and the narrative generator.

See the HAPI DSTU2 documentation page for more information.

HAPI 1.0

May 8 2015 - HAPI 1.0 has been released!

This release is based on the May 2015 ballot candidate for DSTU2, and also includes support for DSTU1. A complete list of changes in this release is available in our changelog.

This release also coincides with the first snapshot builds of HAPI 1.1 which brings support for the FHIR "Reference Implementation Structures". The focus of the 1.1 build series will be to create a single library which takes advantage of the referrence implementation's powerful data model and validation tools, combining them with HAPI's powerful client and server frameworks.

HAPI 0.9

March 14, 2015 - HAPI FHIR 0.9 Released - HAPI 0.9 has now been released (both as binaries you can download from GitHub and as Maven dependencies you can download from Maven central). This release is an important one. It brings a number of fixes and new features, and most importantly brings suport for DSTU2 resources and parsing/encoding. DSTU2 is the upcoming next version of the FHIR specification itself. Also of particular note, the JPA Server has graduated to being included in the Maven repos (so you can create your own server which works just like ours). The Android JAR has also been included.

As always, you can see the complete list of what has changed by consulting the changelog, and the download page has information on where to get it.

Note on DSTU2: It is important to note that DSTU2 is not yet formally ballotted by HL7, and as such it is subject to change. A number of developers are starting to target it however, so support was important to us at HAPI HQ. See the HAPI DSTU2 page for information about how to add support for FHIR DSTU2 in your applications.

What's Next: We are planning on making the next release of HAPI be the 1.0 release. The biggest development on our plate for the next development cycle will be to finish the integration of the HL7.org structure classes. Some people may have noticed a project in our GitHub repo called "hapi-fhir-structures-hl7org" that isn't a part of the current build. What we are trying to do is to unify the HL7.org Java Reference Implementation data model with the HAPI one in a single set of classes. This will mean that HAPI users can take advantage of tools from the RI (such as the excellent validator that comes with it) and users of the RI can take advantage of HAPI's client and server toolkits. It is still not 100% clear what this integration will look like when it is complete, but that should become clear in the coming weeks.

As always, thanks to everyone who contributed code, pull requests, and filed bugs to make this release better. HAPI FHIR is the collective work of a large number of people now and we all benefit from the collective hard work being put in from around the world!

- James Agnew

HAPI 0.8

Dec 17, 2014 - HAPI FHIR 0.8 Released - HAPI 0.8 has been released! As always, thanks to everyone who contributed on this; this release includes a lot of bug fixes and new features from around the world.

See the changelog for a complete list of what's new!

In particular, this release marks the beginning of our push to separate the model classes (e.g. Patient, Encounter, etc.) from the core API, so that you can use any version of the structures you want in your application, or even combine versions if you need to. As is the case with HAPI's HL7 v2 library, you now need to include at least one new separate "structures" JAR with your application as of HAPI-FHIR 0.8. See the Upgrading and Download pages for more information.

With the newly separated "structures" dependencies, we have also introduced a separate "dev" version of the structures, which contains the current development structure definitions, which are now close to being in their final DSTU2 state (DSTU2 should be released in mid 2015 by HL7 although the date is not yet finalized). DSTU2 contains a number of new and updated resource definitions, but it also makes several infrastructure changes including a new Bundle format and a new encoding style for extensions in JSON. These changes are not yet supported in HAPI-FHIR 0.8, but will be included in HAPI-FHIR 0.9. We expect to deploy a working snapshot build of HAPI-FHIR 0.9 within the next day or so, including all of these changes.

One further note: We are currently working with Grahame Grieve on an initiative to harmonize HAPI's model objects with the FHIR Java Reference Implementation. This means that developers should in the future be able to use either the HAPI built-in resource definitions or the ones shipped by HL7. The advantage to this is that it will allow users of HAPI's API to take advantage of other tooling produced by HL7 (such as profile validators). Please get in touch (either by email or on the Google Group) if you would like to help test this.

HAPI 0.7

HAPI 0.7 has been released.

This release contains a number of contributions and bugfixes from all over the FHIR community. Thanks to everyone who contributed!

In particular, note that this release corrects an issue where contained resources sometimes got encoded as both contained and top-level resources, and top level resources sometimes got encoded as contained resources. It is possible that some existing applications depended on the buggy behaviour, so please do a bit of extra testing on your server applications if you use contained resources at all. See the resource references documentation for a bit more information on how these work, and please feel free to post to the google group if things aren't working as expected.

This release also introduces a fascinating Vagrant based development environment contributed by Preston Lee which should allow you to try out a fully functional, database backed HAPI server in a virtual server on your own development box.

See the changelog for a complete list of what's new!

HAPI-FHIR 0.6

The latest release of HAPI-FHIR adds a number of new features and brings a number of bug fixes too.

See the changelog for more information.