DICOM PS3.18 2023b - 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.
Bulkdata and Frames were previously listed in this table. Bulkdata 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 Bulkdata.
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 Dataset (without Bulkdata), and in particular does not include any Group 0002 File Meta Information Data Elements.
Some Attributes of the DICOM Dataset 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.
Bulkdata 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.
Bulkdata 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 Bulkdata 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 bulkdata. 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.
The origin server shall support Query Parameters as required in Table 10.4.1-5.
The user agent shall supply in the request Query Parameters as required 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 2023b - Web Services |
---|