DICOM PS3.18 2019a - Web Services
6.5.6 WADO-RS - RetrieveMetadata (Current)
Prev  6.5 WADO-RS Request/Response  Next
PS3.18 > DICOM Communication Model for Web Services > WADO-RS Request/Response > WADO-RS - RetrieveMetadata

6.5.6 WADO-RS - RetrieveMetadata

This action retrieves the DICOM instances presented as the study, series, or instance metadata with the bulk data removed. The response is metadata for the DICOM attributes.

The study, series, or instance metadata includes all attributes; however, a RESTful Service is permitted to replace the Value Field of an attribute with a BulkDataURI for attributes with Value Representations (VR) of DS, FL, FD, IS, LT, OB, OD, OF, OL, OW, SL, SS, ST, UC, UL, UN, US, and UT. The client can use the BulkDataURI with the RetrieveBulkData action to retrieve the original Value Field of that attribute.

Note

  1. The server is not required to replace any attribute with a BulkDataURI; this is intended to allow the server to provide clients with metadata of a reasonably small size by leaving out large data Value Fields.

  2. OB, OD, OF, OL, OW and UN Attributes not replaced with a BulkDataURL are encoded as XML Base64 binary values.

  3. Some DICOM instances, such as SR documents, may be entirely described in the metadata.

6.5.6.1 Request

The specific Services resources to be used for the RetrieveMetadata action shall be as follows:

  • Resources

    • {SERVICE}/studies/{StudyInstanceUID}/metadata

    • {SERVICE}/studies/{StudyInstanceUID}/series/{SeriesInstanceUID}/metadata

    • {SERVICE}/studies/{StudyInstanceUID}/series/{SeriesInstanceUID}/instances/{SOPInstanceUID}/metadata

    where

    • {SERVICE} is the base URL for the service. This may be a combination of protocol (either http or https), host, port, and application.

    • {StudyInstanceUID} is the study instance UID for a single study.

    • {SeriesInstanceUID} is the series instance UID for a single series.

    • {SOPInstanceUID} is the SOP Instance UID for a single SOP Instance.

  • Method

    • GET

  • Headers

    • Accept

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

        Specifies that the response should be PS3.19 XML. WADO-RS origin servers shall support this Media Type. See Table 6.1.1.8-1b.

      • application/dicom+json

        Specifies that the response should be DICOM JSON (see Annex F). WADO-RS origin servers shall support this Media Type. See Table 6.1.1.8-1b.

Prev  Up  Next
6.5.5.2 Response  Home  6.5.6.2 Response
DICOM PS3.18 2019a - Web Services