DICOM PS3.18 2020e - Web Services

8.2 Target Resources (Current)
Prev | 8 Common Aspects of DICOM Web Services | Next

## 8.2 Target Resources

Transaction specifications define what resource types are valid Target Resources for the transaction and define the format of the URI for the Target Resource (and Query Parameters) using URI Templates. The URI of a Target Resource is referred to as the Target URI. Transaction specifications also define what resource types are valid resources for the response.

A Target URI is composed of three components: The Base URI, the Target Resource Path, and Query Parameters (which are often optional).

No whitespace is permitted in URIs. Whitespace around line breaks and the line breaks themselves should be stripped before parsing the URI. See [RFC3986] Appendix C.

The most general template for a Target URI is:

    target-uri = "/" {/resource} {?optional*}

or if any of the Query Parameters are required

    target-uri = "/" {/resource} ?{required*}{&optional*}

Where

    "/"
| The slash character ('/') is used to designate the Base URI.
    {/resource}
| A URI template for the Target Resource Path, a relative path component that references the Target Resource. The '/' in the template indicates that reserved characters, such as '/', can be used in the template expansion. See [RFC6570]. "/{/resource}" indicates the absolute URI to the Target Resource on the origin server.
    {required*}
| A URI Template for one or more required query parameters. See Section 8.1.1 for an example.
    {&optional*)
| A URI Template for zero or more optional query parameters. See Section 8.3.1 for an example.

The Base URI of a Service is an absolute URI that specifies the location of the origin server implementing the Service. Each Target URI defined by this Part of the Standard starts with a "/", which is a shorthand that designates the Base URI of the Service. The Base URI may support more than one Service.

The Service Root Path is the Base URI without the Scheme and Authority components.

The Target Resource Path is a relative URI that specifies the path to the resource from the Base URI of the Service. It is specified by a URI Template that uses Path Expansion {/var} as defined in [RFC6570].

For example, given the URI:

    http://dicom.nema.org/service/studies/2.25.123456789/series/2.25.987654321

The Base URI is:

    http://dicom.nema.org/service

The Service Root Path is:

    /service

The Target Resource Path is:

    /studies/2.25.123456789/series/2.25.987654321

The URI Template for this resource is:

    /studies/{study}/series/{series}

Where

    {study}
| is the Study Instance UID of a Study
    {series}
| is the Series Instance UID of a Series

Prev | Up | Next
8 Common Aspects of DICOM Web Services | Home | 8.3 Query Parameters

DICOM PS3.18 2020e - Web Services