Hl7.Fhir.Specification.STU3 5.0.0-beta1

IMPORTANT The 5.0 version of the SDK contains substantial changes to the way we have organized the NuGet packages and source code. Please read before installing this new 5.0 version.

IMPORTANT Version 5.0 of the SDK is in beta. Navigate back to the main repository for the stable 4.x release.

Introduction

This is Firely's official support SDK for working with HL7 FHIR on the Microsoft .NET (dotnet) platform.

This SDK provides:

• Class models for working with the FHIR data model using POCO's
• Xml and Json parsers and serializers
• A REST client for working with FHIR-compliant servers
• Helper classes to work with the specification metadata, most notably StructureDefinition and generation of differentials
• Validation of instances based on profiles
• Evaluation FhirPath expressions

Release notes

Read the releases notes on firely-net-sdk/releases. You can find documentation about this SDK in the Firely docs site.

Getting Started

Before installing one of the NuGet packages (or clone the repo) it is important to understand that HL7 has published several updates of the FHIR specification, each with breaking changes - so you need to ensure you use the version that is right for you:

• DSTU1 (published September 2014) is mostly obsolete and we are no longer maintaining this library for DSTU1.
• DSTU2 (published October 2015) is mostly obsolete and and we are no longer maintaining this library for DSTU2.
• STU3 (published March 2017) is older, but still widely in use. Is fully supported by this library.
• R4 (published January 2019) is in active use and fully supported by this library.
• R4B (published May 2022) is the latest official release of the FHIR spec and is fully supported by this library.
• R5 (not yet published) is work-in-progress. This library currently supports "snapshot-1".

Planned release DSTU2.1 was never published by HL7, but you will still find traces of it. We are not maintaining the version, but the NuGet package is still available.

Read the online documentation, and download the correct NuGet package for your FHIR release. Depending on the version of FHIR you require, you'll find the relevant link to the package below. For most developers, just including this NuGet package is enough to get started.

Upgrading

We spend a lot of effort trying to maintain compile compatibility (not binary compatibility) between minor releases of the SDK. We do, however, publish a new major version with breaking changes about once a year. The table below lists the breaking changes for each of the major upgrades.

The SDK has been totally restructured for the 5.0 release. Please take not of the following changes if you are upgrading:

• The additional Hl7.Fhir.Specification packages are no longer relevant starting at version 5.0 of the SDK and should not be included in your projects anymore.
• The main NuGet package no longer contains the specification.zip file that contains all the conformance resources used in the FHIR specification. If you are using the ZipSource resolvers (e.g. for profile validation), you will need to include the correct HL7.Fhir.Specification.Data.* NuGet packages. We recommend you look at the newer FhirPackageResolver that directly use the HL7-published NPM packages. Documentation can be found here.
• The profile validator has been split off into its own repository. The NuGet packages for the 5.0 version of the profile validator will be posted soon.

Support

We actively monitor the issues coming in through the GitHub repository at https://github.com/FirelyTeam/firely-net-sdk/issues. You are welcome to register your bugs and feature suggestions there. For questions and broader discussions, we use the .NET FHIR Implementers chat on Zulip.

Contributing

We are welcoming contributions!

If you want to participate in this project, we're using Git Flow for our branch management. Please submit PRs with changes against the develop branche.

Note: Since the 5.0 release of the SDK, the branches for STU3 and newer have been combined in a single develop branch. This branch now contains the code for all FHIR releases from STU3 and up. We have also refactored all the common code out to projects within that branch, so the separate common repository (at https://github.com/FirelyTeam/firely-net-common) is no longer in use. This greatly simplifies management and creating PRs for these projects.