Редагувати

Поділитися через


Access DICOMweb APIs to manage DICOM data

The DICOM® service allows you to store, review, search, and delete DICOM objects by using a subset of DICOMweb APIs. The DICOMweb APIs are web-based services that follow the DICOM standard. Using these APIs, you can access and manage your organization's DICOM data without requiring complex protocols or formats.

The supported services are:

In addition to the subset of DICOMweb APIs, the DICOM service supports these custom APIs that are unique to Microsoft:

Prerequisites

  • Deploy an instance of the DICOM service. For more information, see Deploy the DICOM service using Azure portal.

  • Find your Service URL. Use Azure portal to navigate to the instance of the DICOM service to find the Service URL. The Service URL to access your DICOM service uses this format: https://<workspacename-dicomservicename>.dicom.azurehealthcareapis.com. Make sure to specify the version as part of the URL when making requests. For more information, see API versioning for the DICOM service.

Use REST API methods to interact with the DICOM service

The DICOM service provides a web-based interface that follows REST (representational state transfer) principles. The REST API allows different applications or systems to communicate with each other using standard methods like GET, POST, PUT, and DELETE. To interact with the DICOM service, use any programming language that supports HTTP requests and responses.

Refer to the language-specific examples. You can view Postman collection examples in several languages including the following.

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

C#

Refer to Use DICOMweb Standard APIs with C# to learn how to use C# with DICOM service.

cURL

cURL is a common command-line tool for calling web endpoints and is available for most operating systems. To get started, download cURL.

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

Python

For more information about how to use Python with the DICOM service, see Using DICOMWeb™ Standard APIs with Python.

Postman

Postman is an excellent tool for designing, building, and testing REST APIs. Download Postman to get started. For more information, see Postman learning site.

One important caution with Postman and the DICOMweb standard is that Postman only supports uploading DICOM files by using the single-part payload defined in the DICOM standard. This 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. All examples in the Postman collection for uploading DICOM documents by using a multipart request are prefixed with [won't work - see description]. The examples for uploading by using a single-part request are included in the collection and are prefixed with Store-Single-Instance.

To use the Postman collection, download it locally and then import the collection through Postman. To access the collection, see Postman Collection Examples.

Next steps

Use DICOMweb Standard APIs with C#

Use DICOMweb Standard APIs with cURL

Use DICOMweb Standard APIs with Python

Use DICOMWeb Standard APIs with the Postman Example Collection

DICOM Conformance Statement

Note

DICOM® is the registered trademark of the National Electrical Manufacturers Association for its Standards publications relating to digital communications of medical information.