Vuresoft.Dicom.Wado 0.4.0

dotnet add package Vuresoft.Dicom.Wado --version 0.4.0
                    
NuGet\Install-Package Vuresoft.Dicom.Wado -Version 0.4.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="Vuresoft.Dicom.Wado" Version="0.4.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Vuresoft.Dicom.Wado" Version="0.4.0" />
                    
Directory.Packages.props
<PackageReference Include="Vuresoft.Dicom.Wado" />
                    
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 Vuresoft.Dicom.Wado --version 0.4.0
                    
#r "nuget: Vuresoft.Dicom.Wado, 0.4.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 Vuresoft.Dicom.Wado@0.4.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=Vuresoft.Dicom.Wado&version=0.4.0
                    
Install as a Cake Addin
#tool nuget:?package=Vuresoft.Dicom.Wado&version=0.4.0
                    
Install as a Cake Tool

Vuresoft.Dicom.Wado

A standalone DICOMweb/WADO library implementing WADO-RS and WADO-URI endpoints for ASP.NET Core applications.

** BETA VERSION **

Features

  • WADO-RS (Web Access to DICOM Objects - RESTful Services)

    • Study, Series, and Instance retrieval
    • Metadata endpoints
    • QIDO-RS search capabilities
  • WADO-URI (Web Access to DICOM Objects - URI)

    • Legacy URI-based DICOM retrieval

Usage

1. Implement Required Interfaces

The library requires you to implement two interfaces to connect to your storage system:

IStudyResolver

Maps DICOM Study UIDs to your storage identifiers:

public class MyStudyResolver : IStudyResolver
{
    private readonly ApplicationDbContext _dbContext;
    
    public MyStudyResolver(ApplicationDbContext dbContext)
    {
        _dbContext = dbContext;
    }
    
    public async Task<Guid?> GetStudyIdAsync(string studyInstanceUid)
    {
        var study = await _dbContext.Studies
            .FirstOrDefaultAsync(s => s.StudyInstanceUid == studyInstanceUid);
        return study?.Id;
    }
    
    public async Task<IEnumerable<Guid>> GetAllStudyIdsAsync()
    {
        return await _dbContext.Studies
            .Where(s => !string.IsNullOrEmpty(s.StudyInstanceUid))
            .Select(s => s.Id)
            .ToListAsync();
    }
}
IDicomFileProviderFactory

Creates providers for accessing DICOM data:

public class MyDicomFileProviderFactory : IDicomFileProviderFactory
{
    public IDicomFileProvider CreateProvider(Guid studyId)
    {
        // Return your implementation that can access DICOM files
        // This could be file system, database, cloud storage, etc.
        return new MyDicomFileProvider(studyId);
    }
}
IDicomFileProvider

Implement this to provide access to your DICOM storage:

public class MyDicomFileProvider : IDicomFileProvider
{
    private readonly Guid _studyId;
    
    public MyDicomFileProvider(Guid studyId)
    {
        _studyId = studyId;
    }
    
    public async Task<DicomDataset?> GetInstanceAsync(
        StudyInstanceUid studyInstanceUid, 
        SeriesInstanceUid seriesInstanceUid,
        SopInstanceUid sopInstanceUid)
    {
        // Load and return DICOM dataset
    }
    
    public async Task<byte[]?> GetInstanceBytesAsync(
        StudyInstanceUid studyInstanceUid,
        SeriesInstanceUid seriesInstanceUid,
        SopInstanceUid sopInstanceUid)
    {
        // Return raw DICOM file bytes
    }
    
    // ... implement other methods
    
    public void Dispose()
    {
        // Cleanup resources
    }
}

2. Register Services

In your Program.cs or Startup.cs:

// Register your implementations
builder.Services.AddScoped<IStudyResolver, MyStudyResolver>();
builder.Services.AddScoped<IDicomFileProviderFactory, MyDicomFileProviderFactory>();

3. Map Endpoints

In Startup.cs:

// Configure DICOMweb options
var dicomWebOptions = new DicomWebOptions
{
    BaseUrl = $"/dicomweb/rs",
    WadoUriBaseUrl = "/dicomweb/wado",
    BulkDataThreshold = 1024,
    IncludeWadoUri = true
};

// Map DICOMweb endpoints
app.MapDicomWebEndpoints(dicomWebOptions);

app.Run();

Endpoints

The library provides the following endpoints:

WADO-RS

  • Studies

    • GET /dicomweb/rs/studies - Search studies (QIDO-RS)
    • GET /dicomweb/rs/studies/{studyUID} - Retrieve study
    • GET /dicomweb/rs/studies/{studyUID}/metadata - Study metadata
  • Series

    • GET /dicomweb/rs/studies/{studyUID}/series - Search series
    • GET /dicomweb/rs/studies/{studyUID}/series/{seriesUID} - Retrieve series
    • GET /dicomweb/rs/studies/{studyUID}/series/{seriesUID}/metadata - Series metadata
  • Instances

    • GET /dicomweb/rs/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID} - Retrieve instance
    • GET /dicomweb/rs/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}/metadata - Instance metadata
    • GET /dicomweb/rs/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}/frames/{frame} - Frame data

WADO-URI

  • GET /dicomweb/wado?requestType=WADO&studyUID={}&seriesUID={}&objectUID={} - Legacy WADO-URI

Changelog

0.2.19

  • Reduced allocation in Frames Endpoint to use streams direct from Sqlite.
  • Monitor for leaks if connections are dropped on the frames endpoint.
  • Revert to .ToArray() copy on FoDicom if needed.

0.2.18

  • Fixed stream disposal: instance streams now properly disposed with await using in frame and bulk data endpoints
  • Prevents resource leaks when using SqliteBlob streaming from database

0.2.17

  • Fixed bulk data endpoint .ToArray() to use Results.Stream() (eliminates unnecessary byte array copy)
  • Cached boundary strings as static readonly in frame and bulk data endpoints (reduces allocations per request)
  • ~11% memory reduction on large file frame requests

0.2.16

  • Fixed frame endpoint .ToArray() to use Results.Stream()
  • Added streaming for series/study endpoints (constant memory instead of O(n))
  • ~26% memory reduction on frame requests
Product Compatible and additional computed target framework versions.
.NET 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

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
0.4.0 140 9/18/2026
0.3.2 266 12/14/2025
0.3.1 189 12/12/2025
0.3.0 496 12/11/2025
0.2.20 502 12/10/2025
0.2.19 515 12/10/2025
0.2.18 505 12/9/2025
0.2.16 510 12/9/2025
0.2.15 504 12/9/2025
0.2.14 513 12/9/2025
0.2.13 272 11/27/2025
0.2.12 413 9/18/2025
0.2.11 323 9/15/2025
0.2.9 247 9/12/2025
0.2.8 261 9/9/2025
0.2.6 240 9/8/2025
0.1.0 312 8/28/2025