Vuresoft.Dicom.Wado 0.2.8

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