DICOM PS3.18 2016d - Web Services

6.4.2.2 Response
Prev | 6.4.2 WS - RetrieveRenderedImagingDocumentSet | Next

#### 6.4.2.2 Response

An Web Server shall render and then provide the document(s) indicated in the request. The Web Server shall return the rendered documents or an error code when the document could not be returned. The rendered forms shall be the subset specified, and in the format requested. If the Imaging Document Source cannot render the pixel data in that manner then an error status shall be returned.

The <wado:RetrieveRenderedImagingDocumentResponse/> element for use with the Retrieve Imaging Document Set Response Message, Retrieve Rendered Imaging Document Set Response Message and Retrieve Imaging Document Set Metadata Response Message is defined as:

- A required /ihe:RetrieveDocumentSetResponse/rs:RegistryResponse element

- An optional sequence of <wado:RenderedDocumentResponse/> elements containing:

  - A <ihe:HomeCommunityId/> element. The value of this element shall be the same as the value of the StudyRequest/SeriesRequest/DocumentRequest/HomeCommunityId element in the Request Message. If the <ihe:HomeCommunityId/> element is not present in the Request Message, this value shall not be present.

  - A required <ihe:RepositoryUniqueId/> that identifies the Imaging Document Source from which the document was retrieved. The value of this element shall be the same as the value of the StudyRequest/SeriesRequest/DocumentRequest/RepositoryUniqueId element in the original Request Message.

  - A required <wado:SourceDocumentUniqueId/> that identifies the source document. The value of this element shall be the same as the value of the StudyRequest/SeriesRequest/DocumentRequest/DocumentUniqueId element in the original Request Message. This value identifies the source, and is not an ID for the resulting rendered document.

  - A conditional <wado:FrameNumber/> that identifies the frame within the source document. It shall be present if and only if <wado:FrameNumber/> was in the request.

  - A required <wado:Annotation/> element that contains the actual value used.

  - A required <wado:Rows/> element that contains the actual value used.

  - A required <wado:Columns/> element that contains the actual value used.

  - A required <wado:Region/> element that contains the actual value used.

  - A required <wado:WindowCenter/> element that contains the actual value used.

  - A required <wado:WindowWidth/> element that contains the actual value used.

  - A required <wado:ImageQuality/> element that contains the actual value used.

  - A required <wado:PresentationUID/> element that contains the actual value used if a PresentationUID was used.

  - A required <wado:PresentationSeriesUID/> element that contains the actual value used if a PresentationSeriesUID was used.

  - An optional <wado:Anonymize/> element that shall be present if the rendered instance was anonymized.

  - A required <ihe:Document/> element that contains the rendered document encoded as an XOP Infoset.

  - A required <ihe:mimeType/> element that indicates the media type of the retrieved document.

The /RetrieveDocumentSetResponse/rs:RegistryResponse/@status attributes provides the overall status of the request: It shall contain one of the following values:

- urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success

- urn:ihe:iti:2007:ResponseStatusType:PartialSuccess

- urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Failure

For each document requested in a /RetrieveRenderedImagingDocumentSetRequest/StudyRequest/SeriesRequest/DocumentRequest element:

- If the document is successfully rendered (without warning) then no /RetrieveRenderedImagingDocumentSetResponse/rs:RegistryResponse/rs:RegistryErrorList/ rs:RegistryError element shall be present and a /RetrieveRenderedImagingDocumentSetResponse/DocumentResponse/Document element shall be returned containing the rendered document as base64binary encoded data.

- If a warning is reported when retrieving the document, then a /RetrieveRenderedImagingDocumentSetResponse/rs:RegistryResponse/rs:RegistryErrorList/ rs:RegistryError element shall be returned with:

  - @severity is urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning

  - @errorCode is specified

  - @codeContext contains the warning message

  - @location contains the DocumentUniqueId of the document requested

  - The rendered document shall be returned in an instance of /RetrieveRenderedImagingDocumentSetResponse/DocumentResponse/Document as base64binary encoded data. The returned document and warning are correlated via the DocumentUniqueId.

- If an error is reported when retrieving a document, then a /RetrieveRenderedImagingDocumentSetResponse/rs:RegistryResponse/rs:RegistryErrorList/ rs:RegistryError element shall be returned with:

  - @severity is urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Error

  - @errorCode is specified

  - @codeContext contains the error message

  - @location contains the DocumentUniqueId of the document requested

  - No corresponding RetrieveRenderedImagingDocumentSetResponse/DocumentResponse element shall be returned

The error conditions for failures and associated error codes are given below in section 6.4.4. These errors shall be detected and the associated errorCode returned if that error occurs. Additional errors defined in the ebRS standard, in ITI TF-2: 4.1.13 "Error Reporting", and defined by the implementer may be returned.

Prev | Up | Next
6.4.2 WS - RetrieveRenderedImagingDocumentSet | Home | 6.4.3 WS - RetrieveImagingDocumentSetMetadataRequest

DICOM PS3.18 2016d - Web Services