DICOM PS3.2 2023a - Conformance
N.5.3.2.2 Retrieve supported transaction (WADO-RS)

The Studies Web Service Retrieve Transaction is also known as WADO-RS.

N.5.3.2.2.1 User Agent

The Retrieve Transaction user agent can request resources listed in Table N.5-72:

[List the supported resources for your Retrieve Transaction user agent. Remove the non-supported resources rows. Fill in specific details on your implementation in the in the "Comments" column, when necessary.]

Table N.5-72. Resources Retrieve Transaction - User Agent

Resource

Comments

DICOM Instance Resources - See Resources path in Table 10.4.1-1 in PS3.18

Study Instances

Series Instances

Individual Instance

DICOM Metadata Resources - See Resources path in Table 10.4.1-2 in PS3.18

Study Metadata

Series Metadata

Instance Metadata

DICOM Bulkdata Resources - See Resources path in Table 10.4.1.5-1 in PS3.18

Study Bulkdata

Series Bulkdata

Instance Bulkdata

Bulkdata

DICOM Pixel Data Resources - See Resources path in Table 10.4.1.6-1 in PS3.18

Study Pixel Data

Series Pixel Data

Instance Pixel Data

Frame Pixel data

Rendered Resources - See Resources path in Table 10.4.1-3 in PS3.18

rendered study

rendered series

rendered instance

rendered frame

rendered bulk

Thumbnail Resources - See Resources path in Table 10.4.1-4 in PS3.18

Study Thumbnail

Series Thumbnail

Instance Thumbnail

Frame Thumbnail


[If rendering of thumbnails is supported, provide a high-level description of the method used for rendering thumbnails for the study, series, or instance.

For example, the description could indicate whether a representative instance is chosen from a series, and how that instance is selected, or that per-modality fixed content is used.]

The Retrieve Transaction user agent supports the Query Parameters listed in Table N.5-73.

[Include a row in the table for each parameter your user agent is able to send, including parameters always sent and parameters optionally sent. Remove the rows for parameters your user agent is not able to send. See Section 8.3.5 in PS3.18 for the list of Rendering Query Parameters.

For each row, indicate in the Supported Values column specific Values your user agent may send and/or a description of how the Value is populated. The "Comments" column may be used to explain details of your implementation that may be useful to integrators, such as:

  • Whether and how Values are configurable

  • Situations when the parameter may or may not be sent, or when specific Values may be used

  • How the Accept Query Parameter is intended to relate to the Accept Header Field

  • Other idiosyncrasies of the implementation

]

Table N.5-73. Query Parameters for Retrieve Transaction - User Agent

Query Parameter

Supported Values

Comments

Accept

[See examples in header parameters.]

Rendered Resource

annotation

<<patient

technique>>

charset

<<UTF-8

ISO -8859-1

…>>

quality

viewport

window

iccprofile

<<no

yes

srgb

adobergb

rommrgb>>

Thumbnail Resource

charset

<<UTF-8

ISO-8859-1

…>>

viewport


The Retrieve Transaction user agent supports Header Fields listed in Table N.5-74.

[List the supported Header Fields and their supported Values. Fill in information on your implementation in the "Comments" column when necessary. See Section 10.4.4 in PS3.18 for the list of resources and their corresponding Media Types.]

Table N.5-74. Header Fields for Retrieve Transaction - User Agent

Header Field

Supported Values

Comments

Instance resource

Accept

multipart/related; type="application/dicom"; transfer-syntax={uid}

See in the Overview section Table N.1-1 the supported DICOM SOP Classes / Transfer Syntaxes. Look for "Y" in the "UA" column.

multipart/related; type="application/octet-stream"

Metadata resource

Accept

<<multipart/related; type="application/dicom+xml"

multipart/related; type="application/dicom+json">>

Bulkdata and Pixel Data resource

Accept

Uncompressed:

<<multipart/related; type="application/octet-stream">>

Compressed:

<<multipart/related; type="{media-type}">>

supported {media-type} being

<<image/jpeg

image/x-dicom-rle

image/x-jls

image/jp2

image/jpx

video/mpeg2

video/mp4>>

See details in Section N.5.3.2.1.2.

Rendered Resource

Accept

<<image/jpeg

image/gif

image/png

image/jp2

image/gif

video/mpeg

video/mp4

video/H265

text/html

text/plain

text/xml>>

See details in Section N.5.3.2.1.3.

Thumbnail Resource

Accept

<<image/jpeg

image/gif

image/png

image/jp2

image/gif

video/mpeg

video/mp4

video/H265

text/html

text/plain

text/xml>>

See details in Section N.5.3.2.1.3.

All Resources

Accept-charset

<<UTF-8

ISO-8859-1

…>>


N.5.3.2.2.2 Origin Server

The Retrieve Transaction origin server receives GET requests to retrieve specific studies, series or instances.

The user agent specifies the Target Resource as part of the URI and the acceptable response Content-Type in the HTTP Header (i.e., dicom, dicom+xml, dicom+json, octet-stream, compressed pixel data).

The URI is composed by a Base URI: See Section7.8N.6.3.2.1for the Base URI of the origin server

The Retrieve Transaction origin server supports resources listed in Table N.5-75.

[List the supported resources for your Retrieve Transaction origin server. Remove the non-supported resources rows.Fill in information on your implementation in the Comments column when necessary.]

Table N.5-75. Resources Retrieve Transaction - Origin Server

Resource

Comments

DICOM Instance Resources - See Resources path in Table 10.4.1-1 in PS3.18

Study Instances

Series Instances

Individual Instance

DICOM Metadata Resources - See Resources path in Table 10.4.1-2 in PS3.18

Study Metadata

Series Metadata

Instance Metadata

DICOM Bulkdata Resources - See Resources path in Table 10.4.1.5-1 in PS3.18

Study Bulkdata

Series Bulkdata

Instance Bulkdata

Bulkdata

DICOM Pixel Data Resources - See Resources path in Table 10.4.1.6-1 in PS3.18

Study Pixel Data

Series Pixel Data

Instance Pixel Data

Frame Pixel data

Rendered Resources - See Resources path in Table 10.4.1-3 in PS3.18

rendered study

rendered series

rendered instance

rendered frame

rendered bulk

Thumbnail Resources - See Resources path in Table 10.4.1-4 in PS3.18

Study Thumbnail

Series Thumbnail

Instance Thumbnail

Frame Thumbnail


Table N.5-76 lists Query parameters supported for the Retrieve Transaction as an origin server.

[List the supported parameters and their supported Values. Fill in information on your implementation in the "Comments" column when necessary. See Section 8.3.5 in PS3.18 for the list of Rendering Query Parameters.]

Table N.5-76. Query Parameters for Retrieve Transaction - Origin Server

Query Parameter

Supported Values

Comments

Accept

[Supported Values are the same as for the Accept Header Field.]

Rendered resource

annotation

<<patient

technique>>

[Add additionally supported key word Values here.]

charset

<<UTF-8

ISO-8859-1

…>>

Quality

Viewport

Window

iccprofile

<<no

yes

srgb

adobergb

rommrgb>>

Thumbnail resource

charset

<<UTF-8

ISO-8859-1

…>>

Viewport


The Retrieve Transaction origin server supports Header Fields listed in Table N.5-77.

[List the supported Header Field and their supported Values. Fill in information on your implementation in the "Comments" column when necessary. See Section 10.4.4 in PS3.18 for the list of resources and their corresponding Media Types.]

Table N.5-77. Header Fields for Retrieve Transaction - Origin Server

Header Field

Supported Values

Comments

Instance resource

Accept

multipart/related; type="application/dicom"; transfer-syntax={uid}

See in the Overview section Table N.1-1 the supported DICOM SOP Classes / Transfer Syntaxes. Look for "Y" in the "OS" column.

multipart/related; type="application/octet-stream"

Metadata resource

Accept

<<multipart/related; type="application/dicom+xml"

multipart/related; type="application/dicom+json">>

Bulkdata and Pixel Data resource

Accept

Uncompressed:

<<multipart/related; type="application/octet-stream">>

Compressed:

<<multipart/related; type="{media-type}">>

supported {media-type} being

<<Image/jpeg

image/x-dicom-rle

image/x-jls

image/jp2

image/jpx

video/mpeg2

video/mp4>>

See details in Section N.5.3.2.1.2.

Rendered Resource

Accept

<<image/jpeg

image/gif

image/png

image/jp2

image/gif

video/mpeg

video/mp4

video/H265

text/html

text/plain

text/xml>>

See details in Section N.5.3.2.1.3.

Thumbnail Resource

Accept

<<image/jpeg

image/gif

image/png

image/jp2

image/gif

video/mpeg

video/mp4

video/H265

text/html

text/plain

text/xml>>

See details in Section N.5.3.2.1.3.

All Resources

Content-Type

Content-Type returned by the origin server in the response. It contains the media type of the Payload. See Accept for supported Values

Accept-charset

<<UTF-8

ISO -8859-1

…>>


DICOM PS3.2 2023a - Conformance