DicomKit.Web 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package DicomKit.Web --version 1.0.0
                    


                    

                
NuGet\Install-Package DicomKit.Web -Version 1.0.0
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="DicomKit.Web" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="DicomKit.Web" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="DicomKit.Web" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add DicomKit.Web --version 1.0.0
                    


                    

                
#r "nuget: DicomKit.Web, 1.0.0"
#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. 
#:package DicomKit.Web@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=DicomKit.Web&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=DicomKit.Web&version=1.0.0
                    


                            Install as a Cake Tool

DicomKit.Web

DICOMweb (PS3.18) for DicomKit on .NET 8, 9 and 10.

  • DICOM JSON Model (DicomJson): every VR, PN component groups, sequences, AT, IS/DS and binary numbers as JSON numbers, InlineBinary, BulkDataURI; streaming array read/write; depth and inline-binary limits.
  • Native DICOM Model XML (DicomXml), with DTDs and external entities refused.
  • Streaming multipart/related reader and writer with part-size, total-size, part-count and header limits.
  • Client (DicomWebClient): QIDO-RS (sequence match keys included), WADO-RS (instances, metadata, frames, bulk data, rendered, thumbnails), STOW-RS (Part 10, or DICOM JSON / XML metadata plus bulk data parts), UPS-RS Worklist (create, retrieve, search, change state, request cancellation) and the capabilities (WADL) resource over HttpClient. Studies stream as IAsyncEnumerable<DicomFile> without buffering the response.
using DicomKit;
using DicomKit.Web;
using DicomKit.Web.Client;

builder.Services.AddDicomWebClient(o => o.BaseAddress = new Uri("https://pacs.example.org/dicom-web/"))
    .AddHttpMessageHandler(() => new BearerTokenHandler(ct => tokens.GetAsync(ct)));

await foreach (var study in client.SearchStudiesAsync(new QidoQuery().Match(DicomTag.PatientID, "12345")))
    Console.WriteLine(study.GetString(DicomTag.StudyInstanceUID));

await foreach (var file in client.RetrieveStudyAsync(studyUid))
    using (file) await file.SaveAsync(Path.Combine(dir, file.Dataset.GetString(DicomTag.SOPInstanceUID) + ".dcm"));

var result = await client.StoreFilesAsync(Directory.EnumerateFiles(dir, "*.dcm"));

Server endpoints for ASP.NET Core are in DicomKit.Web.AspNetCore. Full guide: docs/DicomWeb.md.

Licensing

Uses the DicomKit license key (LICENSE.txt in this package): a free Developer key for development and testing (https://dicomkit.plogic.dev/DeveloperKey), a Pro or Enterprise plan for production (https://dicomkit.plogic.dev/Pricing). DicomKit is a developer library, not a medical device.

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

NuGet packages (1)

Showing the top 1 NuGet packages that depend on DicomKit.Web:

Package Downloads
DicomKit.Web.AspNetCore

DICOMweb (PS3.18) server building blocks for ASP.NET Core on DicomKit: app.MapDicomWeb() maps QIDO-RS (with sequence matching), WADO-RS (instances, metadata, frames, bulk data, rendered images and thumbnails, decompression to uncompressed transfer syntaxes), STOW-RS (Part 10 or JSON / XML metadata plus bulk data), the UPS-RS Worklist service and a WADL capabilities resource as minimal-API endpoints over a pluggable IDicomWebStore, with streaming multipart, content negotiation and request size limits. Includes in-memory and file-system reference stores. Requires a license key: free Developer key for development and testing, Pro / Enterprise plans for production (https://dicomkit.plogic.dev).

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 138 10/27/2026

See https://dicomkit.plogic.dev/Docs/ReleaseNotes