Aspose.Medical.Dicom.Web.AspNetCore 26.10.0

Aspose.Medical DICOMweb for ASP.NET Core

Aspose.Medical.Dicom.Web.AspNetCore connects Aspose.Medical DICOMweb applications to ASP.NET Core dependency injection and endpoint routing. It translates HTTP requests and responses and supports DICOMweb WebSocket notifications.

The package targets .NET 10 and uses the ASP.NET Core shared framework. It contains the hosting adapter and its XML API documentation. Aspose.Medical is installed as a separate NuGet dependency with the exact version supported by this adapter release.

Install

dotnet add package Aspose.Medical.Dicom.Web.AspNetCore

Example

This Program.cs in an ASP.NET Core project (dotnet new web) is a complete Modality Worklist server (MWL-RS). AddDicomWeb registers the DICOMweb application, AddStandardModalityWorklistService adds the standard worklist service backed by your provider, and MapDicomWeb exposes it under /dicomweb:

using System.Runtime.CompilerServices;
using Aspose.Medical.Dicom;
using Aspose.Medical.Dicom.Web;
using Aspose.Medical.Dicom.Web.Providers;

WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
builder.Services.AddScoped<IDicomWebModalityWorklistProvider, Worklist>();
builder.Services.AddDicomWeb().AddStandardModalityWorklistService();

WebApplication app = builder.Build();
app.MapDicomWeb("/dicomweb");
app.Run();

sealed class Worklist : IDicomWebModalityWorklistProvider
{
    // Return candidate scheduled procedure steps from your RIS in stable order.
    // Aspose.Medical applies the DICOM matching and writes the response.
    public async IAsyncEnumerable<Dataset> FindCandidatesAsync(DicomWebSearchContext search,
        [EnumeratorCancellation] CancellationToken cancellationToken = default)
    {
        await Task.CompletedTask;
        yield break;
    }
}

GET /dicomweb/modality-scheduled-procedure-steps?Modality=CT now returns the matching worklist items as DICOM JSON. The other standard services are added the same way, each backed by its provider interface: AddStandardStudiesService (QIDO-RS, WADO-RS, STOW-RS), AddStandardWorklistService (UPS-RS), AddStandardStorageCommitmentService, AddStandardModalityPerformedProcedureStepService, and AddStandardNonPatientInstanceService. Custom handlers are registered with AddHandler.

The host configures authentication, authorization, CORS, forwarded headers, and request limits. Enable ASP.NET Core WebSocket middleware when using notification services.

Documentation | API reference | Support