Skip to content
The official .NET API for HL7 FHIR
C# Other
  1. C# 99.9%
  2. Other 0.1%
Branch: develop-stu3
Clone or download

README.md

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

You can’t perform that action at this time.