1 Scope

This standard specifies a web-based service for accessing and presenting DICOM (Digital Imaging and Communications in Medicine) persistent objects (e.g. images, medical imaging reports). This is intended for distribution of results and images to healthcare professionals. It provides a simple mechanism for accessing DICOM persistent object(s) from HTML pages or XML documents , through HTTP/HTTP S s protocol, using DICOM UIDs (Unique Identifiers). Data may be retrieved either in a presentation-ready form as specified by the requester (e.g. JPEG or GIF) or in a native DICOM format. It does not support facilities for web searching of DICOM images. This standard relates only to DICOM persistent objects (not to other DICOM objects or to non-DICOM objects). Access control beyond the security mechanisms generally available to web applications is outside the scope of this standard.

Item #2: Append PS 3.18 Section 3 Normative Reference as indicated.

IHE ITI TF-2x: Appendix V IHE IT Infrastructure Technical Framework, Volume 2x, Appendix V (Web Services for IHE Transactions)

Move to Informative References

ebRS ebXML Registry Service

Item #3: Append PS 3.18 Section 5 Symbols and abbreviated terms as indicated.

IHE Integrating the Healthcare Enterprise

MTOM Message Transmission Optimization Mechanism

SOAP Simple Object Access Protocol (SOAP12 for SOAP version 1.2)

WS Web Services

WSDL Web Services Description Language

XOP XML-binary Optimized Packaging

Item #4: Modify PS 3.18 Section 6 Data Communication Requirements as indicated.

6.1 INTERACTION

[pic]

Figure 6- 0>= 1 "D." 1 — Interaction Diagram

The interaction shall be as shown in Figure 6-1.

Two communications modes are possible:

6.2 HTTP URI REQUEST

Item #5: Modify PS 3.18 Section 6 Data Communication Requirements as indicated.

6.3 HTTP RESPONSE TO THE URI REQUEST

Item #5: Append PS 3.18 Section 6 Data Communication Requirements as indicated.

6.4 WS REQUEST/RESPONSE

The DICOM Web Service defines several action types. An implementation shall support at least one of these actions. The three action types are:

  1. RetrieveImagingDocumentSet

This action retrieves a set of DICOM instances and other objects. This action corresponds to the IHE XDS-I.b transaction RAD-69. The DICOM instances are formatted in accordance with PS 3.10, and encapsulated in a Web Services response.

  1. RetrieveRenderedImagingDocumentSet

This action retrieves a set of DICOM instances that have been rendered into the requested format. For example, if rendering into JPEG was requested, then these will be the JPEG renderings of the requested set of DICOM objects.

  1. RetrieveImagingDocumentSetMetadata

This action retrieves a set of DICOM instances presented as an Infoset with the bulk data removed. This service can retrieve either the full metadata, or a subset selected by XPath arguments. The XML encoding for the DICOM attributes is defined in PS 3.19.

The Web Services actions shall be fully compliant with the Basic Profile of WS-I as defined in IHE IT Infrastructure Technical Framework Vol 2x Annex V. All <wsa:Action> elements shall have the mustUnderstand attribute set (mustUnderstand=”1”).

6.4.1 WS - RetrieveImagingDocumentSet

6.4.1.1 Request

The specific Web Services parameters to be used for the Retrieve Imaging Document Set action shall be as follows, in the order that they would appear in the WSDL definition:

The <iherad:RetrieveImagingDocumentSetRequest/> element for use with the Retrieve Imaging Document Set Request Message is defined as:

6.4.1.2 Response

A Web Server shall provide the document(s) indicated in the request. The Web Server shall return the document(s) or an error code when the document could not be returned. The pixel data shall be encoded using one of the DICOM transfer syntaxes included in the Retrieve Imaging Document Set Request Message. If the Imaging Document Source cannot encode the pixel data using any of the requested transfer syntaxes then an error status shall be returned.

6.4.1.2.1 Form of the Response

The <ihe:RetrieveDocumentResponse/> element for use with the Retrieve Imaging Document Set Response Message is defined as:

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

• An optional sequence of <ihe:DocumentResponse/> elements containing

• An optional <ihe:HomeCommunityId/> element. The value of this element shall be the same as the value of the /RetrieveImagingDocumentSetRequest/StudyRequest/SeriesRequest/DocumentRequest/HomeCommunityId element in the Retrieve Document Set Request Message. If the <ihe:HomeCommunityId/> element is not present in the Retrieve Document Set Request Message, this value shall not be present.

• An optional <ihe:RepositoryUniqueId/> that identifies the Imaging Document Source from which the document is to be retrieved. The value of this element shall be the same as the value of the /RetrieveImagingDocumentSetRequest/StudyRequest/SeriesRequest/DocumentRequest/RepositoryUniqueId element in the original Retrieve Imaging Document Set Request Message. This value corresponds to XDSDocumentEntry.repositoryUniqueId.

• A required <ihe:DocumentUniqueId/> that identifies the document within the Imaging Document Source. The value of this element shall be the same as the value of the /RetrieveImagingDocumentSetRequest/StudyRequest/SeriesRequest/DocumentRequest/DocumentUniqueId element in the original Retrieve Imaging Document Set Request Message. This value corresponds to the SOP Instance UID in the Retrieve Document Request.

• 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 <ihe:Document/> element that contains the retrieved document as an XOP infoset.

• A required <ihe:mimeType/> element that indicates the MIME 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

See ITI TF-2a: 4.1.13 Error Reporting for the interpretation of these values.

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

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

• If a warning is reported when retrieving the document, then a /RetrieveDocumentSetResponse/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 document shall be returned in an instance of /RetrieveDocumentSetResponse/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 /RetrieveDocumentSetResponse/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 RetrieveDocumentSetResponse/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 implementor may be returned.

6.4.1.2.2 JPIP

If the Web Client specifies a transfer syntax field of 1.2.840.10008.1.2.4.94 (DICOM JPIP Referenced Transfer Syntax) or 1.2.840.10008.1.2.4.95 (DICOM JPIP Referenced Deflate Transfer Syntax), and the Web Server supports the requested transfer syntax the following behavior is expected:

6.4.2 WS – RetrieveRenderedImagingDocumentSet

6.4.2.1 Request

The specific Web Services parameters to be used for the Retrieve Rendered Imaging Document Set action shall be as follows, in the order that they would appear in the WSDL definition:

The <wado:RetrieveRenderedImagingDocumentSetRequest/> element for use with the Retrieve Imaging Document Set Request Message is defined as:

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:

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 implementor may be returned.

6.4.3 WS – RetrieveImagingDocumentSetMetadataRequest

6.4.3.1 Request

The specific Web Services parameters to be used for the Retrieve Imaging Document Set Metadata action shall be as follows, in the order that they would appear in the WSDL definition:

The <wado:RetrieveImagingDocumentSetInformationRequest/> element for use with the Retrieve Imaging Document Set Request Message is defined as:

Note: If the requested filter is "/", then all of the metadata is requested.

6.4.3.2 Response

An Web Server shall extract information from each document specified in a Document Set Information Request. This shall be done by the logical equivalent of:

  1. convert the non-pixel data for each of the requested data into an XML encoded form

  2. apply each of the wado:XPath elements to this XML encoded form

  3. provide the XPath response as part of the Document Set Information Response.

See PS 3.19 for details on conversion to XML encoded form.

The Web Server shall return the XPath results or an error code when the document could not be processed.

The <wado:RetrieveImagingDocumentSetInformationResponse/> element for use with the Retrieve Imaging Document Set Response Message is additionally defined as:

The /RetrieveImagingDocumentSetInformationResponse/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 /RetrieveImagingDocumentSetInformationRequest/StudyRequest/SeriesRequest/DocumentRequest element:

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

• If a warning is reported when retrieving the document, then a /RetrieveImagingDocumentSetInformationResponse/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 document shall be returned in an instance of /RetrieveDocumentSetResponse/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 /RetrieveImagingDocumentSetInformationResponse/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 RetrieveDocumentSetResponse/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 implementor may be returned.

6.4.4 Error Codes

The following errorCodes are defined and shall be used to report any of the associated error and warning situations. Other errorCodes may be present for other error and warning situations.

ErrorCode Error Situation
urn:dicom:wado:XXX1 Unable to anonymize the requested instance(s).
urn:dicom:wado:XXX2 Web Server does not support anonymization.
urn:dicom:wado:XXX3 The requested instance(s) are not immediately available, but can be made available by manual request.
urn:dicom:wado:XXX4 Instance is no longer available, e.g., document retention rules have caused it to be removed or relocated.
urn:dicom:wado:XXX5 The requested instance(s) cannot be returned because the size or count exceeds resource limits.
urn:dicom:wado:XXX6 Web Server does not support the requested format or transfer syntax.
urn:dicom:wado:XXX7 The requested instance(s) cannot be provided in the requested format or transfer syntax.
urn:dicom:wado:XXX8 Single image format is not available for multi-frame images.
urn:dicom:wado:XXX9 Identifier does not match SOP Class (See PS3.7 C-MOVE)
urn:dicom:wado:XX10 Inconsistent identifiers, e.g., Study and Series are correct but Series is in a different Study (See PS3.7 C-MOVE)
urn:dicom:wado:XX11 SOP Class not supported. (See PS3.7 C-MOVE)
urn:dicom:wado:XX12 Invalid parameter value in request (See PS3.7 C-MOVE)
urn:dicom:wado:XX13 Unsupported parameter in request (See PS3.7 C-MOVE)
urn:dicom:wado:XX14 Processing Failure (See PS3.7 C-MOVE)
urn:dicom:wado:XX15 Study Instance UID not known
urn:dicom:wado:XX16 Series Instance UID not known
urn:dicom:wado:XX17 Document UID not known
urn:dicom:wado:XX18 Out of range Frame number
urn:dicom:wado:XX19 Presentation UID not known
urn:dicom:wado:XX20 Presentation Series UID not known

Item #6: Modify PS 3.18 Section 7.2 Multi-Frame Image Objects as indicated.

7.2 Multi-Frame AND VIDEO IMAGE OBJECTS

7.2.1 Objects included

In this category are all SOP classes defined in PS 3.3 that are multi-frame or video image objects.

Item #7: Modify PS 3.18 Section 7.3.2 MIME type constraints as indicated.

Item #8: Modify PS 3.18 Section 8 Parameters as indicated.