DICOM PS3.18 2016e - Web Services

PS3.18

DICOM PS3.18 2016e - Web Services

DICOM Standards Committee


Table of Contents

Notice and Disclaimer
Foreword
1. Scope
2. Conformance
3. Normative References
Bibliography
4. Terms and Definitions
Glossary
5. Symbols and Abbreviated Terms
6. Data Communication Requirements
6.1. Interaction
6.1.1. Media Types
6.1.1.1. Multipart Media Types
6.1.1.2. DICOM Resource Categories
6.1.1.3. Rendered Media Types
6.1.1.4. Acceptable Media Types
6.1.1.5. Accept Query Parameter
6.1.1.6. Accept Header field
6.1.1.7. Selected Media Type
6.1.1.8. DICOM Media Types and Media Types For Bulk Data
6.1.1.8.1. DICOM Media Type Syntax
6.1.1.8.1.1. DICOM Multipart Media Types
6.1.1.8.1.2. Transfer Syntax Parameter
6.1.1.8.1.3. Character Set Parameter
6.1.1.8.2. Transfer Syntax Query Parameter
6.1.1.8.3. Acceptable Transfer Syntaxes
6.1.1.8.4. Selected Transfer Syntax
6.1.1.8.5. Support For DICOM Media Types by Service
6.1.2. Character Sets
6.1.2.1. Acceptable Character Sets
6.1.2.2. Character Set Query Parameter
6.1.2.3. Accept-Charset Header Field
6.1.2.4. Selected Character Set
6.1.3. Content-type Header Field
6.2. WADO-URI Request
6.2.1. Parameters of the HTTP Request
6.2.2. Media Types Acceptable in the Response
6.2.2.1. Query Parameters
6.2.2.1.1. Accept Query Parameter
6.2.2.1.2. Character Set Query Parameter
6.2.2.2. Header Fields
6.2.2.2.1. Accept
6.2.2.2.2. Accept-Charset
6.2.3. List of Character Sets Supported in the Response
6.3. WADO-URI Response
6.3.1. Body of Single DICOM MIME Subtype Part Response
6.3.1.1. Media Type
6.3.1.2. Payload
6.3.1.3. Transfer Syntax
6.3.2. Body of Non-DICOM Media Type Response
6.3.2.1. Media 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.4.5. DICOM Media Type
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.5.8. WADO-RS - Retrieve Rendered Transaction
6.5.8.1. Request
6.5.8.1.1. Target Resources
6.5.8.1.2. Query Parameters
6.5.8.1.2.1. Image Annotation
6.5.8.1.2.2. Image Quality
6.5.8.1.2.3. Scaling Regions of Source Images to a Viewport
6.5.8.1.2.4. Windowing
6.5.8.1.3. Header Fields
6.5.8.1.4. Payload
6.5.8.2. Behavior
6.5.8.2.1. Presentation State Instance
6.5.8.3. Response
6.5.8.3.1. Status Codes
6.5.8.3.2. Header Fields
6.5.8.3.3. Payload
6.5.8.4. Media Types
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.1.1. {attributeID} encoding rules
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.2.2.4. Update Methods
6.8.1.2.2.5. Subscribe Methods
6.8.1.3. Status Codes
6.9. UPS-RS Worklist Service
6.9.1. CreateUPS
6.9.1.1. Request
6.9.1.1.1. Request Message
6.9.1.2. Behavior
6.9.1.3. Response
6.9.1.3.1. Response Status Line
6.9.1.3.2. Response Headers
6.9.1.3.3. Response Message Body
6.9.2. UpdateUPS
6.9.2.1. Request
6.9.2.1.1. Request Message
6.9.2.2. Behavior
6.9.2.3. Response
6.9.2.3.1. Response Status Line
6.9.2.3.2. Response Headers
6.9.2.3.3. Response Message Body
6.9.3. SearchForUPS
6.9.3.1. Request
6.9.3.2. Behavior
6.9.3.2.1. Matching
6.9.3.3. Response
6.9.3.3.1. Response Status Line
6.9.3.3.2. Query Result Attribute
6.9.3.3.3. Response Message
6.9.3.3.3.1. XML Response Message
6.9.3.3.3.2. JSON Response Message
6.9.4. RetrieveUPS
6.9.4.1. Request
6.9.4.2. Behavior
6.9.4.3. Response
6.9.4.3.1. Response Status Line
6.9.4.3.2. Response Message
6.9.4.3.2.1. XML Response Message
6.9.4.3.2.2. JSON Response Message
6.9.5. ChangeUPSState
6.9.5.1. Request
6.9.5.1.1. Request Message
6.9.5.2. Behavior
6.9.5.3. Response
6.9.5.3.1. Response Status Line
6.9.5.3.2. Response Headers
6.9.5.3.3. Response Message Body
6.9.6. RequestUPSCancellation
6.9.6.1. Request
6.9.6.1.1. Request Message
6.9.6.2. Behavior
6.9.6.3. Response
6.9.6.2.1. Response Status Line
6.9.2.5.2. Response Headers
6.9.5.2.3. Response Message Body
6.9.7. CreateSubscription
6.9.7.1. Request
6.9.7.2. Behavior
6.9.7.3. Response
6.9.7.3.1. Response Status Line
6.9.7.3.2. Response Headers
6.9.7.3.3. Response Message Body
6.9.8. SuspendGlobalSubscription
6.9.8.1. Request
6.9.8.2. Behavior
6.9.8.3. Response
6.9.8.3.1. Response Status Line
6.9.8.2.2. Response Message Body
6.9.9. DeleteSubscription
6.9.9.1. Request
6.9.9.2. Behavior
6.9.9.3. Response
6.9.9.3.1. Response Status Line
6.9.9.3.2. Response Message Body
6.9.10. OpenEventChannel
6.9.10.1. Request
6.9.10.2. Behavior
6.9.10.3. Response
6.9.10.3.1. Response Status Line
6.9.10.3.2. Response Message Body
6.9.11. SendEventReport
6.9.11.1. Request
6.9.11.1.1. Request Message Body
6.9.11.2. Behavior
6.9.11.3. Response
7. Object Types
8. Parameters of the Request
8.1. Parameters Available for all DICOM 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. Acceptable Media 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 Images
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 Media Type
C. Applications (Informative)
D. IANA Character Set Mapping
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.1.1-1. Resource Categories
6.1.1-2. Definition of Media Type Requirement Terms
6.1.1-3. Rendered Media Types by Resource Category
6.1.1-4. <accept> Query Parameter Name by Service
6.1.1.8-1a. Media Types for DICOM PS3.10 Files
6.1.1.8-1b. Media Types for DICOM Metadata
6.1.1.8-1c. Media Types for DICOM Uncompressed Bulk Data
6.1.1.8-1d. Media Types for DICOM Compressed Bulk Data
6.1.1.8-2. Transfer Syntax UIDs for 'application/dicom' Media Type Instances in the Image or Video Resource Categories
6.1.1.8-3a. Media Types and Transfer Syntax UIDs for Uncompressed Pixel Data in Bulk Data Values
6.1.1.8-3b. Media Types and Transfer Syntax UIDsfor Compressed Pixel Data in Bulk Data Values
6.1.2-1. Character Set Query Parameter Name by Service
6.4-1. Error Codes
6.5-2. Error Codes
6.5.8-1. Resources, Templates and Description
6.5.8-2. Retrieve Rendered Query Parameters
6.5.8-3. Common Status Codes
6.6-1. Media Type Transformation to Transfer Syntaxes
6.6.1-1. HTTP Standard Response Code
6.6.1-2. Store Instances Response Module Attributes
6.6.1-3. Store Instances Response Warning Reason Values
6.6.1-4. Store Instances Response Failure Reason Values
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 Status Codes
6.8-1. Resources and Methods
6.8-2. Server Options HTTP Status Codes
6.9-1. UPS Interface Mapping
6.9.1-1. Status Codes
6.9.2-1. Status Codes
6.9.3-1. Status Codes
6.9.4-1. Status Codes
6.9.5-1. Status Codes
6.9.6-1. Status Codes
6.9.7-2. Status Codes
6.9.8-1. Status Codes
6.9.7-1. Status Codes
6.9.10-1. Status Codes
D-1. IANA Character Set Mapping
F.2.3-1. DICOM VR to JSON Data Type Mapping
F.3.1-1. XML to JSON Mapping
DICOM PS3.18 2016e - Web Services