fhir-net-api - Hl7.Fhir.R4 3.1.1-alpha-20210407.6

This is the core support library for HL7's FHIR standard (http://hl7.org/fhir). It contains the core functionality to working with RESTful FHIR servers: POCO classes for FHIR, parsing/serialization of FHIR data and a FhirClient for easy access to FHIR servers.

PM> Install-Package Hl7.Fhir.R4 -Version 3.1.1-alpha-20210407.6 -Source https://www.myget.org/F/fhir-net-api/api/v3/index.json

Copy to clipboard

> nuget.exe install Hl7.Fhir.R4 -Version 3.1.1-alpha-20210407.6 -Source https://www.myget.org/F/fhir-net-api/api/v3/index.json

Copy to clipboard

> dotnet add package Hl7.Fhir.R4 --version 3.1.1-alpha-20210407.6 --source https://www.myget.org/F/fhir-net-api/api/v3/index.json

Copy to clipboard
<PackageReference Include="Hl7.Fhir.R4" Version="3.1.1-alpha-20210407.6" />
Copy to clipboard
source https://www.myget.org/F/fhir-net-api/api/v3/index.json

nuget Hl7.Fhir.R4  ~> 3.1.1-alpha-20210407.6
Copy to clipboard

> choco install Hl7.Fhir.R4 --version 3.1.1-alpha-20210407.6 --source https://www.myget.org/F/fhir-net-api/api/v2

Copy to clipboard
Import-Module PowerShellGet
Register-PSRepository -Name "fhir-net-api" -SourceLocation "https://www.myget.org/F/fhir-net-api/api/v2"
Install-Module -Name "Hl7.Fhir.R4" -RequiredVersion "3.1.1-alpha-20210407.6" -Repository "fhir-net-api" -AllowPreRelease
Copy to clipboard

Browse the sources in this package using Visual Studio or WinDbg by configuring the following symbol server URL: https://www.myget.org/F/fhir-net-api/api/v2/symbolpackage/


DSTU2 STU3 R4 Released
Build status Build status Build status Release status

Introduction

This is the official support API for working with HL7 FHIR on the Microsoft .NET (dotnet) platform.

Release notes

Read the releases notes and the documentation on simplifier

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 still supported by this library and other tooling on the market.
  • 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
R4 https://github.com/FirelyTeam/fhir-net-api/tree/develop-r4 https://www.nuget.org/packages/Hl7.Fhir.R4/
STU3 https://github.com/FirelyTeam/fhir-net-api/tree/develop-stu3 https://www.nuget.org/packages/Hl7.Fhir.STU3/
DSTU 2.1 N/A https://www.nuget.org/packages/Hl7.Fhir.DSTU21/
DSTU2 https://github.com/FirelyTeam/fhir-net-api/tree/develop|https://www.nuget.org/packages/Hl7.Fhir.DSTU2/|
DSTU1 https://github.com/FirelyTeam/fhir-net-api/tree/master-dstu1|https://www.nuget.org/packages/Hl7.Fhir.DSTU/|

Please note that the source code for the FHIR .NET API is split up into two GitHub repo's: 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.

Support

We actively monitor the issues coming in through the GitHub repository at https://github.com/FirelyTeam/fhir-net-api/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/develop-stu3/develop-r4 branches as mentioned above!

GIT branching strategy

  • .NETFramework 4.5
    • Hl7.Fhir.Serialization (>= 3.1.1-alpha-20210407.6)
    • Hl7.Fhir.Support (>= 3.1.1-alpha-20210407.6)
    • Hl7.Fhir.Support.Poco (>= 3.1.1-alpha-20210407.6)
    • Hl7.FhirPath (>= 3.1.1-alpha-20210407.6)
    • System.Net.Http (>= 4.3.4)
    • System.ValueTuple (>= 4.5.0)
  • .NETStandard 1.6
    • Hl7.Fhir.Serialization (>= 3.1.1-alpha-20210407.6)
    • Hl7.Fhir.Support (>= 3.1.1-alpha-20210407.6)
    • Hl7.Fhir.Support.Poco (>= 3.1.1-alpha-20210407.6)
    • Hl7.FhirPath (>= 3.1.1-alpha-20210407.6)
    • NETStandard.Library (>= 1.6.1)
    • System.ComponentModel (>= 4.3.0)
    • System.ComponentModel.Annotations (>= 4.5.0)
    • System.ComponentModel.Primitives (>= 4.3.0)
    • System.Net.Http (>= 4.3.4)
    • System.Net.Requests (>= 4.3.0)
    • System.Runtime.Serialization.Primitives (>= 4.3.0)
    • System.ValueTuple (>= 4.5.0)
  • .NETStandard 2.0
    • Hl7.Fhir.Serialization (>= 3.1.1-alpha-20210407.6)
    • Hl7.Fhir.Support (>= 3.1.1-alpha-20210407.6)
    • Hl7.Fhir.Support.Poco (>= 3.1.1-alpha-20210407.6)
    • Hl7.FhirPath (>= 3.1.1-alpha-20210407.6)
    • System.ComponentModel (>= 4.3.0)
    • System.ComponentModel.Annotations (>= 4.5.0)
    • System.ComponentModel.Primitives (>= 4.3.0)
    • System.Net.Http (>= 4.3.4)
    • System.Net.Requests (>= 4.3.0)
    • System.Runtime.Serialization.Primitives (>= 4.3.0)
    • System.ValueTuple (>= 4.5.0)
  • .NETFramework 4.5: 4.5.0.0
  • .NETStandard 1.6: 1.6.0.0
  • .NETStandard 2.0: 2.0.0.0

Owners

Marco

Authors

Firely (info@fire.ly) and contributors

Project URL

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

License

BSD-3-Clause

Tags

HL7 FHIR REST parse serialize class model Firely SDK

Info

350 total downloads
0 downloads for version 3.1.1-alpha-20210407.6
Download (4.94 MB)
Download symbols (973.21 KB)
Found on the current feed only

Package history

Version Size Last updated Downloads Mirrored?
3.1.1-alpha-20210407.6 4.94 MB Wed, 07 Apr 2021 13:00:24 GMT 0
3.1.1-alpha-20210401.30 4.94 MB Thu, 01 Apr 2021 16:52:31 GMT 0
3.1.0 4.94 MB Thu, 01 Apr 2021 15:45:51 GMT 0
3.1.0--20210401.27 4.94 MB Thu, 01 Apr 2021 16:25:15 GMT 0
3.0.1-alpha-20210401.11 4.94 MB Thu, 01 Apr 2021 13:21:17 GMT 0
3.0.1-alpha-20210225-27 4.94 MB Thu, 25 Feb 2021 17:32:45 GMT 0
3.0.0 4.93 MB Thu, 25 Feb 2021 16:25:45 GMT 0
2.0.4-alpha-20210225-3 4.94 MB Thu, 25 Feb 2021 10:37:29 GMT 0
2.0.4-alpha-20210225-18 4.94 MB Thu, 25 Feb 2021 14:55:52 GMT 0
2.0.4-alpha-20210225-14 4.94 MB Thu, 25 Feb 2021 13:05:57 GMT 0
2.0.3 5.03 MB Tue, 26 Jan 2021 16:12:51 GMT 2
2.0.2 5.03 MB Fri, 22 Jan 2021 16:33:19 GMT 1
2.0.1 5.99 MB Wed, 25 Nov 2020 10:52:24 GMT 149
2.0.0 5.99 MB Mon, 16 Nov 2020 15:48:26 GMT 2
1.9.0 8.21 MB Thu, 23 Jul 2020 17:36:49 GMT 130
1.8.0 8.21 MB Thu, 02 Jul 2020 17:18:19 GMT 2
1.7.0 8.2 MB Wed, 06 May 2020 17:36:02 GMT 2
1.6.0 8.21 MB Wed, 04 Mar 2020 12:23:54 GMT 62