Install-Package Hl7.Fhir.Specification.R5 -Version 4.2.1
dotnet add package Hl7.Fhir.Specification.R5 --version 4.2.1
<PackageReference Include="Hl7.Fhir.Specification.R5" Version="4.2.1" />
paket add Hl7.Fhir.Specification.R5 --version 4.2.1
#r "nuget: Hl7.Fhir.Specification.R5, 4.2.1"
// Install Hl7.Fhir.Specification.R5 as a Cake Addin #addin nuget:?package=Hl7.Fhir.Specification.R5&version=4.2.1 // Install Hl7.Fhir.Specification.R5 as a Cake Tool #tool nuget:?package=Hl7.Fhir.Specification.R5&version=4.2.1
This is the official support SDK for working with HL7 FHIR on the Microsoft .NET (dotnet) platform.
What's in the box?
This library 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
IMPORTANT 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 the .NET version for this publication is not maintained anymore.
- DSTU2 (published October 2015) in widespread use, and is not supported by this library anymore since version 2.0.
- STU3 (published March 2017), mature support by this library and most other tooling on the market.
- R4 (published January 2019), mature support by this library and fully supported by this library.
- R4B (published May 2022), the latest release of the FHIR spec and fully supported by this library.
Planned release DSTU2.1 was never published by HL7, but you will still find traces of it, in particular we still keep the NuGet package for it available.
Get started by reading the online documentation. Depending on the version of FHIR you require, you'll find the relevant links to the packages and develop branches in this repository below:
Please note that the source code for the Firely .NET SDK is split up into two GitHub repos: one (with the branches listed above) with code that is specific to a FHIR release (this repo), and one that contains the code that is applicable across all FHIR releases (a separate common repository). This second repository is included in the first one using a Git Submodule, so all you have to do is check out the main repo (this one) and learn how to work with Submodules. To clone this repository with submodules, you can do:
git clone --recurse-submodules -j8 https://github.com/FirelyTeam/firely-net-sdk.git .
Please refer to our submodules overview for more details.
Upgrading to 2.x? Breaking changes are listed here.
Going further? See 3.x breaking changes.
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 contributors!
If you want to participate in this project, we're using Git Flow for our branch management, so please submit your commits using pull requests on the correct
develop-r5 branches as mentioned above!
GIT branching strategy
|.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|
|.NET Core||netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1|
|.NET Standard||netstandard2.0 netstandard2.1|
|.NET Framework||net452 net46 net461 net462 net463 net47 net471 net472 net48|
NuGet packages (2)
Showing the top 2 NuGet packages that depend on Hl7.Fhir.Specification.R5:
Firely Server (formerly: Vonk) supports building a Facade or a Plugin, see the product pages for Firely Server (https://fire.ly/products/firely-server and FHIR Facade (https://fire.ly/products/fhir-facade). Vonk.Fhir.R5 adds support for working with POCOs from the Firely .NET SDK for FHIR R5 in your Facade or Plugin. You need Firely Server to use Vonk.Fhir.R5. Go to the product page to download a copy, including an evaluation license. Visit the documentation pages (https://docs.fire.ly/firelyserver/index.html) for documentation and examples on how to build a Facade or a Plugin.
Demonstration implementation of a FHIR R4 Facade using the file system as a super simple storage provider
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on Hl7.Fhir.Specification.R5:
A service that implements the FHIR standard