dotnet add package Hl7.Fhir.R4 --version 5.4.0
NuGet\Install-Package Hl7.Fhir.R4 -Version 5.4.0
<PackageReference Include="Hl7.Fhir.R4" Version="5.4.0" />
paket add Hl7.Fhir.R4 --version 5.4.0
#r "nuget: Hl7.Fhir.R4, 5.4.0"
// Install Hl7.Fhir.R4 as a Cake Addin #addin nuget:?package=Hl7.Fhir.R4&version=5.4.0 // Install Hl7.Fhir.R4 as a Cake Tool #tool nuget:?package=Hl7.Fhir.R4&version=5.4.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.
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
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 in active use and fully supported by the SDK.
- R5 (published March 26 2023) is the latest official release of the FHIR spec and is fully supported by the SDK.
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.
Using a pre-release NuGet package
Every release of the SDK results in a NuGet package on the normal NuGet feed. However, each commit on our develop branch also results in a pre-release package.
These are public too. So if you want to be brave and use a pre-release packages, you can do so by adding
https://nuget.pkg.github.com/FirelyTeam/index.json to your NuGet sources:
Get a Personal Access token (PAT) from github.com with scope
Next open a console on your machine and run
dotnet nuget add source --name github --username <USERNAME> --password <PAT> https://nuget.pkg.github.com/FirelyTeam/index.json
USERNAME: your username on GitHub
PAT: your Personal access token with at least the scope
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 (
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.
|Product||Versions Compatible and additional computed target framework versions.|
|.NET||net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.|
|.NET Core||netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.|
|.NET Standard||netstandard2.0 is compatible. netstandard2.1 was computed.|
|.NET Framework||net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.|
|MonoAndroid||monoandroid was computed.|
|MonoMac||monomac was computed.|
|MonoTouch||monotouch was computed.|
|Tizen||tizen40 was computed. tizen60 was computed.|
|Xamarin.iOS||xamarinios was computed.|
|Xamarin.Mac||xamarinmac was computed.|
|Xamarin.TVOS||xamarintvos was computed.|
|Xamarin.WatchOS||xamarinwatchos was computed.|
NuGet packages (38)
Showing the top 5 NuGet packages that depend on Hl7.Fhir.R4:
Metapackage including Firely's SDK Base Class Library and specification conformance data for HL7 FHIR R4. Its sole purpose is to provide a backwards-compatible package reference for projects that used pre-5.0 versions of the SDK.
Allows SanteDB iCDR to accept FHIR messages.
FHIR Server Engine - Handling REST Calls and Service Layer
MongoDB Storage Implementation for Spark
GitHub repositories (6)
Showing the top 5 popular GitHub repositories that depend on Hl7.Fhir.R4:
ACID Document Database
A service that implements the FHIR standard
OSS Implementation of DICOMweb standard
Firely and Incendi's open source FHIR server
Set of tools for helping with data (in FHIR format) anonymization.