DICOM PS3.18 2020c - Web Services

8.3.4 Search Query Parameters (Current)
Prev | 8.3 Query Parameters | Next

### 8.3.4 Search Query Parameters

Table 8.3.4-1 contains the syntax for the names and values of search parameters, along with a reference to the section where their meaning is defined. Search transactions shall support these parameters. The ABNF for the various search parameters is:

Table 8.3.4-1. Query Parameter Syntax

Term | Value | Usage | Description
--- | --- | --- | ---
User Agent | Origin Server
    search
    = match / fuzzymatching / includefield
    / limit / offset
    match
    ; See attribute matching rules below
| O | M | Section 8.3.4.1
    fuzzymatching
    = "fuzzymatching" "=" true / false
| O | M | Section 8.3.4.2
    includefield
    = "includefield" "=" 1#attribute / "all"
| O | M | Section 8.3.4.3
    limit
    = "limit" "=" uint ; Maximum number of results
| O | M | Section 8.3.4.4
    offset
    = "offset" "=" uint ; Number of skipped results
| O | M | Section 8.3.4.4

The following sections describe these parameters in detail.

#### 8.3.4.1 Attribute Matching

The syntax of the match Query Parameter shall be:

    match          = normal-match / uid-list-match
    normal-match   = 1*("&" attribute "=" value)
    uid-list-match = 1*("&" attribute "=" 1#value)
    attribute      = (attribute-id) *("." attribute-id)
    attribute-id   = tag *("." tag) / keyword *("." keyword)
    tag            = 8HEXDIG

    keyword= ;A keyword from Table 6-1 “Registry of DICOM Data Elements” in PS3.6.

One or more DICOM Attribute/Values pairs specify the matching criteria for the search.

Each search transaction defines which Attributes are required or permitted.

### Note

DICOM Attributes should not be confused with XML attributes. The Tags and Keywords for DICOM Attributes are defined in Table 6-1 “Registry of DICOM Data Elements” in PS3.6.

DICOM Attribute/Values pairs shall satisfy the following requirements:

1. Each attribute-id shall be a Data Element Tag or Keyword.

2. Each attribute in the Query Parameter shall be not be repeated.

3. Each attribute in the Query Parameter shall have a single value, unless the associated DICOM Attribute allows UID List matching (see Section C.2.2.2.2 in PS3.4 ), in which case the value is a comma-separated list of UIDs.

4. If a tag represents a Private Data Element the query shall also include a corresponding Private Creator Element (see Section 7.8.1 in PS3.5 ).

5. The acceptable values are determined by the types of matching allowed by C-FIND for its associated attribute. See Section C.2.2.2 in PS3.4 . All characters in values that are not qp-chars shall be percent-encoded. All non-ASCII characters shall be percent encoded. See [RFC3986] for details.

The following US-ASCII characters"#", "[", "]", "&", "=", and "," shall be percent encoded in any Query Parameter.

The match Query Parameter corresponds to DIMSE Matching Keys. See Section K.2.2.1.1 in PS3.4 .

##### 8.3.4.1.1 Matching Rules

The matching semantics for each attribute are determined by the types of matching allowed by C-FIND. See Section C.2.2.2 “Attribute Matching” in PS3.4.

Matching results shall be generated according to the Hierarchical Search Method described in Section C.4.1.3.1.1 “Hierarchical Search Method” in PS3.4.

Combined date-time matching shall be performed as specified in Section C.2.2.2.5 “Range Matching” in PS3.4.

### Note

If an origin server is acting as a proxy for a C-FIND SCP that does not support combined date-time matching, it shall perform a C-FIND request using only the date and filter any results that are outside the time range before returning a response.

If the Timezone Offset From UTC (0008,0201) Attribute is specified in the request, dates and times in the request are to be interpreted in the specified time zone. See Section C.4.1.1 in PS3.4 .

Prev | Up | Next
8.3.3.2 Character Set Query Parameter | Home | 8.3.4.2 Fuzzy Matching of Person Names

DICOM PS3.18 2020c - Web Services