DICOM PS3.18 2018b - Web Services

6.10.3.4 Search Transaction
Prev | 6.10.3 Transactions | Next

#### 6.10.3.4 Search Transaction

The Search transaction searches the collection of NPI Instances contained in the target resource. The search criteria are specified in the query parameters. Each match includes the default and requested attributes from the matching Instance. A successful response returns a list describing the matching Instances.

##### 6.10.3.4.1 Request

The Search transaction uses the GET method and has the following syntax:

        GET SP /{npi-name} {?parameter*} SP version CRLF
        Accept: 1#dicom-media-type CRLF
        *(header-field CRLF)
        CRLF

###### 6.10.3.4.1.1 Resources

The target URL shall reference one of the resources shown in Table 6.10.3.4.1.1-1.

An origin server shall specify all supported npi-names in its Conformance Statement and in its response to the Retrieve Capabilities transaction.

Table 6.10.3.4.1.1-1. Resources and URI Templates

Resource | URI Template | Description
--- | --- | ---
All Instances | /{npi-name} | Searches a collection of NPI Instances

###### 6.10.3.4.1.2 Query Parameters

The parameters in the query component of the target URL specify the matching criteria, the attribute values to be returned, and the results to be returned. The URI template for the query parameters is:

        {?parameter*} = "?" {&amp;match*} {&amp;include*} {&amp;offset} {&amp;limit}

See Section 6.7.1.1, “Request” for a description of the syntax of Search Query Parameters.

###### 6.10.3.4.1.2.1 Attributes and Behaviors

For each Resource Category the origin server supports, it shall support the behaviors and matching key attributes specified in the corresponding sections in Table 6.10.3.4.1.2.1-1.

Table 6.10.3.4.1.2.1-1. NPI Resource Search Attributes

Resource Category | Defined Attributes and Matching Key Types
--- | ---
Color Palette | X.6.1.2 in PS3.4
Defined Procedure Protocol | HH.6.1.2 in PS3.4
Hanging Protocol | U.6.1.2 in PS3.4
Implant Template | BB.6.1.2 in PS3.4

###### 6.10.3.4.1.3 Request Header Fields

Table 6.10.3.4.1.3-1. Search Request Header Fields

Header Field | Value | Usage
--- | --- | ---
Accept | dicom-media-type | M

###### 6.10.3.4.1.4 Request Payload

The request has no payload.

Prev | Up | Next
6.10.3.3.3 Response | Home | 6.10.3.4.2 Behavior

DICOM PS3.18 2018b - Web Services