| DICOM PS3.18 2025e - Web Services |
|---|
This Transaction uses the GET method to retrieve the Target Resource. The Media Type in the response payload will depend on the Target URI and the Query Parameters; for example, Instances as application/dicom, Metadata as application/dicom+json or rendered Instances as application/jpeg images.
The request shall have the following syntax:
GET SP "/" {/resource} {?parameter*} SP version CRLF
Accept: 1#media-type CRLF
*(header-field CRLF)
CRLF
Where parameter is one of the Query Parameters defined for the Target Resource in Section 10.4.1.2.
Instance Resources (defined in Table 10.4.1-1) are used to retrieve Instances.
Retrieving a Series Instances resource retrieves all the individual Instances contained in the Series. Retrieving a Study Instances resource retrieves all the individual Instances contained in all the Series of the Study.
Bulk Data and Frames were previously listed in this table. Bulk Data is addressed in Section 10.4.1.1.5 and Frames data is addressed in Section 10.4.1.1.6.
Metadata Resources (defined in Table 10.4.1-2) are used to retrieve the Metadata of Instances without retrieving Bulk Data.
Retrieving a Series Metadata resource retrieves all the Metadata for all individual Instances contained in the Series. Retrieving a Study Metadata resource retrieves all the Metadata for all individual Instances contained in all the Series.
An implementation interested in just Study level or Series level Metadata, rather than Instance level Metadata for all Instances, would be better served by using the Search Transaction on the All Studies or Study’s Series resources, matching against the Study Instance UID and using &includefield to specify the Metadata of interest (see Section 10.6.1.2).
The Metadata describes the corresponding Resource, not any Representation of it that might be separately retrieved, hence includes only the DICOM Data Set (without Bulk Data), and in particular does not include any Group 0002 File Meta Information Data Elements.
Some Attributes of the DICOM Data Set may depend on the Representation, not the Resource, especially those that describe the Pixel Data, so may differ from those encoded in a particular retrieved Representation. E.g., Photometric Interpretation (0028,0004) may differ depending on the Transfer Syntax.
Information related to Transfer Syntax UID (0002,0010) in the File Meta Information, which might be expected to be of interest for retrieval of the Representation of the Resource in a particular Media Type, may be available using the Available Transfer Syntax UID (0008,3002) in a Search Transaction.
Rendered Resources (defined in Table 10.4.1-3) are used to retrieve representations of a DICOM Resource rendered as appropriate images, videos, text documents, or other representations. Its primary use case is to provide user agents with a simple means to display medical images and related documents, without requiring deep knowledge of DICOM data structures and encodings.
A Rendered Resource exposes one or more rendered representations, i.e., in a Rendered Media Type, of its parent DICOM Resource.
Thumbnail Resources (defined in Table 10.4.1-4) are used to retrieve a rendered representation appropriate to stand for its parent DICOM Resource.
Table 10.4.1-4. Retrieve Transaction Thumbnail Resources
/studies/{study}/thumbnail
|
|
/studies/{study}/series/{series}/thumbnail
|
|
/studies/{study}/series/{series}/instances/{instance}/thumbnail
|
|
/studies/{study}/series/{series}/instances/{instance}/frames/{frames}/thumbnail
|
If the origin server supports any of the Thumbnail resources, it shall support all of them.
Bulk Data Resources (defined in Table 10.4.1.5-1) are used to retrieve data elements (typically containing large data, such as Pixel Data) extracted from DICOM Instances.
Bulk Data resources that contain pixel data can be retrieved equivalently as described in Section 10.4.1.1.6.
Refer to Section 10.4.1.1.6 for URI templates for Bulk Data consisting of Frame Pixel Data.
Pixel Data Resources (defined in Table 10.4.1.6-1) are used to retrieve data elements containing top-level pixel data from DICOM Instances.
Pixel data is a subset of Bulk Data. The Pixel Data resources provide a convenient method to access that specific subset.
Frame Pixel Data is inherently pixel data so a /pixeldata subresource is not needed in the URI Template.
The Frame Pixel Data resource originally appeared in Table 10.4.1-1.
Rendered MPR Volume Resources (defined in Table 10.4.1.7-1) are used to retrieve representations of a DICOM Resource after performing multiplanar reformatting. Reformatting represents a cross-section of a volume of slice data as an Euclidean planein accordance with the principles established for Planar MPR Volumetric Presentation States (see Section FF.2.1.1 in PS3.4). Rendered images are returned as Acceptable Media Types in the response payload.
These resources ensure uniform client requests and reasonably consistent rendering outcomes. Due to inherent differences in algorithm implementations, an identical match of rendering results between different implementations is not assured.
The Target Resource shall be either:
a collection of Image Instances or Frames within Image Instances that meetthat conform to the Volume Input Requirements for Rendered MPR Volume Resources (see Section C.11.23.1 in PS3.3)
a collection of Image Instances or Frames within Image Instances, refined using one of the Query Parameters defined in Section 8.3.5.3, to meet Volume Input Requirements for Rendered MPR Volume Resources (see Section C.11.23.1 in PS3.3).
Table 10.4.1.7-1. Retrieve Transaction Rendered MPR Volume Resources
/studies/{study}/renderedmpr
|
|
/studies/{study}/series/{series}/renderedmpr
|
|
/studies/{study}/series/{series}/instances/{instance}/renderedmpr
|
|
/studies/{study}/series/{series}/instances/{instance}/frames/{frames}/renderedmpr
|
Rendered 3D Volume Resources (defined in Table 10.4.1.8-1) are used to retrieve representations of a DICOM Resource rendered after performing 3D rendering, in accordance with the principles established for Volume Rendering Volumetric Presentation States (see Section FF.2.1.2 in PS3.4), by applying thresholding, ray-casting, volume rendering, or other methods to display a volume of slice data as a three-dimensional projection. Rendered images are returned as Acceptable Media Types in the response payload.
These resources ensure uniform client requests and reasonably consistent rendering outcomes. Due to inherent differences in algorithm implementations, an identical match of rendering results between different implementations is not assured.
The Target Resource shall be either:
a collection of Image Instances or Frames within Image Instances that meetthat conform to the Volume Input Requirements for Rendered 3D Volume Resources (see Section C.11.23.1 in PS3.3)
a collection of Image Instances or Frames within Image Instances, refined using one of the Query Parameters defined in Section 8.3.5.3, to meet Volume Input Requirements for Rendered 3D Volume Resources (see Section C.11.23.1 in PS3.3).
Table 10.4.1.8-1. Retrieve Transaction Rendered 3D Volume Resources
/studies/{study}/series/rendered3d
|
|
/studies/{study}/series/{series}/rendered3d
|
|
/studies/{study}/series/{series}/instances/{instance}/rendered3d
|
|
/studies/{study}/series/{series}/instances/{instance}/frames/{frames}/rendered3d
|
For the resource types listed in the "Resources" column, the origin server shall support the corresponding Query Parameters as required in Table 10.4.1-5.
For each supported resource type listed in the "Resources" column, the user agent shall supply Query Parameters in the corresponding request as specified in Table 10.4.1-5.
The origin server shall support Request Header Fields as required in Table 10.4.1-6.
The user agent shall supply Request Header Fields as required in Table 10.4.1-6.
Table 10.4.1-6. Request Header Fields
|
The Acceptable Media Types of the response payload See Section 10.4.4 for Media Types corresponding to each set of target resources defined in Section 10.4.1.1. |
||||
See also Section 8.4.
| DICOM PS3.18 2025e - Web Services |
|---|