DICOM PS3.18 2019e - Web Services
10.6.3.3 Response Payload (Current)
Prev  10.6.3 Response  Next
PS3.18 > Studies Service and Resources > Search Transaction > Response > Response Payload

10.6.3.3 Response Payload

A success response shall contain a list of matching results in an Acceptable Media Type. See Section 8.7.4.

A failure response payload may contain a Status Report describing any failures, warnings, or other useful information.

10.6.3.3.1 Study Resource

For each matching Study, the origin server response shall contain Attributes in accordance with Table 10.6.3-3. The "Type" column in the table below refers to the Query/Retrieve Attribute Types defined in Section C.2.2.1 “Attribute Types” in PS3.4. The unique key for a Study resource Search response is the Study Instance UID (0020,000D).

Table 10.6.3-3. Study Resource Search Response Payload

Attribute Name

Tag

Type

Condition

Specific Character Set

(0008,0005)

C

Shall be present if known

Study Date

(0008,0020)

R

Study Time

(0008,0030)

R

Accession Number

(0008,0050)

R

Instance Availability

(0008,0056)

C

Shall be present if known

Modalities in Study

(0008,0061)

R

Referring Physician's Name

(0008,0090)

R

Timezone Offset From UTC

(0008,0201)

C

Shall be present if known

Retrieve URL

(0008,1190)

C

Shall be present if the Instance is retrievable by the Retrieve transaction

Patient's Name

(0010,0010)

R

Patient ID

(0010,0020)

R

Patient's Birth Date

(0010,0030)

R

Patient's Sex

(0010,0040)

R

Study Instance UID

(0020,000D)

U

Study ID

(0020,0010)

R

Number of Study Related Series

(0020,1206)

R

Number of Study Related Instances

(0020,1208)

R

Note

While some of the above Attributes are optional in Table C.6-1 “Patient Level Attributes for the Patient Root Query/Retrieve Information Model” in PS3.4, they are consistent with those required in [IHE RAD TF Vol2] Table 4.14-1.

In addition, the response shall contain:

  • All other Study level Attributes passed as match or includefield parameters in the request that are supported by the origin server.

  • If the includefield parameter has been specified in the request, and its value is "all", all available Study Level Attributes.

  • If a Private Data Element has been specified as an include parameter and it is supported by the origin server, the Private Data Element and its corresponding Private Creator Element.

Series or Instance Level Attributes contained in includefield parameters shall not be returned.

Prev  Up  Next
10.6.3.2 Response Header Fields  Home  10.6.3.3.2 Series Resources
DICOM PS3.18 2019e - Web Services