Using DICOMweb™Standard APIs with DICOM services

This tutorial provides an overview of how to use DICOMweb™ Standard APIs with the DICOM service.

The DICOM service supports a subset of DICOMweb™ Standard that includes:

  • Store (STOW-RS)
  • Retrieve (WADO-RS)
  • Search (QIDO-RS)

Additionally, the following non-standard API(s) are supported:

  • Delete
  • Change Feed

To learn more about our support of DICOM Web Standard APIs, see the DICOM Conformance Statement reference document.

Prerequisites

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

Once deployment is complete, you can use the Azure portal to navigate to the newly created DICOM service to see the details including your Service URL. The Service URL to access your DICOM service will be: https://<workspacename-dicomservicename>.dicom.azurehealthcareapis.com. 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.

Overview of various methods to use with DICOM service

Because DICOM service is exposed as a REST API, you can access it using any modern development language. For language-agnostic information on working with the service, see DICOM Conformance Statement.

To see language-specific examples, refer to the examples below. You can view Postman collection examples in several languages including:

  • Go
  • Java
  • JavaScript
  • C#
  • PHP
  • C
  • NodeJS
  • Objective-C
  • OCaml
  • PowerShell
  • Python
  • Ruby
  • Swift.

C#

Refer to the Using DICOMweb™ Standard APIs with C# tutorial to learn how to use C# with DICOM service.

cURL

cURL is a common command-line tool for calling web endpoints that is available for nearly any operating system. Download cURL to get started.

To learn how to use cURL with DICOM service, see Using DICOMWeb™ Standard APIs with cURL tutorial.

Python

Refer to the Using DICOMWeb™ Standard APIs with Python tutorial to learn how to use Python with the DICOM service.

Postman

Postman is an excellent tool for designing, building, and testing REST APIs. Download Postman to get started. You can learn how to effectively use Postman at the Postman learning site.

One important caveat with Postman and DICOMweb™ Standard is that Postman can only support uploading DICOM files using the single part payload defined in the DICOM standard. This reason is because Postman can't support custom separators in a multipart/related POST request. For more information, see Multipart POST not working for me # 576. Thus, all examples in the Postman collection for uploading DICOM documents using a multipart request are prefixed with [won't work - see description]. The examples for uploading using a single part request are included in the collection and are prefixed with "Store-Single-Instance".

To use the Postman collection, you'll need to download the collection locally and import the collection through Postman. To access this collection, see Postman Collection Examples.

Summary

This tutorial provided an overview of the APIs supported by DICOM service. Get started using these APIs with the following tools:

Next Steps

For more information, see