DICOM PS3.18 2020c - Web Services

10.6 Search Transaction (Current)
Prev | 10 Studies Service and Resources | Next

## 10.6 Search Transaction

This Transaction uses the GET method to Search for Studies, Series, and Instances managed by the origin server.

### 10.6.1 Request

The request shall have the following syntax:

    GET SP "/" {/resource} {?search*} SP version CRLF

    Accept: 1#search-media-type CRLF

    *(header-field CRLF)

    CRLF

Where

    search-media-type =multipart/related; type="application/dicom+xml"/ dicom-json

#### 10.6.1.1 Target Resources

The Target Resource Path component of the Target URI specifies the collection of resources that is the target of the search.

An origin server that is a native implementation shall support all Mandatory (M) resources specified in the Native column in Table 10.6.1-1.

An origin server that is a DIMSE Proxy implementation shall support all Mandatory (M) resources specified in the Proxy column in Table 10.6.1-1.

Table 10.6.1-1. Search Transaction Resources

Resource | URI Template | Native | Proxy | Query Type
--- | --- | --- | --- | ---
All Studies |
    /studies{?search*}
| M | M | hierarchical
Study's Series |
    /studies/{study}/series{?search*}
| M | M | hierarchical
Study's Instances |
    /studies/{study}/instances{?search*}
| M | O | relational
All Series |
    /series{?parameter*}
| M | O | relational
Study's Series' Instances |
    /studies/{study}/series/{series}/instances{?search*}
| M | M | hierarchical
All Instances |
    /instances{?search*}
| M | O | relational

For more information about Hierarchical Queries see Section C.4.1.3.1.1 “Hierarchical Search Method” in PS3.4. For more information about Relational Queries see Section C.4.1.2.2.1 “Relational-Queries” in PS3.4 and Section C.4.1.3.2.1 “Relational-Queries” in PS3.4 .

Table 10.6.1-2 shows the resources supported by the Search transaction along with a description of the search performed and the results returned.

Table 10.6.1-2. Search Resource Descriptions

Resource | Description
--- | ---
All Studies | Searches the entire service for Studies that match the search parameters, and returns a list of matching Studies, including the default and requested Attributes that are supported for each Study.
Study's Series | Searches for all Series in the specified Study that match the search parameters, and returns a list of matching Series, including the default and requested Attributes that are supported for each Series.
Study's Instances | Searches for all Instances in the specified Study that match the search parameters, and returns a list of matching Instances, including the default and requested Attributes that are supported for each Instance.
All Series | Searches the entire service for Series that match the search parameters, and returns a list of matching Series, including the default and requested Attributes that are supported for each Series.
Study Series' Instances | Searches for all Instances in the specified Study and Series that match the search parameters, and returns a list of matching Instances, including the default and requested Attributes that are supported for each Series.
All Instances | Searches the entire service for Instances that match the search parameters, and returns a list of matching Instances, including the default and requested Attributes that are supported for each Series.

#### 10.6.1.2 Query Parameters

The origin server shall support Query Parameters as required in Table 8.3.4-1 for the corresponding Resource Categories.

The origin server shall support Query Parameters as required in Table 8.3.4-1 for the supported Resource Categories.

##### 10.6.1.2.1 Attribute/Value Pair Requirements

DICOM Attribute/Value pairs included as Query Parameters in the request shall satisfy the requirements in Section 8.3.4.1.

The user agent may include the following Attributes in the request:

- Patient IE Attributes (see Section 10.6.1.2.3)

- Study IE Attributes (only allowed if the resource is All Studies, All Series, All Instances)

- Series IE Attributes (only allowed if the resource is Study's Series, All Series, Study's Instances, or All Instances)

- Composite Instance IE Attributes (only allowed if the resource is Study's Instances, Study Series' Instances, or All Instances)

- Additional Query/Retrieve Attributes (see Section C.3.4 in PS3.4 )

- Private Data Element Tags and their corresponding Private Creator Element Tags

- Timezone Offset From UTC (0008,0201)

The following are examples of Search URIs with valid Attribute/value pairs:

    /studies?PatientID=11235813

    /studies?PatientID=11235813&StudyDate=20130509

    /studies?00100010=SMITH*&00101002.00100020=11235813&limit=25

    /studies?00100010=SMITH*&OtherPatientIDsSequence.00100020=11235813

    /studies?PatientID=11235813&includefield=00081048,00081049,00081060

    /studies?PatientID=11235813&includefield=00081048&includefield=00081049&includefield=00081060

    /studies?PatientID=11235813&StudyDate=20130509-20130510

    /studies?StudyInstanceUID=1.2.392.200036.9116.2.2.2.2162893313.1029997326.94587,1.2.392.200036.9116.2.2.2.2162893313.1029997326.94583

    /studies?00230010=AcmeCompany&includefield=00231002&includefield=00231003

    /studies?00230010=AcmeCompany&00231001=001239&includefield=00231002&includefield=00231003

##### 10.6.1.2.2 Search Key Types and Requirements

Table 10.6.1-3 defines the Search Key Types and their requirements.

Table 10.6.1-3. Search Key Types

Type | Requirement
--- | ---
U | Unique and Required Key
R | Required Key
C | Conditional Key
O | Optional Key

##### 10.6.1.2.3 Required Matching Attributes

The origin server shall support the IE Levels specified in Table 10.6.1-4.

Table 10.6.1-4. Required IE Levels by Resource

Resource | IE Level
--- | ---
Study | Series | Instance
All Studies | X |  |
Study's Series |  | X |
Study's Instances |  | X | X
All Series | X | X |
Study Series' Instances |  |  | X
All Instances | X | X | X

The origin server shall support the matching Attributes specified in Table 10.6.1-5 for each supported IE Level.

Table 10.6.1-5. Required Matching Attributes

IE Level | Attribute Name | Tag
--- | --- | ---
Study | Study Date | (0008,0020)
Study Time | (0008,0030)
Accession Number | (0008,0050)
Modalities In Study | (0008,0061)
Referring Physician Name | (0008,0090)
Patient Name | (0010,0010)
Patient ID | (0010,0020)
Study Instance UID | (0020,000D)
Study ID | (0020,0010)
Series | Modality | (0008,0060)
Series Instance UID | (0020,000E)
Series Number | (0020,0011)
Performed Procedure Step Start Date | (0040,0244)
Performed Procedure Step Start Time | (0040,0245)
Request Attributes Sequence | (0040,0275)
>Scheduled Procedure Step ID | (0040,0009)
>Requested Procedure ID | (0040,1001)
Instance | SOP Class UID | (0008,0016)
SOP Instance UID | (0008,0018)
Instance Number | (0020,0013)

### Note

While some of the Data Elements in Table 10.6.1-5 in are optional in Section C.6.2.1 in PS3.4 , the above list is consistent with those required for IHE RAD-14. See [IHE RAD TF Vol2] Table 4.14-1.

#### 10.6.1.3 Request Header Fields

The origin server shall support header fields as required in Table 10.6.1-6 in the request.

The user agent shall supply in the request header fields as required in Table 10.6.1-6.

Table 10.6.1-6. Request Header Fields

Name | Values | Usage | Description
--- | --- | --- | ---
User Agent | Origin Server
Accept | media-type | M | M | The Acceptable Media Types for the response payload
Accept-Charset | charset | O | M | The Acceptable Character Sets of the response payload

See also Section 8.4.

#### 10.6.1.4 Request Payload

The request has no payload.

Prev | Up | Next
10.5.5 Conformance Statement | Home | 10.6.2 Behavior

DICOM PS3.18 2020c - Web Services