Hl7.Fhir.R4 4.0.0-beta1
| STU3 | R4 | R4B | R5 |
|---|---|---|---|
 |
 |
 |
 |
Introduction
This is the official support SDK for working with HL7 FHIR on the Microsoft .NET (dotnet) platform.
Release notes
Read the releases notes on firely-net-sdk/releases. You can find documentation about this SDK in the Firely docs site.
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), 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.
Getting Started
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
Upgrading to 2.x? Breaking changes are listed here.
Going further? See 3.x breaking changes.
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 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-stu3/develop-r4/develop-r4B/develop-r5 branches as mentioned above!
GIT branching strategy
- NVIE
- Or see: Git workflow
Showing the top 20 packages that depend on Hl7.Fhir.R4.
| Packages | Downloads |
|---|---|
|
DHP.Contracts
Package Description
|
34 |
|
DHP.Contracts
Package Description
|
35 |
|
DHP.Contracts
Package Description
|
37 |
|
DHP.Contracts
Package Description
|
39 |
|
DHP.Contracts
Package Description
|
40 |
|
DHP.Contracts
Package Description
|
41 |
|
DHP.Contracts
Package Description
|
42 |
|
DHP.Contracts
Package Description
|
54 |
|
dhp.fhir
Package Description
|
34 |
|
dhp.fhir
Package Description
|
36 |
|
dhp.fhir
Package Description
|
38 |
|
dhp.fhir
Package Description
|
40 |
|
dhp.fhir
Package Description
|
42 |
|
dhp.fhir
Package Description
|
44 |
|
dhp.fhir
Package Description
|
60 |
|
dhp.fhir
Package Description
|
161 |
.NET Framework 4.5.2
- Hl7.Fhir.Serialization (>= 4.0.0-beta1)
- Hl7.FhirPath (>= 4.0.0-beta1)
- Hl7.Fhir.Support (>= 4.0.0-beta1)
- Hl7.Fhir.Support.Poco (>= 4.0.0-beta1)
.NET Standard 2.0
- System.ComponentModel.Annotations (>= 5.0.0)
- Hl7.FhirPath (>= 4.0.0-beta1)
- Hl7.Fhir.Support (>= 4.0.0-beta1)
- Hl7.Fhir.Support.Poco (>= 4.0.0-beta1)
- Hl7.Fhir.Serialization (>= 4.0.0-beta1)
.NET 6.0
- Hl7.FhirPath (>= 4.0.0-beta1)
- System.ComponentModel.Annotations (>= 5.0.0)
- Hl7.Fhir.Support.Poco (>= 4.0.0-beta1)
- Hl7.Fhir.Serialization (>= 4.0.0-beta1)
- Hl7.Fhir.Support (>= 4.0.0-beta1)
| Version | Downloads | Last updated |
|---|---|---|
| 6.0.0-alpha1 | 2 | 12/15/2024 |
| 5.11.1 | 7 | 11/28/2024 |
| 5.11.0 | 7 | 11/12/2024 |
| 5.10.3 | 14 | 09/21/2024 |
| 5.10.2 | 6 | 09/21/2024 |
| 5.10.1 | 6 | 09/21/2024 |
| 5.10.0 | 7 | 09/21/2024 |
| 5.9.1 | 9 | 08/28/2024 |
| 5.9.0 | 16 | 08/10/2024 |
| 5.8.2 | 32 | 07/22/2024 |
| 5.8.1 | 24 | 06/04/2024 |
| 5.8.0 | 29 | 07/23/2024 |
| 5.7.0 | 25 | 07/23/2024 |
| 5.6.1 | 28 | 07/23/2024 |
| 5.6.0 | 30 | 07/23/2024 |
| 5.5.1 | 76 | 02/05/2024 |
| 5.5.0 | 28 | 07/23/2024 |
| 5.4.0 | 30 | 07/23/2024 |
| 5.3.0 | 33 | 07/23/2024 |
| 5.2.0 | 31 | 07/23/2024 |
| 5.1.0 | 26 | 07/23/2024 |
| 5.0.0 | 37 | 07/23/2024 |
| 5.0.0-beta3 | 27 | 07/23/2024 |
| 5.0.0-beta2 | 29 | 07/23/2024 |
| 5.0.0-beta1 | 24 | 07/23/2024 |
| 4.3.0 | 39 | 07/23/2024 |
| 4.2.1 | 39 | 07/23/2024 |
| 4.2.0 | 27 | 07/23/2024 |
| 4.1.0 | 39 | 07/23/2024 |
| 4.0.0 | 29 | 07/23/2024 |
| 4.0.0-beta2 | 31 | 07/23/2024 |
| 4.0.0-beta1 | 35 | 07/23/2024 |
| 3.8.3 | 32 | 07/23/2024 |
| 3.8.2 | 29 | 07/23/2024 |
| 3.8.1 | 30 | 07/23/2024 |
| 3.8.0 | 26 | 07/23/2024 |
| 3.7.0 | 31 | 07/23/2024 |
| 3.6.0 | 36 | 07/23/2024 |
| 3.5.0 | 28 | 07/23/2024 |
| 3.4.0 | 41 | 07/23/2024 |
| 3.3.0 | 27 | 07/23/2024 |
| 3.2.0 | 30 | 07/27/2024 |
| 3.1.0 | 29 | 07/23/2024 |
| 3.0.0 | 43 | 07/23/2024 |
| 2.0.3 | 27 | 07/23/2024 |
| 2.0.2 | 26 | 07/23/2024 |
| 2.0.1 | 26 | 07/23/2024 |
| 2.0.0 | 34 | 07/23/2024 |
| 2.0.0-beta2 | 33 | 07/23/2024 |
| 2.0.0-beta1 | 26 | 07/23/2024 |
| 1.9.0 | 32 | 07/23/2024 |
| 1.8.0 | 34 | 07/23/2024 |
| 1.7.0 | 25 | 07/23/2024 |
| 1.6.0 | 23 | 07/23/2024 |
| 1.5.0 | 22 | 07/23/2024 |
| 1.5.0-beta1 | 25 | 07/23/2024 |
| 1.4.0 | 32 | 07/23/2024 |
| 1.3.0 | 27 | 07/23/2024 |
| 1.2.1 | 27 | 07/23/2024 |
| 1.2.0 | 34 | 07/23/2024 |
| 1.2.0-beta2 | 30 | 07/23/2024 |
| 1.2.0-beta1 | 30 | 07/23/2024 |
| 0.96.1 | 35 | 07/23/2024 |
| 0.96.0 | 27 | 07/23/2024 |
| 0.95.0 | 29 | 07/23/2024 |
| 0.94.0-beta3 | 35 | 07/22/2024 |