Using DICOMweb™ Standard APIs with C#

This tutorial uses C# to demonstrate working with the DICOM service.

In this tutorial, we'll use the following sample .dcm DICOM files.

  • blue-circle.dcm
  • dicom-metadata.csv
  • green-square.dcm
  • red-triangle.dcm

The file name, studyUID, seriesUID, and instanceUID of the sample DICOM files is as follows:

File StudyUID SeriesUID InstanceUID
green-square.dcm 1.2.826.0.1.3680043.8.498.13230779778012324449356534479549187420 1.2.826.0.1.3680043.8.498.45787841905473114233124723359129632652 1.2.826.0.1.3680043.8.498.12714725698140337137334606354172323212
red-triangle.dcm 1.2.826.0.1.3680043.8.498.13230779778012324449356534479549187420 1.2.826.0.1.3680043.8.498.45787841905473114233124723359129632652 1.2.826.0.1.3680043.8.498.47359123102728459884412887463296905395
blue-circle.dcm 1.2.826.0.1.3680043.8.498.13230779778012324449356534479549187420 1.2.826.0.1.3680043.8.498.77033797676425927098669402985243398207 1.2.826.0.1.3680043.8.498.13273713909719068980354078852867170114

Note

Each of these files represent a single instance and are part of the same study. Also, the green-square and red-triangle are part of the same series, while the blue-circle is in a separate series.

Prerequisites

To use the DICOMweb™ Standard APIs, you must have an instance of the DICOM service deployed. If you haven't already deployed an instance of the DICOM service, see Deploy DICOM service using the Azure portal.

After you've deployed an instance of the DICOM service, retrieve the URL for your App service:

  1. Sign into the Azure portal.
  2. Search Recent resources and select your DICOM service instance.
  3. Copy the Service URL of your DICOM service. Make sure to specify the version as part of the url when making requests. More information can be found in the API Versioning for DICOM service Documentation.

In your application, install the following NuGet packages:

Create a DicomWebClient

After you've deployed your DICOM service, you'll create a DicomWebClient. Run the following code snippet to create DicomWebClient, which we'll be using for the rest of this tutorial. Ensure you have both NuGet packages installed as mentioned previously. If you haven't already obtained a token, see Get access token for the DICOM service using Azure CLI.

string webServerUrl ="{Your DicomWeb Server URL}"
var httpClient = new HttpClient();
httpClient.BaseAddress = new Uri(webServerUrl);
IDicomWebClient client = new DicomWebClient(httpClient);
client.HttpClient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", “{Your token value}”); 

With the DicomWebClient, we can now perform the Store, Retrieve, Search, and Delete operations.

Store DICOM Instances (STOW)

Using the DicomWebClient that we've created, we can now store DICOM files.

Store single instance

Store single instance demonstrates how to upload a single DICOM file.

Details:

  • POST /studies
DicomFile dicomFile = await DicomFile.OpenAsync(@"{Path To blue-circle.dcm}");
DicomWebResponse response = await client.StoreAsync(new[] { dicomFile });

Store instances for a specific study

Store instances for a specific study demonstrate how to upload a DICOM file into a specified study.

Details:

  • POST /studies/{study}
DicomFile dicomFile = await DicomFile.OpenAsync(@"{Path To red-triangle.dcm}");
DicomWebResponse response = await client.StoreAsync(new[] { dicomFile }, "1.2.826.0.1.3680043.8.498.13230779778012324449356534479549187420");

Before moving on to the next part of the tutorial, upload the green-square.dcm file using either of the preceding methods.

Retrieving DICOM instance(s) (WADO)

The following code snippets will demonstrate how to perform each of the retrieve queries using the DicomWebClient created previously.

The following variables will be used throughout the rest of the examples:

string studyInstanceUid = "1.2.826.0.1.3680043.8.498.13230779778012324449356534479549187420"; //StudyInstanceUID for all 3 examples
string seriesInstanceUid = "1.2.826.0.1.3680043.8.498.45787841905473114233124723359129632652"; //SeriesInstanceUID for green-square and red-triangle
string sopInstanceUid = "1.2.826.0.1.3680043.8.498.47359123102728459884412887463296905395"; //SOPInstanceUID for red-triangle

Retrieve all instances within a study

Retrieve all instances within a study retrieves all instances within a single study.

Details:

  • GET /studies/{study}
DicomWebResponse response = await client.RetrieveStudyAsync(studyInstanceUid);

All three of the dcm files that we've uploaded previously are part of the same study, so the response should return all three instances. Validate that the response has a status code of OK and that all three instances are returned.

Use the retrieved instances

The following code snippet shows how to access the instances that are retrieved. It also shows how to access some of the fields of the instances, and how to save it as a dcm file.

DicomWebAsyncEnumerableResponse<DicomFile> response = await client.RetrieveStudyAsync(studyInstanceUid);
await foreach (DicomFile file in response)
{
    string patientName = file.Dataset.GetString(DicomTag.PatientName);
    string studyId = file.Dataset.GetString(DicomTag.StudyID);
    string seriesNumber = file.Dataset.GetString(DicomTag.SeriesNumber);
    string instanceNumber = file.Dataset.GetString(DicomTag.InstanceNumber);

    file.Save($"<path_to_save>\\{patientName}{studyId}{seriesNumber}{instanceNumber}.dcm");
}

Retrieve metadata of all instances in study

This response retrieves the metadata for all instances within a single study.

Details:

  • GET /studies/{study}/metadata
DicomWebResponse response = await client.RetrieveStudyMetadataAsync(studyInstanceUid);

All three of the dcm files that we've uploaded previously are part of the same study, so the response should return the metadata for all three instances. Validate that the response has a status code of OK and that all the metadata is returned.

Retrieve all instances within a series

This response retrieves all instances within a single series.

Details:

  • GET /studies/{study}/series/{series}
DicomWebResponse response = await client.RetrieveSeriesAsync(studyInstanceUid, seriesInstanceUid);

This series has two instances (green-square and red-triangle), so the response should return both instances. Validate that the response has a status code of OK and that both instances are returned.

Retrieve metadata of all instances within a series

This response retrieves the metadata for all instances within a single study.

Details:

  • GET /studies/{study}/series/{series}/metadata
DicomWebResponse response = await client.RetrieveSeriesMetadataAsync(studyInstanceUid, seriesInstanceUid);

This series has two instances (green-square and red-triangle), so the response should return metadata for both instances. Validate that the response has a status code of OK and that both instances of the metadata are returned.

Retrieve a single instance within a series of a study

This request retrieves a single instance.

Details:

  • GET /studies/{study}/series{series}/instances/{instance}
DicomWebResponse response = await client.RetrieveInstanceAsync(studyInstanceUid, seriesInstanceUid, sopInstanceUid);

This response should only return the instance red-triangle. Validate that the response has a status code of OK and that the instance is returned.

Retrieve metadata of a single instance within a series of a study

This request retrieves the metadata for a single instance within a single study and series.

Details:

  • GET /studies/{study}/series/{series}/instances/{instance}/metadata
DicomWebResponse response = await client.RetrieveInstanceMetadataAsync(studyInstanceUid, seriesInstanceUid, sopInstanceUid);

This response should only return the metadata for the instance red-triangle. Validate that the response has a status code of OK and that the metadata is returned.

Retrieve one or more frames from a single instance

This request retrieves one or more frames from a single instance.

Details:

  • GET /studies/{study}/series/{series}/instances/{instance}/frames/{frames}
DicomWebResponse response = await client.RetrieveFramesAsync(studyInstanceUid, seriesInstanceUid, sopInstanceUid, frames: new[] { 1 });

This response should return the only frame from the red-triangle. Validate that the response has a status code of OK and that the frame is returned.

Query DICOM (QIDO)

Note

Refer to the DICOM Conformance Statement for supported DICOM attributes.

Search for studies

This request searches for one or more studies by DICOM attributes.

Details:

  • GET /studies?StudyInstanceUID={study}
string query = $"/studies?StudyInstanceUID={studyInstanceUid}";
DicomWebResponse response = await client.QueryAsync(query);

Validates that the response includes one study, and that the response code is OK.

Search for series

This request searches for one or more series by DICOM attributes.

Details:

  • GET /series?SeriesInstanceUID={series}
string query = $"/series?SeriesInstanceUID={seriesInstanceUid}";
DicomWebResponse response = await client.QueryAsync(query);

Validates that the response includes one series, and that the response code is OK.

Search for series within a study

This request searches for one or more series within a single study by DICOM attributes.

Details:

  • GET /studies/{study}/series?SeriesInstanceUID={series}
string query = $"/studies/{studyInstanceUid}/series?SeriesInstanceUID={seriesInstanceUid}";
DicomWebResponse response = await client.QueryAsync(query);

Validates that the response includes one series, and that the response code is OK.

Search for instances

This request searches for one or more instances by DICOM attributes.

Details:

  • GET /instances?SOPInstanceUID={instance}
string query = $"/instances?SOPInstanceUID={sopInstanceUid}";
DicomWebResponse response = await client.QueryAsync(query);

Validates that the response includes one instance, and that the response code is OK.

Search for instances within a study

This request searches for one or more instances within a single study by DICOM attributes.

Details:

  • GET /studies/{study}/instances?SOPInstanceUID={instance}
string query = $"/studies/{studyInstanceUid}/instances?SOPInstanceUID={sopInstanceUid}";
DicomWebResponse response = await client.QueryAsync(query);

Validates that the response includes one instance, and that the response code is OK.

Search for instances within a study and series

This request searches for one or more instances within a single study and single series by DICOM attributes.

Details:

  • GET /studies/{study}/series/{series}instances?SOPInstanceUID={instance}
string query = $"/studies/{studyInstanceUid}/series/{seriesInstanceUid}/instances?SOPInstanceUID={sopInstanceUid}";
DicomWebResponse response = await client.QueryAsync(query);

Validates that the response includes one instance, and that the response code is OK.

Delete DICOM

Note

Delete is not part of the DICOM standard, but has been added for convenience.

Delete a specific instance within a study and series

This request deletes a single instance within a single study and single series.

Details:

  • DELETE /studies/{study}/series/{series}/instances/{instance}
string sopInstanceUidRed = "1.2.826.0.1.3680043.8.498.47359123102728459884412887463296905395";
DicomWebResponse response = await client.DeleteInstanceAsync(studyInstanceUid, seriesInstanceUid, sopInstanceUidRed);

This repose deletes the red-triangle instance from the server. If it's successful, the response status code contains no content.

Delete a specific series within a study

This request deletes a single series (and all child instances) within a single study.

Details:

  • DELETE /studies/{study}/series/{series}
DicomWebResponse response = await client.DeleteSeriesAsync(studyInstanceUid, seriesInstanceUid);

This response deletes the green-square instance (it's the only element left in the series) from the server. If it's successful, the response status code will contain no content.

Delete a specific study

This request deletes a single study (and all child series and instances).

Details:

  • DELETE /studies/{study}
DicomWebResponse response = await client.DeleteStudyAsync(studyInstanceUid);

This response deletes the blue-circle instance (it's the only element left in the series) from the server. If it's successful, the response status code contains no content.

Next Steps

For information about the DICOM service, see