Hl7.Fhir.R5 4.0.0-beta1

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.5.2 This package targets .NET Framework 4.5.2. The package is compatible with this framework or higher.
This is a prerelease version of Hl7.Fhir.R5.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Hl7.Fhir.R5 --version 4.0.0-beta1                

                    
                

            
NuGet\Install-Package Hl7.Fhir.R5 -Version 4.0.0-beta1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Hl7.Fhir.R5" Version="4.0.0-beta1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Hl7.Fhir.R5 --version 4.0.0-beta1                

                    
                

            
#r "nuget: Hl7.Fhir.R5, 4.0.0-beta1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Hl7.Fhir.R5 as a Cake Addin
#addin nuget:?package=Hl7.Fhir.R5&version=4.0.0-beta1&prerelease

// Install Hl7.Fhir.R5 as a Cake Tool
#tool nuget:?package=Hl7.Fhir.R5&version=4.0.0-beta1&prerelease
STU3 R4 R4B R5
Build Status Build Status Build Status Build Status
Nuget Nuget Nuget Nuget

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 StructureDefinition and 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:

Spec version Git branch Core NuGet
R5 (experimental) https://github.com/FirelyTeam/firely-net-sdk/tree/develop-r5 https://www.nuget.org/packages/Hl7.Fhir.R5
R4B (experimental) https://github.com/FirelyTeam/firely-net-sdk/tree/develop-r4B https://www.nuget.org/packages/Hl7.Fhir.R4B
R4 https://github.com/FirelyTeam/firely-net-sdk/tree/develop-r4 https://www.nuget.org/packages/Hl7.Fhir.R4
STU3 https://github.com/FirelyTeam/firely-net-sdk/tree/develop-stu3 https://www.nuget.org/packages/Hl7.Fhir.STU3
DSTU2 https://github.com/FirelyTeam/firely-net-sdk/tree/develop https://www.nuget.org/packages/Hl7.Fhir.DSTU2
DSTU1 https://github.com/FirelyTeam/firely-net-sdk/tree/master-dstu1 https://www.nuget.org/packages/Hl7.Fhir.DSTU

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

Product 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-browser 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 net452 is compatible.  net46 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (11)

Showing the top 5 NuGet packages that depend on Hl7.Fhir.R5:

Package Downloads
Hl7.Fhir.Specification.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.Fhir.Validation.R5

Next-gen Firely validator for R5, which validates FHIR data against profiles.
Vonk.Fhir.R5

Package Description
Hl7.Fhir.Validation.Legacy.R5

Firely's Legacy profile validator (pre-SDK 5.0) for HL7 FHIR R5.
Lc.Linca.Sdk

Linked Care Client Software Development Kit The Linked Care Consortium https://linkedcare.at Annemarie Goldmann, Daniel Latikaynen

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Hl7.Fhir.R5:

Repository Stars
microsoft/fhir-server
A service that implements the FHIR standard
Version Downloads Last updated
5.11.0 866 11/8/2024
5.10.3 17,333 9/19/2024
5.10.2 995 9/18/2024
5.10.1 374 9/12/2024
5.10.0 304 9/10/2024
5.9.1 7,811 8/8/2024
5.9.0 10,574 7/25/2024
5.8.2 1,735 7/10/2024
5.8.1 38,639 5/2/2024
5.8.0 646 4/24/2024
5.7.0 10,387 3/15/2024
5.6.1 9,548 2/13/2024
5.6.0 180 2/13/2024
5.5.1 5,758 1/16/2024
5.5.0 589 1/10/2024
5.4.0 8,726 10/26/2023
5.3.0 15,838 7/27/2023
5.2.0 13,152 5/26/2023
5.1.0 3,846 4/28/2023
5.0.0 7,924 2/17/2023
5.0.0-beta3 1,037 2/1/2023
5.0.0-beta2 279 1/19/2023
5.0.0-beta1 433 12/21/2022
4.3.0 53,660 9/22/2022
4.2.1 4,861 8/17/2022
4.2.0 770 8/16/2022
4.1.0 3,110 7/7/2022
4.0.0 7,124 5/10/2022
4.0.0-beta2 259 3/4/2022
4.0.0-beta1 244 2/7/2022
3.8.3 1,511 4/29/2022
3.8.2 7,082 3/28/2022
3.8.1 806 3/4/2022
3.8.0 1,940 1/7/2022
3.7.0 6,027 12/1/2021
3.6.0 8,182 10/15/2021
3.5.0 3,007 9/2/2021
3.4.0 4,858 6/30/2021
3.3.0 1,366 6/2/2021
3.2.0 3,503 5/4/2021
3.1.0 781 4/1/2021
3.0.0 3,945 2/25/2021
2.0.3 782 1/26/2021
2.0.2 547 1/22/2021
2.0.1 1,036 11/25/2020
2.0.0 1,221 11/16/2020
2.0.0-beta2 537 9/22/2020
1.9.0-beta-june2020 12,374 7/23/2020
1.8.0-beta-june2020 516 7/3/2020
1.7.0-beta-may2020 8,274 5/7/2020

See https://github.com/FirelyTeam/firely-net-sdk/releases