Firely.Fhir.Validation
2.6.1
Prefix Reserved
dotnet add package Firely.Fhir.Validation --version 2.6.1
NuGet\Install-Package Firely.Fhir.Validation -Version 2.6.1
<PackageReference Include="Firely.Fhir.Validation" Version="2.6.1" />
paket add Firely.Fhir.Validation --version 2.6.1
#r "nuget: Firely.Fhir.Validation, 2.6.1"
// Install Firely.Fhir.Validation as a Cake Addin #addin nuget:?package=Firely.Fhir.Validation&version=2.6.1 // Install Firely.Fhir.Validation as a Cake Tool #tool nuget:?package=Firely.Fhir.Validation&version=2.6.1
Introduction
This is Firely's official FHIR validator API for validating HL7 FHIR resources against profiles. These profiles contain the full gamut of FHIR validation rules, and are used to validate the data in the FHIR resources.
Release notes
Read the releases notes on firely-net-sdk/releases.
Documentation
You can find documentation on the validation api at the Firely docs site.
Getting Started
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.
Read the online documentation, and download the correct package for your FHIR release by searching for Firely.Fhir.Validation.<spec version>
. For most developers, just including this NuGet package is enough to get started.
The main class in this package is the Validator
.
An example implementation can be found here.
Using a pre-release NuGet package
Every release of the validator API results in a NuGet package on the normal NuGet feed. However, each commit on our develop branch also results in a pre-release package.
These are public too. So if you want to be brave and use a pre-release packages, you can do so by adding https://nuget.pkg.github.com/FirelyTeam/index.json
to your NuGet sources:
Get a Personal Access token (PAT) from github.com with scope
read:packages
Next open a console on your machine and run
dotnet nuget add source --name github --username <USERNAME> --password <PAT> https://nuget.pkg.github.com/FirelyTeam/index.json
USERNAME
: your username on GitHub
PAT
: your Personal access token with at least the scope read:packages
Support
We actively monitor the issues coming in through the GitHub repository. 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 contributions!
If you want to participate in this project, we're using Git Flow for our branch management. Please submit PRs on GitHub with changes against the develop
branch.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 is compatible. 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 | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.1 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.1
- Hl7.Fhir.Base (>= 5.11.1)
- MessagePack.Annotations (>= 2.5.187)
- Newtonsoft.Json (>= 13.0.3)
- System.ValueTuple (>= 4.5.0)
-
net8.0
- Hl7.Fhir.Base (>= 5.11.1)
- MessagePack.Annotations (>= 2.5.187)
- Newtonsoft.Json (>= 13.0.3)
- System.ValueTuple (>= 4.5.0)
NuGet packages (6)
Showing the top 5 NuGet packages that depend on Firely.Fhir.Validation:
Package | Downloads |
---|---|
Firely.Fhir.Validation.Compilation
Next-gen Firely validation ElementSchema compiler for R4 and later. |
|
Firely.Fhir.Validation.R5
Next-gen Firely validator for R5, which validates FHIR data against profiles. |
|
Firely.Fhir.Validation.R4
Next-gen Firely validator for R4, which validates FHIR data against profiles. |
|
Firely.Fhir.Validation.Compilation.STU3
Next-gen Firely validation ElementSchema STU3 compiler. |
|
Firely.Fhir.Validation.STU3
Next-gen Firely validator for STU3, which validates FHIR data against profiles. |
GitHub repositories
This package is not used by any popular GitHub repositories.