PS3.18

DICOM PS3.18 2014b - Web Services

DICOM Standards Committee


Table of Contents

Notice and Disclaimer
Foreword
1. Scope
2. Conformance
3. Normative References
4. Terms and Definitions
4.1. DICOM Persistent Object
4.2. Origin-Server
4.3. User-Agent
4.4. Web Client System
4.5. Web Enabled DICOM Server
4.6. Web Access to DICOM Persistent Objects
5. Symbols and Abbreviated Terms
6. Data Communication Requirements
6.1. Interaction
6.2. WADO-URI Request
6.2.1. Parameters of the HTTP Request
6.2.2. List of Media Types Supported in the Response
6.2.3. List of Character Sets Supported in the Response
6.3. WADO-URI Response
6.3.1. Body of Single DICOM MIME Sub-type Part Response
6.3.1.1. MIME Type
6.3.1.2. Content
6.3.1.3. Transfer Syntax
6.3.2. Body of Non-DICOM MIME Type Response
6.3.2.1. MIME Type
6.3.2.2. Content
6.4. WADO-WS Request/Response
6.4.1. WS - RetrieveImagingDocumentSet
6.4.1.1. Request
6.4.1.2. Response
6.4.1.2.1. Form of the Response
6.4.1.2.2. JPIP
6.4.2. WS - RetrieveRenderedImagingDocumentSet
6.4.2.1. Request
6.4.2.2. Response
6.4.3. WS - RetrieveImagingDocumentSetMetadataRequest
6.4.3.1. Request
6.4.3.2. Response
6.4.4. Error Codes
6.5. WADO-RS Request/Response
6.5.1. WADO-RS - RetrieveStudy
6.5.1.1. Request
6.5.1.2. Response
6.5.1.2.1. DICOM Response
6.5.1.2.2. Bulk Data Response
6.5.2. WADO-RS - RetrieveSeries
6.5.2.1. Request
6.5.2.2. Response
6.5.2.2.1. DICOM Response
6.5.2.2.2. Bulk Data Response
6.5.3. WADO-RS - RetrieveInstance
6.5.3.1. Request
6.5.3.2. Response
6.5.3.2.1. DICOM Response
6.5.3.2.2. Bulk Data Response
6.5.4. WADO-RS - RetrieveFrames
6.5.4.1. Request
6.5.4.2. Response
6.5.4.2.1. Pixel Data Response
6.5.5. WADO-RS - RetrieveBulkdata
6.5.5.1. Request
6.5.5.2. Response
6.5.5.2.1. Bulk Data Response
6.5.6. WADO-RS - RetrieveMetadata
6.5.6.1. Request
6.5.6.2. Response
6.5.6.2.1. XML Metadata Response
6.5.6.2.2. JSON Metadata Response
6.5.7. Error Codes
6.6. STOW-RS Request/Response
6.6.1. STOW-RS - Store Instances
6.6.1.1. Request
6.6.1.1.1. DICOM Request Message Body
6.6.1.1.2. XML Metadata and Bulk Data Request Message Body
6.6.1.1.3. JSON Metadata and Bulk Data Request Message Body
6.6.1.2. Action
6.6.1.3. Response
6.6.1.3.1. Response Status Line
6.6.1.3.2. Response Message Body
6.6.1.3.2.1. Store Instances Response Attribute Description
6.6.1.3.2.1.1. Warning Reason
6.6.1.3.2.1.2. Failure Reason
6.6.1.3.2.2. Response Message Body Example
6.7. QIDO-RS Request/Response
6.7.1. QIDO-RS - Search
6.7.1.1. Request
6.7.1.2. Response
6.7.1.2.1. Matching
6.7.1.2.1.1. Study Matching
6.7.1.2.1.2. Series Matching
6.7.1.2.1.3. Instance Matching
6.7.1.2.2. Query Result Attributes
6.7.1.2.2.1. Study Result Attributes
6.7.1.2.2.2. Series Result Attributes
6.7.1.2.2.3. Instance Result Attributes
6.7.1.2.3. Query Result Messages
6.7.1.2.3.1. XML Results
6.7.1.2.3.2. JSON Results
6.7.1.3. Status Codes
6.8. RS Capabilities Service
6.8.1. Retrieve Capabilities
6.8.1.1. Request Message
6.8.1.1.1. Method = OPTIONS
6.8.1.1.2. Header Fields
6.8.1.2. Response message
6.8.1.2.1. Resources
6.8.1.2.2. Methods
6.8.1.2.2.1. Retrieve Methods
6.8.1.2.2.2. Store Methods
6.8.1.2.2.3. Search Methods
6.8.1.3. Status Codes
7. Persistent Object Types
7.1. Single Frame Image Objects
7.1.1. Objects Accessed
7.1.2. MIME Type Constraints
7.2. Multi-frame and Video Image Objects
7.2.1. Objects Included
7.2.2. MIME Type Constraints
7.3. Text Objects
7.3.1. Objects Included
7.3.2. MIME Type Constraints
7.4. Other Objects
7.4.1. Objects Included
7.4.2. MIME Type Constraints
8. Parameters of the Request
8.1. Parameters Available for all DICOM Persistent Objects
8.1.1. Request Type
8.1.2. Unique Identifier of the Study
8.1.3. Unique Identifier of the Series
8.1.4. Unique Identifier of the Object
8.1.5. MIME Type of the Response
8.1.6. Charset of the Response
8.1.7. Anonymize Object
8.1.9. Retrieve Partial Information From Objects
8.2. Parameters for DICOM Image Persistent Objects
8.2.1. Annotation On The Object
8.2.2. Number of Pixel Rows
8.2.3. Number of Pixel Columns
8.2.4. Region of the Image
8.2.5. Window Center of the Image
8.2.6. Window Width of the Image
8.2.7. Frame Number
8.2.8. Image Quality
8.2.9. Unique Identifier of the Presentation Object
8.2.10. Unique Identifier of the Series Containing The Presentation Object
8.2.11. Transfer Syntax UID
A. URI Query Component Syntax (Normative)
B. Examples (Informative)
B.1. Retrieving a Simple DICOM Image in JPEG
B.2. Retrieving a DICOM SR in HTML
B.3. Retrieving a Region of A DICOM Image
B.4. Retrieving As A DICOM MIME Type
C. Applications (Informative)
D. IANA Mapping (Informative)
E. WADO WS Schemas and Examples
E.1. WADO WS XSD Schema (Informative)
E.2. WADO WS Request Example (Informative)
E.3. WADO WS Response Example
F. DICOM JSON Model
F.1. Introduction to JavaScript Object Notation (JSON)
F.2. DICOM JSON Model
F.2.1. Multiple Results Structure
F.2.1.1. Examples
F.2.1.1.1. Native DICOM Model
F.2.1.1.2. DICOM JSON Model
F.2.2. DICOM JSON Model Object Structure
F.2.3. DICOM JSON Value Representation
F.2.4. DICOM JSON Value Multiplicity
F.2.5. DICOM JSON Model Null Values
F.2.6. BulkDataURI
F.2.7. InlineBinary
F.3. Transformation with other DICOM Formats
F.3.1. Native DICOM Model XML
F.4. DICOM JSON Model Example
F.5. References
G. WADL JSON Representation
G.1. Introduction
G.2. XML Elements
G.2.1. Doc Elements
G.2.2. Unique Elements
G.2.3. Repeatable Elements

List of Figures

6-1. Interaction Diagram
6.5-1. Mapping between IOD and HTTP message parts

List of Tables

6.4-1. Error Codes
6.5-1. Media Type Mapping to Transfer Syntax
6.5-2. Error Codes
6.6.1-1. HTTP/1.1 Standard Response Code
6.6.1-2. Store Instances Response Module Attributes
6.7.1-1. QIDO-RS STUDY Search Query Keys
6.7.1-1a. QIDO-RS SERIES Search Query Keys
6.7.1-1b. QIDO-RS INSTANCE Search Query Keys
6.7.1-2. QIDO-RS STUDY Returned Attributes
6.7.1-2a. QIDO-RS SERIES Returned Attributes
6.7.1-2b. QIDO-RS INSTANCE Returned Attributes
6.7-1. QIDO-RS HTTP/1.1 Status Codes
6.8-1. Resources and Methods
6.8-2. Server Options HTTP/1.1 Status Codes
D-1. IANA Mapping
F.2.3-1. DICOM VR to JSON Data Type Mapping
F.3.1-1. XML to JSON Mapping