DICOM PS3.18 2020a - Web Services

H Capabilities Description (Current)
Prev |  | Next

# H Capabilities Description

A Capabilities Description is a WADL Document. See [WADL].

The Capabilities Description resource follows directly and unambiguously from the RESTful resources defined in Chapter 10, Chapter 11 and Chapter 12.

The WADL document shall contain one top-level "application" element.

The "application" element shall contain one "resources" element whose "base" attribute value is the base URL for the service. This may be a combination of protocol (either http or https), host, port, and application.

Additionally, the WADL content shall include a "resource" element for the Target Resource specified in the request describing all methods and child resources for the specified resource and each of its children.

The full resource tree and the methods defined for each resource are described in Table H-1.

### Note

The Retrieve Capabilities Transaction is excluded from Table H-1 because that transaction is used to retrieve this document and WADL is not self-describing.

Table H-1. Resources and Methods

Service | Resource | Transactions | Reference
--- | --- | --- | ---
Studies (see Section 10.1.1)
| studies | Search for Studies Store Instances | Section 10.6 Section 10.5
{StudyInstance} | Retrieve Study Store Study Instances | Section 10.4 Section 10.5
metadata | Retrieve Study Metadata | Section 10.4
series | Search for Study Series | Section 10.6
{SeriesInstance} | Retrieve Series | Section 10.4
metadata | Retrieve Series Metadata | Section 10.4
instances | Search for Study Series Instances | Section 10.4
{SOPInstance} | Retrieve Instance | Section 10.4
metadata | Retrieve Instance Metadata | Section 10.4
frames | N/A | N/A
{framelist} | Retrieve Frames | Section 10.4
instances | Search for Study Instances | Section 10.6
series | Search for Series | Section 10.6
{SeriesInstance} | N/A | N/A
{instances} | Search for Instances | Section 10.6
instances | Search for Instances | Section 10.6
{BulkDataReference} | Retrieve Bulkdata | Section 10.4
Worklist (see Section 11.1.1)
| workitems | Search for Workitem Create Workitem | Section 11.9 Section 11.4
{Workitem} | Retrieve Workitem Update Workitem | Section 11.4 Section 11.6
state | Change Workitem State | Section 11.7
cancelrequest | Request Workitem Cancellation | Section 11.8
subscribers | N/A | N/A
{AETitle} | Subscribe Unsubscribe | Section 11.10 Section 11.11
1.2.840.10008.5.1.4.34.5 | N/A | N/A
subscribers | N/A | N/A
{AETitle} | Subscribe Unsubscribe | Section 11.10 Section 11.11
suspend | Unsubscribe | Section 11.11
1.2.840.10008.5.1.4.34.5.1 | N/A | N/A
subscribers | N/A | N/A
{AETitle} | Subscribe Unsubscribe | Section 11.10 Section 11.11
suspend | Suspend Worklist Subscription | Section 11.11
Non-Patient Instances (see Section 12.1.1)
| color-palettes | N/A | N/A
{uid} | Retrieve Store Search | Section 12.4 Section 12.5 Section 12.6
defined-procedure-protocol | N/A | N/A
{uid} | Retrieve Store Search | Section 12.4 Section 12.5 Section 12.6
hanging-protocol | N/A | N/A
{uid} | Retrieve Store Search | Section 12.4 Section 12.5 Section 12.6
implant-templates | N/A | N/A
{uid} | Retrieve Store Search | Section 12.4 Section 12.5 Section 12.6

Prev |  | Next
G.2.3 Repeatable Elements | Home | I Store Instances Response Module

DICOM PS3.18 2020a - Web Services