Helsedir.Fkr.Shared.Client
1.4.2
dotnet add package Helsedir.Fkr.Shared.Client --version 1.4.2
NuGet\Install-Package Helsedir.Fkr.Shared.Client -Version 1.4.2
<PackageReference Include="Helsedir.Fkr.Shared.Client" Version="1.4.2" />
<PackageVersion Include="Helsedir.Fkr.Shared.Client" Version="1.4.2" />
<PackageReference Include="Helsedir.Fkr.Shared.Client" />
paket add Helsedir.Fkr.Shared.Client --version 1.4.2
#r "nuget: Helsedir.Fkr.Shared.Client, 1.4.2"
#:package Helsedir.Fkr.Shared.Client@1.4.2
#addin nuget:?package=Helsedir.Fkr.Shared.Client&version=1.4.2
#tool nuget:?package=Helsedir.Fkr.Shared.Client&version=1.4.2
Fkr.Shared.Client
Contents
Introduction
Fkr.Shared.Client is a NuGet package that provides a reference client for connecting to the Common Contact Register (Felles Kontaktregister - FKR). It includes a HelseID client with DPoP support, a FHIR client, and helper classes for configuration.
Supported platforms are .NET 8, .NET 9, and netstandard2.0. For .NET Framework usage, it is recommended to use PolySharp to enable functionality from newer C# language versions. See the included .NET Framework 4.8 client example for reference.
Functionality
The FkrClient currently includes the following methods:
PlainSearchAsync<T>()
Performs a search within a resource type (e.g., Patient).
Search parameters use the same format as Firely .NET’s HL7 client (see below).
Does not support _include or _revinclude.
Returns an IAsyncEnumerable<T> with results. Automatically follows next links in the search results to include all result pages.
SearchAsync<T>()
Performs a search within a resource type (e.g., Patient).
Search parameters use the same format as Firely .NET’s HL7 client (see below).
Supports _include and _revinclude.
Returns an IAsyncEnumerable<Bundle> containing result pages (Bundles). Automatically follows next links in the search results to include all result pages.
CreateRawClient()
Returns a standard HttpClient that can be used to make calls to FKR not covered by FkrClient or FhirClient.
CreateFhirClient()
Returns a Firely.NET FhirClient that can be used to perform standard FHIR operations against FKR.
Documentation on how to use it is available on Firely.NET’s documentation site.
Usage
If Endpoints/FkrApi and OpenIdCredentials/FkrApi exist in the configuration, all you need to do to use the client is to add the following to the DI pipeline:
hostbuilder.ConfigureServices((context, services) =>
{
...
services.AddFkr(context.Configuration);
...
});
Once this is done, an FkrClient will be available in the service collection.
It is also possible to perform more advanced configuration, for example if you want to reuse the same HelseID client or token provider for different integrations, or use custom configuration setups.
In such cases, registration must be done manually instead of via AddFkr().
| 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. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.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 | 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. |
-
.NETStandard 2.0
- Hl7.Fhir.R4 (>= 5.12.2)
- IdentityModel (>= 7.0.0)
- Microsoft.Extensions.DependencyInjection (>= 9.0.9)
- Microsoft.Extensions.Http (>= 9.0.9)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 9.0.9)
- Microsoft.IdentityModel.JsonWebTokens (>= 8.14.0)
- Microsoft.IdentityModel.Tokens (>= 8.14.0)
-
net8.0
- Hl7.Fhir.R4 (>= 5.12.2)
- IdentityModel (>= 7.0.0)
- Microsoft.Extensions.DependencyInjection (>= 9.0.9)
- Microsoft.Extensions.Http (>= 9.0.9)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 9.0.9)
- Microsoft.IdentityModel.JsonWebTokens (>= 8.14.0)
- Microsoft.IdentityModel.Tokens (>= 8.14.0)
-
net9.0
- Hl7.Fhir.R4 (>= 5.12.2)
- IdentityModel (>= 7.0.0)
- Microsoft.Extensions.DependencyInjection (>= 9.0.9)
- Microsoft.Extensions.Http (>= 9.0.9)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 9.0.9)
- Microsoft.IdentityModel.JsonWebTokens (>= 8.14.0)
- Microsoft.IdentityModel.Tokens (>= 8.14.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 1.4.2 | 460 | 11/10/2025 |
1.4.2:
- Added package to NuGet.org