dotnet add package Hl7.Fhir.R5 --version 5.0.0
NuGet\Install-Package Hl7.Fhir.R5 -Version 5.0.0
<PackageReference Include="Hl7.Fhir.R5" Version="5.0.0" />
paket add Hl7.Fhir.R5 --version 5.0.0
#r "nuget: Hl7.Fhir.R5, 5.0.0"
// Install Hl7.Fhir.R5 as a Cake Addin #addin nuget:?package=Hl7.Fhir.R5&version=5.0.0 // Install Hl7.Fhir.R5 as a Cake Tool #tool nuget:?package=Hl7.Fhir.R5&version=5.0.0
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.
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
StructureDefinitionand generation of differentials
- Validation of instances based on profiles
- Evaluation FhirPath expressions
Read the releases notes on firely-net-sdk/releases. You can find documentation about this SDK in the Firely docs site.
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:
- STU3 (published March 2017) is older, but still widely in use and fully supported by the SDK.
- R4 (published January 2019) is in active use and fully supported by the SDK.
- R4B (published May 2022) is the latest official release of the FHIR spec and is fully supported by the SDK.
- R5 (not yet published) is work-in-progress. This library currently supports "snapshot-1".
Read the online documentation, and download the correct 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.
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.
|SDK version||Breaking changes|
The SDK has been restructured for the 5.0 release. Please take note of the following changes if you are upgrading:
- You should only reference the main package (
- If you need the
specification.zip(for validation, if you are using the
- The "old"
Hl7.Fhir.Specification.<release>package is now a metapackage that will include these two packages.
- You should not reference any other packages that existed pre-5.0 (
The profile validator has been split off into its own repository. The NuGet packages for the validator that are compatible with the SDK 5.0 release can be found on NuGet.
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.
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
Note: Since the 5.0 release of the SDK, the branches for STU3 and newer have been combined in a single
developbranch. 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
commonrepository (at https://github.com/FirelyTeam/firely-net-common) is no longer in use. This greatly simplifies management and creating PRs for these projects.
|.NET||net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows|
|.NET Core||netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1|
|.NET Standard||netstandard2.0 netstandard2.1|
|.NET Framework||net461 net462 net463 net47 net471 net472 net48 net481|
- Hl7.Fhir.Conformance (>= 5.0.0)
- Hl7.Fhir.Conformance (>= 5.0.0)
NuGet packages (7)
Showing the top 5 NuGet packages that depend on Hl7.Fhir.R5:
Metapackage including Firely's SDK Base Class Library and specification conformance data for HL7 FHIR R5. Its sole purpose is to provide a backwards-compatible package reference for projects that used pre-5.0 versions of the SDK.
Firely's Legacy profile validator (pre-SDK 5.0) for HL7 FHIR R5.
This library Implements a FHIR Facade that you can add to other projects where you provide the storage engine through implementing a set of model interface classes
Demonstration implementation of a FHIR R4 Facade using the file system as a super simple storage provider
This package is not used by any popular GitHub repositories.