0% found this document useful (0 votes)
598 views

Dcm4chee Arc Cs

The document is a conformance statement for dcm4che Archive 5, a DICOM archive product. It describes the product as a networked computer system for archiving DICOM objects that allows external systems to send, retrieve, and query objects stored in the archive. The statement lists the DICOM network services and Storage SOP Classes supported by the archive product as a DICOM service provider.

Uploaded by

OrlandoUtrera
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
598 views

Dcm4chee Arc Cs

The document is a conformance statement for dcm4che Archive 5, a DICOM archive product. It describes the product as a networked computer system for archiving DICOM objects that allows external systems to send, retrieve, and query objects stored in the archive. The statement lists the DICOM network services and Storage SOP Classes supported by the archive product as a DICOM service provider.

Uploaded by

OrlandoUtrera
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 129

DICOM Conformance Statement

dcm4che Archive 5
Release 5.10.1

Gunter Zeilinger

Jul 14, 2017


Contents

1 Conformance Statement Overview 3

2 Table of Content 9

3 Introduction 11
3.1 Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.2 Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.3 Remarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.4 Terms and Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4 Networking 15
4.1 Implementation Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
4.2 AE Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.3 Network Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
4.4 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

5 Media Interchange 105

6 Support of Character Sets 107

7 Security 109
7.1 Security Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
7.2 Association Level Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
7.3 Application Level Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

i
ii
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Company Name dcm4che.org


Product Name dcm4che DICOM Archive 5
Version 5.10
Date Jul 14, 2017

Contents 1
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

2 Contents
CHAPTER 1

Conformance Statement Overview

dcm4che DICOM Archive 5 is a networked computer system used for archiving DICOM objects. It allows external
systems to send DICOM objects to it for permanent storage, retrieve information about such objects, and retrieve the
DICOM objects themselves.

Table 1.1: Network Services

SOP Classes User Provider


Transfer
Stored Print Storage SOP Class Yes Yes
Hardcopy Grayscale Image Storage SOP Class Yes Yes
Hardcopy Color Image Storage SOP Class Yes Yes
Computed Radiography Image Storage Yes Yes
Digital X-Ray Image Storage - For Presentation Yes Yes
Digital X-Ray Image Storage - For Processing Yes Yes
Digital Mammography X-Ray Image Storage - For Presentation Yes Yes
Digital Mammography X-Ray Image Storage - For Processing Yes Yes
Digital Intra-Oral X-Ray Image Storage - For Presentation Yes Yes
Digital Intra-Oral X-Ray Image Storage - For Processing Yes Yes
CT Image Storage Yes Yes
Enhanced CT Image Storage Yes Yes
Legacy Converted Enhanced CT Image Storage Yes Yes
Ultrasound Multi-frame Image Storage (Retired) Yes Yes
Ultrasound Multi-frame Image Storage Yes Yes
MR Image Storage Yes Yes
Enhanced MR Image Storage Yes Yes
MR Spectroscopy Storage Yes Yes
Enhanced MR Color Image Storage Yes Yes
Legacy Converted Enhanced MR Image Storage Yes Yes
Nuclear Medicine Image Storage (Retired) Yes Yes
Ultrasound Image Storage (Retired) Yes Yes
Ultrasound Image Storage Yes Yes
Continued on next page

3
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 1.1 continued from previous page


SOP Classes User Provider
Enhanced US Volume Storage Yes Yes
Secondary Capture Image Storage Yes Yes
Multi-frame Single Bit Secondary Capture Image Storage Yes Yes
Multi-frame Grayscale Byte Secondary Capture Image Storage Yes Yes
Multi-frame Grayscale Word Secondary Capture Image Storage Yes Yes
Multi-frame True Color Secondary Capture Image Storage Yes Yes
12-lead ECG Waveform Storage Yes Yes
General ECG Waveform Storage Yes Yes
Ambulatory ECG Waveform Storage Yes Yes
Hemodynamic Waveform Storage Yes Yes
Cardiac Electrophysiology Waveform Storage Yes Yes
Basic Voice Audio Waveform Storage Yes Yes
General Audio Waveform Storage Yes Yes
Arterial Pulse Waveform Storage Yes Yes
Respiratory Waveform Storage Yes Yes
Grayscale Softcopy Presentation State Storage SOP Class Yes Yes
Color Softcopy Presentation State Storage SOP Class Yes Yes
Pseudo-Color Softcopy Presentation State Storage SOP Class Yes Yes
Blending Softcopy Presentation State Storage SOP Class Yes Yes
XA/XRF Grayscale Softcopy Presentation State Storage Yes Yes
X-Ray Angiographic Image Storage Yes Yes
Enhanced XA Image Storage Yes Yes
X-Ray Radiofluoroscopic Image Storage Yes Yes
Enhanced XRF Image Storage Yes Yes
X-Ray Angiographic Bi-Plane Image Storage (Retired) Yes Yes
X-Ray 3D Angiographic Image Storage Yes Yes
X-Ray 3D Craniofacial Image Storage Yes Yes
Breast Tomosynthesis Image Storage Yes Yes
Breast Projection X-Ray Image Storage - For Presentation Yes Yes
Breast Projection X-Ray Image Storage - For Processing Yes Yes
Intravascular Optical Coherence Tomography Image Storage - For Presentation Yes Yes
Intravascular Optical Coherence Tomography Image Storage - For Processing Yes Yes
Nuclear Medicine Image Storage Yes Yes
Parametric Map Storage Yes Yes
Raw Data Storage Yes Yes
Spatial Registration Storage Yes Yes
Spatial Fiducials Storage Yes Yes
Deformable Spatial Registration Storage Yes Yes
Segmentation Storage Yes Yes
Surface Segmentation Storage Yes Yes
Real World Value Mapping Storage Yes Yes
Surface Scan Mesh Storage Yes Yes
Surface Scan Point Cloud Storage Yes Yes
VL Endoscopic Image Storage Yes Yes
Video Endoscopic Image Storage Yes Yes
VL Microscopic Image Storage Yes Yes
Video Microscopic Image Storage Yes Yes
VL Slide-Coordinates Microscopic Image Storage Yes Yes
VL Photographic Image Storage Yes Yes
Continued on next page

4 Chapter 1. Conformance Statement Overview


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 1.1 continued from previous page


SOP Classes User Provider
Video Photographic Image Storage Yes Yes
Ophthalmic Photography 8 Bit Image Storage Yes Yes
Ophthalmic Photography 16 Bit Image Storage Yes Yes
Stereometric Relationship Storage Yes Yes
Ophthalmic Tomography Image Storage Yes Yes
Wide Field Ophthalmic Photography Stereographic Projection Image Storage Yes Yes
Wide Field Ophthalmic Photography 3D Coordinates Image Storage Yes Yes
VL Whole Slide Microscopy Image Storage Yes Yes
Lensometry Measurements Storage Yes Yes
Autorefraction Measurements Storage Yes Yes
Keratometry Measurements Storage Yes Yes
Subjective Refraction Measurements Storage Yes Yes
Visual Acuity Measurements Storage Yes Yes
Spectacle Prescription Report Storage Yes Yes
Ophthalmic Axial Measurements Storage Yes Yes
Intraocular Lens Calculations Storage Yes Yes
Macular Grid Thickness and Volume Report Storage Yes Yes
Ophthalmic Visual Field Static Perimetry Measurements Storage Yes Yes
Ophthalmic Thickness Map Storage Yes Yes
Corneal Topography Map Storage Yes Yes
Basic Text SR Storage Yes Yes
Enhanced SR Storage Yes Yes
Comprehensive SR Storage Yes Yes
Comprehensive 3D SR Storage Yes Yes
Extensible SR Storage Yes Yes
Procedure Log Storage Yes Yes
Mammography CAD SR Storage Yes Yes
Key Object Selection Document Storage Yes Yes
Chest CAD SR Storage Yes Yes
X-Ray Radiation Dose SR Storage Yes Yes
Radiopharmaceutical Radiation Dose SR Storage Yes Yes
Colon CAD SR Storage Yes Yes
Implantation Plan SR Storage Yes Yes
Encapsulated PDF Storage Yes Yes
Encapsulated CDA Storage Yes Yes
Positron Emission Tomography Image Storage Yes Yes
Legacy Converted Enhanced PET Image Storage Yes Yes
Enhanced PET Image Storage Yes Yes
RT Image Storage Yes Yes
RT Dose Storage Yes Yes
RT Structure Set Storage Yes Yes
RT Beams Treatment Record Storage Yes Yes
RT Plan Storage Yes Yes
RT Brachy Treatment Record Storage Yes Yes
RT Treatment Summary Record Storage Yes Yes
RT Ion Plan Storage Yes Yes
RT Ion Beams Treatment Record Storage Yes Yes
Private Agfa Basic Attribute Presentation State Yes Yes
Private Agfa Arrival Transaction Yes Yes
Continued on next page

5
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 1.1 continued from previous page


SOP Classes User Provider
Private Agfa Dictation Transaction Yes Yes
Private Agfa Report Transcription Transaction Yes Yes
Private Agfa Report Approval Transaction Yes Yes
Private TomTec Annotation Storage Yes Yes
Private Toshiba US Image Storage Yes Yes
Private Fuji CR Image Storage Yes Yes
Private GE Collage Storage Yes Yes
Private ERAD Practice Builder Report Text Storage Yes Yes
Private ERAD Practice Builder Report Dictation Storage Yes Yes
Private Philips HP Live 3D 01 Storage Yes Yes
Private Philips HP Live 3D 02 Storage Yes Yes
Private GE 3D Model Storage Yes Yes
Private GE Dicom CT Image Info Object Yes Yes
Private GE Dicom Display Image Info Object Yes Yes
Private GE Dicom MR Image Info Object Yes Yes
Private GE eNTEGRA Protocol or NM Genie Storage Yes Yes
Private GE PET Raw Data Storage Yes Yes
Private GE RT Plan Storage Yes Yes
Private PixelMed Legacy Converted Enhanced CT Image Storage Yes Yes
Private PixelMed Legacy Converted Enhanced MR Image Storage Yes Yes
Private PixelMed Legacy Converted Enhanced PET Image Storage Yes Yes
Private PixelMed Floating Point Image Storage Yes Yes
Private Siemens CSA Non Image Storage Yes Yes
Private Siemens CT MR Volume Storage Yes Yes
Private Siemens AX Frame Sets Storage Yes Yes
Private Philips Specialised XA Storage Yes Yes
Private Philips CX Image Storage Yes Yes
Private Philips 3D Presentation State Storage Yes Yes
Private Philips VRML Storage Yes Yes
Private Philips Volume Set Storage Yes Yes
Private Philips Volume Storage (Retired) Yes Yes
Private Philips Volume Storage Yes Yes
Private Philips 3D Object Storage (Retired) Yes Yes
Private Philips 3D Object Storage Yes Yes
Private Philips Surface Storage (Retired) Yes Yes
Private Philips Surface Storage Yes Yes
Private Philips Composite Object Storage Yes Yes
Private Philips MR Cardio Profile Storage Yes Yes
Private Philips MR Cardio Storage (Retired) Yes Yes
Private Philips MR Cardio Storage Yes Yes
Private Philips CT Synthetic Image Storage Yes Yes
Private Philips MR Synthetic Image Storage Yes Yes
Private Philips MR Cardio Analysis Storage (Retired) Yes Yes
Private Philips MR Cardio Analysis Storage Yes Yes
Private Philips CX Synthetic Image Storage Yes Yes
Private Philips Perfusion Storage Yes Yes
Private Philips Perfusion Image Storage Yes Yes
Private Philips X-Ray MF Storage Yes Yes
Private Philips Live Run Storage Yes Yes
Continued on next page

6 Chapter 1. Conformance Statement Overview


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 1.1 continued from previous page


SOP Classes User Provider
Private Philips Run Storage Yes Yes
Private Philips Reconstruction Storage Yes Yes
Private Philips MR Spectrum Storage Yes Yes
Private Philips MR Series Data Storage Yes Yes
Private Philips MR Color Image Storage Yes Yes
Private Philips MR Examcard Storage Yes Yes
Private PMOD Multi-frame Image Storage Yes Yes
Query/Retrieve
Patient Root Query/Retrieve Information Model - FIND No Yes
Patient Root Query/Retrieve Information Model - MOVE Yes Yes
Patient Root Query/Retrieve Information Model - GET No Yes
Study Root Query/Retrieve Information Model - FIND No Yes
Study Root Query/Retrieve Information Model - MOVE Yes Yes
Study Root Query/Retrieve Information Model - GET No Yes
Workflow Management
Storage Commitment Push Model SOP Class No Yes
Modality Worklist Information Model - FIND No Yes
Modality Performed Procedure Step Yes Yes
Instance Availability Notification SOP Class Yes No
QIDO
QIDO-RS - Search for Patients No Yes
QIDO-RS - Search for Studies No Yes
QIDO-RS - Search for Series No Yes
QIDO-RS - Search for Instances No Yes
STOW
STOW-RS - Store Instances No Yes
WADO
WADO-URI - Retrieve DICOM Persistent Object No Yes
WADO-URI - Retrieve Rendered DICOM Persistent Object No Yes
WADO-RS - Retrieve Study No Yes
WADO-RS - Retrieve Series No Yes
WADO-RS - Retrieve Instance No Yes
WADO-RS - Retrieve Frames No Yes
WADO-RS - Retrieve Bulkdata No Yes
WADO-RS - Retrieve Metadata No Yes

7
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

8 Chapter 1. Conformance Statement Overview


CHAPTER 2

Table of Content

1. Conformance Statement Overview


2. Table of Content
3. Introduction
3.1 Revision History
3.2 Audience
3.3 Remarks
3.4 Terms and Definitions
4. Networking
4.1. Implementation Model
4.1.1. Application Data Flow
4.1.2. Functional Definitions of AEs
4.1.2.1. Storage Application Entity
4.1.2.2. Query/Retrieve Application Entity
4.1.2.3. Workflow Application Entity
4.1.2.4. STOW-RS
4.1.2.5. QIDO-RS
4.1.2.6. WADO-URI
4.1.2.7. WADO-RS
4.1.3. Sequencing of Real-World Activities
4.2. AE Specifications
4.2.1. Storage Application Entity Specification
4.2.2. Query/Retrieve Application Entity Specification
4.2.3. Workflow Application Entity Specification
4.2.4. STOW-RS Specifications
4.2.5. QIDO-RS Specifications
4.2.6. WADO-URI Specification
4.2.7. WADO-RS Specifications
4.3. Network Interfaces

9
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

4.4. Configuration
4.4.1. AE Title/Presentation Address Mapping
4.4.2. Parameters
5. Media Interchange
6. Support of Character Sets
7. Security
7.1 Security Profiles
7.1.1. Secure Transport Connection Profiles
7.1.2. Network Address Management Profiles
7.1.3. Time Synchronization Profiles
7.1.4. Application Configuration Management Profiles
7.1.5. Audit Trail Profiles
7.2 Association Level Security
7.3 Application Level Security

10 Chapter 2. Table of Content


CHAPTER 3

Introduction

Revision History

Table 3.1: Revision History


Document Version Date of Issue Author Description
5.10.1 Jul 14, 2017 gz Initial Draft

Audience

This document is written for the people that need to understand how dcm4che DICOM Archive 5 will integrate into
their healthcare facility. This includes both those responsible for overall imaging network policy and architecture, as
well as integrators who need to have a detailed understanding of the DICOM features of the product. This document
contains some basic DICOM definitions so that any reader may understand how this product implements DICOM
features. However, integrators are expected to fully understand all the DICOM terminology, how the tables in this
document relate to the products functionality, and how that functionality integrates with other devices that support
compatible DICOM features.

Remarks

The scope of this DICOM Conformance Statement is to facilitate integration between dcm4che DICOM Archive 5
and other DICOM products. The Conformance Statement should be read and understood in conjunction with the
DICOM Standard. DICOM by itself does not guarantee interoperability. The Conformance Statement does, however,
facilitate a first-level comparison for interoperability between different applications supporting compatible DICOM
functionality.
This Conformance Statement is not supposed to replace validation with other DICOM equipment to ensure proper
exchange of intended information. In fact, the user should be aware of the following important issues:

11
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

The comparison of different Conformance Statements is just the first step towards assessing interconnectivity
and interoperability between the product and other DICOM conformant equipment.
Test procedures should be defined and executed to validate the required level of interoperability with specific
compatible DICOM equipment, as established by the healthcare facility.
dcm4che DICOM Archive 5 has participated in an industry-wide testing program sponsored by Integrating the
Healthcare Enterprise (IHE). The IHE Integration Statement for dcm4che DICOM Archive 5, together with the
IHE Technical Framework, may facilitate the process of validation testing.

Terms and Definitions

Informal definitions are provided for the following terms used in this Conformance Statement. The DICOM Standard
is the authoritative source for formal definitions of these terms.
Abstract Syntax The information agreed to be exchanged between applications, generally equivalent to a Ser-
vice/Object Pair (SOP) Class. Examples: Verification SOP Class, Modality Worklist Information Model Find
SOP Class, Computed Radiography Image Storage SOP Class.
Application Entity (AE) An end point of a DICOM information exchange, including the DICOM network or media
interface software; i.e., the software that sends or receives DICOM information objects or messages. A single
device may have multiple Application Entities.
Application Entity Title (AET) The externally known name of an Application Entity, used to identify a DICOM
application to other DICOM applications on the network.
Application Context The specification of the type of communication used between Application Entities. Example:
DICOM network protocol.
Association A network communication channel set up between Application Entities.
Attribute A unit of information in an object definition; a data element identified by a tag. The information may
be a complex data structure (Sequence), itself composed of lower level data elements. Examples: Patient
ID (0010,0020), Accession Number (0008,0050), Photometric Interpretation (0028,0004), Procedure Code Se-
quence (0008,1032).
Information Object Definition (IOD) The specified set of Attributes that comprise a type of data object; does not
represent a specific instance of the data object, but rather a class of similar data objects that have the same
properties. The Attributes may be specified as Mandatory (Type 1), Required but possibly unknown (Type 2),
or Optional (Type 3), and there may be conditions associated with the use of an Attribute (Types 1C and 2C).
Examples: MR Image IOD, CT Image IOD, Print Job IOD.
Joint Photographic Experts Group (JPEG) A set of standardized image compression techniques, available for use
by DICOM applications.
Media Application Profile The specification of DICOM information objects and encoding exchanged on removable
media (e.g., CDs)
Module A set of Attributes within an Information Object Definition that are logically related to each other. Example:
Patient Module includes Patient Name, Patient ID, Patient Birth Date, and Patient Sex.
Negotiation First phase of Association establishment that allows Application Entities to agree on the types of data to
be exchanged and how that data will be encoded.
Presentation Context The set of DICOM network services used over an Association, as negotiated between Appli-
cation Entities; includes Abstract Syntaxes and Transfer Syntaxes.
Protocol Data Unit (PDU) A packet (piece) of a DICOM message sent across the network. Devices must specify
the maximum size packet they can receive for DICOM messages.

12 Chapter 3. Introduction
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Security Profile A set of mechanisms, such as encryption, user authentication, or digital signatures, used by an
Application Entity to ensure confidentiality, integrity, and/or availability of exchanged DICOM data
Service Class Provider (SCP) Role of an Application Entity that provides a DICOM network service; typically,
a server that performs operations requested by another Application Entity (Service Class User). Examples:
Picture Archiving and Communication System (image storage SCP, and image query/retrieve SCP), Radiology
Information System (modality worklist SCP).
Service Class User (SCU) Role of an Application Entity that uses a DICOM network service; typically, a client.
Examples: imaging modality (image storage SCU, and modality worklist SCU), imaging workstation (image
query/retrieve SCU)
Service/Object Pair Class (SOP Class) The specification of the network or media transfer (service) of a particular
type of data (object); the fundamental unit of DICOM interoperability specification. Examples: Ultrasound
Image Storage Service, Basic Grayscale Print Management.
Service/Object Pair Instance (SOP Instance) An information object; a specific occurrence of information ex-
changed in a SOP Class. Examples: a specific x-ray image.
Tag A 32-bit identifier for a data element, represented as a pair of four digit hexadecimal numbers, the group
and the element. If the group number is odd, the tag is for a private (manufacturer-specific) data element.
Examples: (0010,0020) [Patient ID], (07FE,0010) [Pixel Data], (0019,0210) [private data element]
Transfer Syntax The encoding used for exchange of DICOM information objects and messages. Examples: JPEG
compressed (images), little endian explicit value representation.
Unique Identifier (UID) A globally unique dotted decimal string that identifies a specific object or a class of
objects; an ISO-8824 Object Identifier. Examples: Study Instance UID, SOP Class UID, SOP Instance UID.
Value Representation (VR) The format type of an individual DICOM data element, such as text, an integer, a
persons name, or a code. DICOM information objects can be transmitted with either explicit identification of
the type of each data element (Explicit VR), or without explicit identification (Implicit VR); with Implicit VR,
the receiving application must use a DICOM data dictionary to look up the format of each data element.

3.4. Terms and Definitions 13


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

14 Chapter 3. Introduction
CHAPTER 4

Networking

Implementation Model

Application Data Flow

The core component of dcm4che DICOM Archive 5 is a Java Enterprise Application deployed in WildFly AS, which
provides DICOM services over the DICOM Upper Layer protocol (DUL) and HTTP, HL7 v2 services over the Minimal
Lower Layer Protocol (MLLP), various proprietary RESTful services and a Web UI accessable by HTML 5 compliant
web browsers.
It uses any LDAP v3 compatible LDAP server as configuration backend and a relational database for supporting query
and data management services.
The received DICOM objects are not stored in the database, but in a separated storage backend - typically any type of
file system, but also cloud storage supported by Apache jclouds may be used as storage backend.
System-log and audit messages may be stored into the Elastic Stack.
RESTful services and the Web UI may be secured with OpenID Connect using Keycloak as Authentication Server.

Fig. 4.1: System components

System components may be distributed over multiple hosts, as multiple instances of the Archive Application may
share one LDAP server and one database.

Fig. 4.2: Multi-host deployment

System components of dcm4che DICOM Archive 5 are also available as Docker images to run within Docker contain-
erns.
Conceptually the network services may be modeled as the following separate AEs, though they may share one AE
Title, or one AE may have multiple instances identified by different AE Titles, with different configuration.

15
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Fig. 4.3: Docker deployment

Storage Application Entity, which receives incoming images and other Composite Object Instances and accepts
requests for commitment for the safekeeping of the received objects.
Query/Retrieve Application Entity, which processes queries for Patient, Study, Series, and Instance information
and also processes retrieval requests, sending the requested objects to the retrieve destination AE.
Workflow Application Entity, which processes queries for Scheduled Procedure Steps, receives Performed Pro-
cedure Step messages and optionally forwards them to any remote AE, and also notifies remote AEs about the
availability of received instances.
STOW-RS, which receives images and other Composite Object Instances via HTTP POST requests.
QIDO-RS, which provides access to Patient, Study, Series, and Instance data of received objects via HTTP GET
requests.
WADO-URI, which provides access to individual DICOM Objects - as DICOM file or rendered to non-DICOM
media types for display - via HTTP GET requests.
WADO-RS, which provides access to the metadata, the bulk data or the whole DICOM Objects, of a Study or
Series via HTTP GET requests.

Fig. 4.4: Application Data Flow Diagram

Fig. 4.5: Workflow Application Data Flow Diagram

Functional Definitions of AEs

Storage Application Entity

The Storage Application Entity receives images and other Composite Object Instances from remote AEs.
Compressed images and non-image objects are stored as received on the storage backend configured for the Storage
AE. Uncompressed images may be compressed according configurable compression rules before they are stored with
all attributes on the storage backend.
A configurable sub-set of attributes are extracted from the received objects and stored in the data base. These attributes
may be coerced according configurable coercion rules on receive time or by data management functions at any time
after.
If configured, the Storage AE queries an external RESTful service for permission to store a study on receive of the first
object of a study. If the service does not grant the permission to store the study, the object and all following received
objects of that study will be refused.
The behavior on receive of an object which SOP Instance UID matches with the SOP Instance UID of a previous
received object is configurable: The new received object may overwrite the previous one, be stored additionally or
just be ignored, dependent if it was sent by the same source and/or dependent if it belongs to the same series as the
previous received object. That allows to operate with object sources which does not support use of Imaging Object
Change Management (IOCM) services to correct failures in the originally sent objects, but which just send the objects
with corrected attributes but unchanged SOP Instance UID again.

16 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Fig. 4.6: Web Application Data Flow Diagram

The behavior how to treat differences in Patient, Study or Series attributes in received instances belonging to the same
Patient, Study or Series is also configurable: the attributes of the already existing Patient, Study or Series record in the
data base may
not be updated at all,
be supplemented with attributes from the new received object, not included in the existing record,
be additionally overwritten by different values of the attributes in the new received object,
be completely replaced by the extracted attributes from the new received object.
The Storage AE may also associate a configured Access Control ID to a received study. Query/Retrieve AEs can be
configured to only provide access to data and objects of studies, which associated Access Control ID matches one of
the Access Control IDs configured for that Query/Retrieve AE.
If configured, the Storage AE will set the Retention Period of received studies according a configured Study Retention
Policy. Individual series of a study may get a different Rentention Period than the whole study. If activated, studies
- or individual series - will be deleted automatically after its Rentention Period expires. On the other hand, dcm4che
DICOM Archive 5 can be configured to prevent manual deletion of objects of studies which Rentention Period is not
yet expired.
The Storage AE can also be configured to act as a cache archive, which deletes least recent accessed studies according
configured thresholds of the storage backend.
Received objects may be exported according configurable export rules, which are triggered by matching send-
ing/receiving AE Titles and/or matching object attribute values. Received objects of one series or study may be
accumulated, before all objects of the series or study are exported in one task. Export by DICOM storage is invoked
by the Query/Retrieve Application Entity.
Objects may be also received from the Storage AE as result of a forwarded retrieve request to a configured fallback
archive by the Query/Retrieve Application Entity. In that case, the received objects will be forwarded immediately to
the final retrieve destination by the Query/Retrieve Application Entity.
The receive of objects may trigger the notification of configured remote AEs by the DICOM Instance Available Noti-
fication service invoked by the Workflow Application Entity.
If the Storage AE receives a Key Object Selection (KOS) Document with a Document Title which matches one of
the configured Rejection Note Code Values, the object will be treated as Rejection Note and the instances referenced
by the object will be marked as rejected. The Key Selection Object Document itself is stored on the storage backend
as other objects received from the Storage AE. Further treatment of the rejected instances and the KOS Document is
specific to the particular type of rejection.
By default, the KOS Document Titles specified by Imaging Object Change Management (IOCM) are configured:
(113001, DCM, Rejected for Quality Reasons)
Hide/Show rejected instances dependend on Query/Retrieve AE
Show KOS Document
Ignore subsequent occurrence of rejected instances
(113037, DCM, Rejected for Patient Safety Reasons)
Hide rejected instances
Show KOS Document
Reject subsequent occurrence of rejected instances

4.1. Implementation Model 17


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

(113038, DCM, Incorrect Modality Worklist Entry)


Hide rejected instances
Show KOS Document
Reject subsequent occurrence of rejected instances
(113039, DCM, Data Retention Rejected for Quality Reasons)
Hide rejected instances and KOS Document
Subsequent occurrence of rejected instances reverts the rejection
Delete rejected instances and KOS Document after delay
The Storage AE accepts requests for commitment for the storage of previous received instances - including KOS
Documents acting as Rejection Notes. For each object, for which storage commitment is requested, the Storage AE
does not only check the existence of a record for that object in the data base, but actually read the object from the
storage backend, recalculating the checksum and compare it with the checksum stored in the data base. Only for
objects which recalulated checksum matches with that in the data base the commitment to store is accepted.
The amount of time to take responsibility for the safekeeping of an objects is independent of the successful commit-
ment to store the object, but depends on other configuration options, particularly on the configured Study Retention
Policy. It is even possible to accept storage commitment requests when acting as a cache archive, which deletes least
recent accessed studies according configured thresholds of the storage backend.

Query/Retrieve Application Entity

The Query/Retrieve Application Entity processes queries for Patient, Study, Series, and Instance information of re-
ceived DICOM objects invoked by remote AEs. Attributes of requested entities are fetched from the database. The
objects on the storage backend are not accessed. Therefore, only the configurable sub-set of attributes which were
extracted from the received objects and stored in the data base is provided.
In addition, the Query/Retrieve Application Entity provides the ability to retrieve/transfer received DICOM objects to
remote AEs. The transfer may be originated by a retrieve request from the same or from another remote AE, it may be
caused by a configured Export Rule for received objects, or it may be triggered by the Archive Web UI, which itself
uses a RESTful service to schedule the transfer, which may be also used by other web clients.
The Query/Retrieve Application Entity may forward retrieve requests for which no matching objects were found in
the data base to a configured other DICOM Archive. Two configuration options are available:
1. Preserve the original Move Destination AE Title in the forwarded retrieve request, so the other DICOM Archive
will directly send the requested objects to the destination AE.
2. Replace the original Move Destination AE Title in the forwarded retrieve request with the AE Title of the/a
Storage Application Entity, so the other DICOM Archive will send the requested objects to the Storage AE
and the Query/Retrieve AE will forward the received objects to the original Move Destination AE. If the other
DICOM Archive signals that not all requested objects could be transfered to the Storage AE successfully, the
Study and Series of the received objects are marked as incomplete in the data base and following retrieve request
for that Study or Series will trigger to retry to retrieve the Study or Series from the other DICOM Archive.

Workflow Application Entity

Worklist Update attempts to download a Worklist from a remote node. If the Workflow AE establishes an Association
to a remote AE, it will transfer all worklist items via the open Association. During receiving the worklist response
items are counted and the query processing is canceled if the configurable limit of items is reached. The results will
be displayed in a separate list, which will be cleared with the next Worklist Update. The Workflow AE performs the
creation of a MPPS Instance automatically whenever images are acquired. Further updates on the MPPS data can be

18 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

performed interactively from the related MPPS user interface. The MPPS Complete or Discontinued states can
only be set from the user interface.

STOW-RS

The reception of a STOW-RS POST request will activate the STOW-RS Service. The storage request is based upon
the accept headers in the STOW-RS POST request. The response includes an HTTP status line, including a status-
code and its associated textual phrase, followed by an XML message indicating success, warning, or failure for each
instance stored by the STOW-RS service.

QIDO-RS

The reception of a QIDO-RS GET request will activate the QIDO-RS Provider. An internal query request is sent to
the search capabilities of the associated PACS or Vendor Neutral Archive (VNA). The search result is based upon the
URL of the QIDO-RS GET request. The response is a status code indicating the success, warning, or failure of the
search along with any matching results stored in the Remote PACS or VNA.

WADO-URI

The reception of a WADO request will activate the AE. An internal request is sent to the search capabilities of the
DCM4CHEE-WADO-SERVICE. This request is based upon the request parameters or the URL resource end point
from the WADO request. The response is a list of all SOP instances stored on the DCM4CHEE-PACS-ARCHIVE that
match the request parameters. If there are no matching instances, the AE will indicate this in the WADO response.
For all matching instances, the AE will utilize the internal image transfer request to obtain a copy of each instance. If
the request was for retrieval of instances, these instances will be returned. If the request was for retrieval of rendered
instances, then the AE will render each instance and return the rendered results.

WADO-RS

The reception of a WADO request will activate the AE. An internal request is sent to the search capabilities of the
DCM4CHEE-WADO-SERVICE. This request is based upon the request parameters or the URL resource end point
from the WADO request. The response is a list of all SOP instances stored on the DCM4CHEE-PACS-ARCHIVE that
match the request parameters. If there are no matching instances, the AE will indicate this in the WADO response.
For all matching instances, the AE will utilize the internal image transfer request to obtain a copy of each instance. If
the request was for retrieval of instances, these instances will be returned. If the request was for retrieval of rendered
instances, then the AE will render each instance and return the rendered results.

Sequencing of Real-World Activities

Fig. 4.7: Figure : Sequencing of Real-World Activities

Under normal scheduled workflow conditions the sequencing constraints illustrated in Figure B.4.1-2 apply:
1. Query Worklist
2. Receive Worklist of Modality Scheduled Procedure Steps (MSPS)
3. Select Workitem (MSPS) from Worklist
4. Start acquisition and create MPPS

4.1. Implementation Model 19


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

5. Acquire Images
6. Complete acquisition and finalize MPPS
7. Print acquired images (optional step)
8. Store acquired images and any associated Grayscale Softcopy Presentation State (GSPS) instances.
9. If the Image Manager is configured as an archive device the Storage AE will request Storage Commitment for
the images and associated GSPS instances.
Other workflow situations (e.g., unscheduled procedure steps) will have other sequencing constraints. Printing could
equally take place after the acquired images have been stored. Printing could be omitted completely if no printer is
connected or hard copies are not required.

AE Specifications

Storage Application Entity Specification

SOP Classes

The Storage Application Entity provides Standard Conformance to the following SOP Class(es) :

Table 4.1: SOP Classes for Storage Application Entity (SCP)

SOP Class Name SOP Class UID SCU SCP


Verification SOP Class 1.2.840.10008.1.1 Yes Yes
Storage Commitment Push Model SOP Class 1.2.840.10008.1.20.1 No Yes
Image Storage SOP Classes:
Computed Radiography Image Storage 1.2.840.10008.5.1.4.1.1.1 No Yes
Digital X-Ray Image Storage - For Presentation 1.2.840.10008.5.1.4.1.1.1.1 No Yes
Digital X-Ray Image Storage - For Processing 1.2.840.10008.5.1.4.1.1.1.1.1 No Yes
Digital Mammography X-Ray Image Storage - For Presentation 1.2.840.10008.5.1.4.1.1.1.2 No Yes
Digital Mammography X-Ray Image Storage - For Processing 1.2.840.10008.5.1.4.1.1.1.2.1 No Yes
Digital Intra-Oral X-Ray Image Storage - For Presentation 1.2.840.10008.5.1.4.1.1.1.3 No Yes
Digital Intra-Oral X-Ray Image Storage - For Processing 1.2.840.10008.5.1.4.1.1.1.3.1 No Yes
CT Image Storage 1.2.840.10008.5.1.4.1.1.2 No Yes
Enhanced CT Image Storage 1.2.840.10008.5.1.4.1.1.2.1 No Yes
Legacy Converted Enhanced CT Image Storage 1.2.840.10008.5.1.4.1.1.2.2 No Yes
Ultrasound Multi-frame Image Storage (Retired) 1.2.840.10008.5.1.4.1.1.3 No Yes
Ultrasound Multi-frame Image Storage 1.2.840.10008.5.1.4.1.1.3.1 No Yes
MR Image Storage 1.2.840.10008.5.1.4.1.1.4 No Yes
Enhanced MR Image Storage 1.2.840.10008.5.1.4.1.1.4.1 No Yes
Enhanced MR Color Image Storage 1.2.840.10008.5.1.4.1.1.4.3 No Yes
Legacy Converted Enhanced MR Image Storage 1.2.840.10008.5.1.4.1.1.4.4 No Yes
Nuclear Medicine Image Storage (Retired) 1.2.840.10008.5.1.4.1.1.5 No Yes
Ultrasound Image Storage (Retired) 1.2.840.10008.5.1.4.1.1.6 No Yes
Ultrasound Image Storage 1.2.840.10008.5.1.4.1.1.6.1 No Yes
Enhanced US Volume Storage 1.2.840.10008.5.1.4.1.1.6.2 No Yes
Secondary Capture Image Storage 1.2.840.10008.5.1.4.1.1.7 No Yes
Multi-frame Grayscale Byte Secondary Capture Image Storage 1.2.840.10008.5.1.4.1.1.7.2 No Yes
Multi-frame Grayscale Word Secondary Capture Image Storage 1.2.840.10008.5.1.4.1.1.7.3 No Yes
Continued on next page

20 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.1 continued from previous page


SOP Class Name SOP Class UID SCU SCP
Multi-frame True Color Secondary Capture Image Storage 1.2.840.10008.5.1.4.1.1.7.4 No Yes
X-Ray Angiographic Image Storage 1.2.840.10008.5.1.4.1.1.12.1 No Yes
Enhanced XA Image Storage 1.2.840.10008.5.1.4.1.1.12.1.1 No Yes
X-Ray Radiofluoroscopic Image Storage 1.2.840.10008.5.1.4.1.1.12.2 No Yes
Enhanced XRF Image Storage 1.2.840.10008.5.1.4.1.1.12.2.1 No Yes
X-Ray Angiographic Bi-Plane Image Storage (Retired) 1.2.840.10008.5.1.4.1.1.12.3 No Yes
X-Ray 3D Angiographic Image Storage 1.2.840.10008.5.1.4.1.1.13.1.1 No Yes
X-Ray 3D Craniofacial Image Storage 1.2.840.10008.5.1.4.1.1.13.1.2 No Yes
Breast Tomosynthesis Image Storage 1.2.840.10008.5.1.4.1.1.13.1.3 No Yes
Breast Projection X-Ray Image Storage - For Presentation 1.2.840.10008.5.1.4.1.1.13.1.4 No Yes
Breast Projection X-Ray Image Storage - For Processing 1.2.840.10008.5.1.4.1.1.13.1.5 No Yes
Intravascular Optical Coherence Tomography Image Storage - For Presentation 1.2.840.10008.5.1.4.1.1.14.1 No Yes
Intravascular Optical Coherence Tomography Image Storage - For Processing 1.2.840.10008.5.1.4.1.1.14.2 No Yes
Nuclear Medicine Image Storage 1.2.840.10008.5.1.4.1.1.20 No Yes
VL Image Storage - Trial (Retired) 1.2.840.10008.5.1.4.1.1.77.1 No Yes
VL Multi-frame Image Storage - Trial (Retired) 1.2.840.10008.5.1.4.1.1.77.2 No Yes
VL Endoscopic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.1 No Yes
VL Microscopic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.2 No Yes
VL Slide-Coordinates Microscopic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.3 No Yes
VL Photographic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.4 No Yes
Ophthalmic Photography 8 Bit Image Storage 1.2.840.10008.5.1.4.1.1.77.1.5.1 No Yes
Ophthalmic Photography 16 Bit Image Storage 1.2.840.10008.5.1.4.1.1.77.1.5.2 No Yes
Ophthalmic Tomography Image Storage 1.2.840.10008.5.1.4.1.1.77.1.5.4 No Yes
Wide Field Ophthalmic Photography Stereographic Projection Image Storage 1.2.840.10008.5.1.4.1.1.77.1.5.5 No Yes
Wide Field Ophthalmic Photography 3D Coordinates Image Storage 1.2.840.10008.5.1.4.1.1.77.1.5.6 No Yes
VL Whole Slide Microscopy Image Storage 1.2.840.10008.5.1.4.1.1.77.1.6 No Yes
Ophthalmic Thickness Map Storage 1.2.840.10008.5.1.4.1.1.81.1 No Yes
Corneal Topography Map Storage 1.2.840.10008.5.1.4.1.1.82.1 No Yes
Positron Emission Tomography Image Storage 1.2.840.10008.5.1.4.1.1.128 No Yes
Legacy Converted Enhanced PET Image Storage 1.2.840.10008.5.1.4.1.1.128.1 No Yes
Enhanced PET Image Storage 1.2.840.10008.5.1.4.1.1.130 No Yes
RT Image Storage 1.2.840.10008.5.1.4.1.1.481.1 No Yes
Private Fuji CR Image Storage 1.2.392.200036.9125.1.1.2 No Yes
Private GE Dicom CT Image Info Object 1.2.840.113619.4.3 No Yes
Private GE Dicom Display Image Info Object 1.2.840.113619.4.4 No Yes
Private GE Dicom MR Image Info Object 1.2.840.113619.4.2 No Yes
Private Philips CT Synthetic Image Storage 1.3.46.670589.5.0.9 No Yes
Private Philips CX Image Storage 1.3.46.670589.2.4.1.1 No Yes
Private Philips CX Synthetic Image Storage 1.3.46.670589.5.0.12 No Yes
Private Philips MR Color Image Storage 1.3.46.670589.11.0.0.12.3 No Yes
Private Philips MR Synthetic Image Storage 1.3.46.670589.5.0.10 No Yes
Private Philips Perfusion Image Storage 1.3.46.670589.5.0.14 No Yes
Private PixelMed Floating Point Image Storage 1.3.6.1.4.1.5962.301.9 No Yes
Private PixelMed Legacy Converted Enhanced CT Image Storage 1.3.6.1.4.1.5962.301.1 No Yes
Private PixelMed Legacy Converted Enhanced MR Image Storage 1.3.6.1.4.1.5962.301.2 No Yes
Private PixelMed Legacy Converted Enhanced PET Image Storage 1.3.6.1.4.1.5962.301.3 No Yes
Private PMOD Multi-frame Image Storage 2.16.840.1.114033.5.1.4.1.1.130 No Yes
Private Toshiba US Image Storage 1.2.392.200036.9116.7.8.1.1.1 No Yes
Video Storage SOP Classes:
Continued on next page

4.2. AE Specifications 21
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.1 continued from previous page


SOP Class Name SOP Class UID SCU SCP
Video Endoscopic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.1.1 No Yes
Video Microscopic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.2.1 No Yes
Video Photographic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.4.1 No Yes
Structured Report Storage SOP Classes:
Spectacle Prescription Report Storage 1.2.840.10008.5.1.4.1.1.78.6 No Yes
Macular Grid Thickness and Volume Report Storage 1.2.840.10008.5.1.4.1.1.79.1 No Yes
Basic Text SR Storage 1.2.840.10008.5.1.4.1.1.88.11 No Yes
Enhanced SR Storage 1.2.840.10008.5.1.4.1.1.88.22 No Yes
Comprehensive SR Storage 1.2.840.10008.5.1.4.1.1.88.33 No Yes
Comprehensive 3D SR Storage 1.2.840.10008.5.1.4.1.1.88.34 No Yes
Extensible SR Storage 1.2.840.10008.5.1.4.1.1.88.35 No Yes
Procedure Log Storage 1.2.840.10008.5.1.4.1.1.88.40 No Yes
Mammography CAD SR Storage 1.2.840.10008.5.1.4.1.1.88.50 No Yes
Key Object Selection Document Storage 1.2.840.10008.5.1.4.1.1.88.59 No Yes
Chest CAD SR Storage 1.2.840.10008.5.1.4.1.1.88.65 No Yes
X-Ray Radiation Dose SR Storage 1.2.840.10008.5.1.4.1.1.88.67 No Yes
Radiopharmaceutical Radiation Dose SR Storage 1.2.840.10008.5.1.4.1.1.88.68 No Yes
Colon CAD SR Storage 1.2.840.10008.5.1.4.1.1.88.69 No Yes
Implantation Plan SR Storage 1.2.840.10008.5.1.4.1.1.88.70 No Yes
Acquisition Context SR Storage 1.2.840.10008.5.1.4.1.1.88.71 No Yes
Other Storage SOP Classes:
Stored Print Storage SOP Class (Retired) 1.2.840.10008.5.1.1.27 No Yes
Hardcopy Grayscale Image Storage SOP Class (Retired) 1.2.840.10008.5.1.1.29 No Yes
Hardcopy Color Image Storage SOP Class (Retired) 1.2.840.10008.5.1.1.30 No Yes
MR Spectroscopy Storage 1.2.840.10008.5.1.4.1.1.4.2 No Yes
Multi-frame Single Bit Secondary Capture Image Storage 1.2.840.10008.5.1.4.1.1.7.1 No Yes
Standalone Overlay Storage Retired 1.2.840.10008.5.1.4.1.1.8 No Yes
Standalone Curve Storage Retired 1.2.840.10008.5.1.4.1.1.9 No Yes
12-lead ECG Waveform Storage 1.2.840.10008.5.1.4.1.1.9.1.1 No Yes
General ECG Waveform Storage 1.2.840.10008.5.1.4.1.1.9.1.2 No Yes
Ambulatory ECG Waveform Storage 1.2.840.10008.5.1.4.1.1.9.1.3 No Yes
Hemodynamic Waveform Storage 1.2.840.10008.5.1.4.1.1.9.2.1 No Yes
Cardiac Electrophysiology Waveform Storage 1.2.840.10008.5.1.4.1.1.9.3.1 No Yes
Basic Voice Audio Waveform Storage 1.2.840.10008.5.1.4.1.1.9.4.1 No Yes
General Audio Waveform Storage 1.2.840.10008.5.1.4.1.1.9.4.2 No Yes
Arterial Pulse Waveform Storage 1.2.840.10008.5.1.4.1.1.9.5.1 No Yes
Respiratory Waveform Storage 1.2.840.10008.5.1.4.1.1.9.6.1 No Yes
Standalone Modality LUT Storage Retired 1.2.840.10008.5.1.4.1.1.10 No Yes
Standalone VOI LUT Storage Retired 1.2.840.10008.5.1.4.1.1.11 No Yes
Grayscale Softcopy Presentation State Storage SOP Class 1.2.840.10008.5.1.4.1.1.11.1 No Yes
Color Softcopy Presentation State Storage SOP Class 1.2.840.10008.5.1.4.1.1.11.2 No Yes
Pseudo-Color Softcopy Presentation State Storage SOP Class 1.2.840.10008.5.1.4.1.1.11.3 No Yes
Blending Softcopy Presentation State Storage SOP Class 1.2.840.10008.5.1.4.1.1.11.4 No Yes
XA/XRF Grayscale Softcopy Presentation State Storage 1.2.840.10008.5.1.4.1.1.11.5 No Yes
Grayscale Planar MPR Volumetric Presentation State Storage 1.2.840.10008.5.1.4.1.1.11.6 No Yes
Compositing Planar MPR Volumetric Presentation State Storage 1.2.840.10008.5.1.4.1.1.11.7 No Yes
Parametric Map Storage 1.2.840.10008.5.1.4.1.1.30 No Yes
Raw Data Storage 1.2.840.10008.5.1.4.1.1.66 No Yes
Spatial Registration Storage 1.2.840.10008.5.1.4.1.1.66.1 No Yes
Continued on next page

22 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.1 continued from previous page


SOP Class Name SOP Class UID SCU SCP
Spatial Fiducials Storage 1.2.840.10008.5.1.4.1.1.66.2 No Yes
Deformable Spatial Registration Storage 1.2.840.10008.5.1.4.1.1.66.3 No Yes
Segmentation Storage 1.2.840.10008.5.1.4.1.1.66.4 No Yes
Surface Segmentation Storage 1.2.840.10008.5.1.4.1.1.66.5 No Yes
Tractography Results Storage 1.2.840.10008.5.1.4.1.1.66.6 No Yes
Real World Value Mapping Storage 1.2.840.10008.5.1.4.1.1.67 No Yes
Surface Scan Mesh Storage 1.2.840.10008.5.1.4.1.1.68.1 No Yes
Surface Scan Point Cloud Storage 1.2.840.10008.5.1.4.1.1.68.2 No Yes
Stereometric Relationship Storage 1.2.840.10008.5.1.4.1.1.77.1.5.3 No Yes
Lensometry Measurements Storage 1.2.840.10008.5.1.4.1.1.78.1 No Yes
Autorefraction Measurements Storage 1.2.840.10008.5.1.4.1.1.78.2 No Yes
Keratometry Measurements Storage 1.2.840.10008.5.1.4.1.1.78.3 No Yes
Subjective Refraction Measurements Storage 1.2.840.10008.5.1.4.1.1.78.4 No Yes
Visual Acuity Measurements Storage 1.2.840.10008.5.1.4.1.1.78.5 No Yes
Ophthalmic Axial Measurements Storage 1.2.840.10008.5.1.4.1.1.78.7 No Yes
Intraocular Lens Calculations Storage 1.2.840.10008.5.1.4.1.1.78.8 No Yes
Ophthalmic Visual Field Static Perimetry Measurements Storage 1.2.840.10008.5.1.4.1.1.80.1 No Yes
BasicStructuredDisplayStorage 1.2.840.10008.5.1.4.1.1.131 No Yes
Encapsulated PDF Storage 1.2.840.10008.5.1.4.1.1.104.1 No Yes
Encapsulated CDA Storage 1.2.840.10008.5.1.4.1.1.104.2 No Yes
Standalone PET Curve Storage (Retired) 1.2.840.10008.5.1.4.1.1.129 No Yes
Text SR Storage Trial (Retired) 1.2.840.10008.5.1.4.1.1.88.1 No Yes
Audio SR Storage Trial (Retired) 1.2.840.10008.5.1.4.1.1.88.2 No Yes
Detail SR Storage Trial (Retired) 1.2.840.10008.5.1.4.1.1.88.3 No Yes
Comprehensive SR Storage Trial (Retired) 1.2.840.10008.5.1.4.1.1.88.4 No Yes
Content Assessment Results Storage 1.2.840.10008.5.1.4.1.1.90.1 No Yes
RT Dose Storage 1.2.840.10008.5.1.4.1.1.481.2 No Yes
RT Structure Set Storage 1.2.840.10008.5.1.4.1.1.481.3 No Yes
RT Beams Treatment Record Storage 1.2.840.10008.5.1.4.1.1.481.4 No Yes
RT Plan Storage 1.2.840.10008.5.1.4.1.1.481.5 No Yes
RT Brachy Treatment Record Storage 1.2.840.10008.5.1.4.1.1.481.6 No Yes
RT Treatment Summary Record Storage 1.2.840.10008.5.1.4.1.1.481.7 No Yes
RT Ion Plan Storage 1.2.840.10008.5.1.4.1.1.481.8 No Yes
RT Ion Beams Treatment Record Storage 1.2.840.10008.5.1.4.1.1.481.9 No Yes
RT Beams Delivery Instruction Storage 1.2.840.10008.5.1.4.34.7 No Yes
RT Brachy Application Setup Delivery Instruction Storage 1.2.840.10008.5.1.4.34.10 No Yes
Private Agfa Arrival Transaction 1.2.124.113532.3500.8.1 No Yes
Private Agfa Basic Attribute Presentation State 1.2.124.113532.3500.7 No Yes
Private Agfa Dictation Transaction 1.2.124.113532.3500.8.2 No Yes
Private Agfa Report Approval Transaction 1.2.124.113532.3500.8.4 No Yes
Private Agfa Report Transcription Transaction 1.2.124.113532.3500.8.3 No Yes
Private ERAD Practice Builder Report Dictation Storage 1.2.826.0.1.3680043.293.1.0.2 No Yes
Private ERAD Practice Builder Report Text Storage 1.2.826.0.1.3680043.293.1.0.1 No Yes
Private GE 3D Model Storage 1.2.840.113619.4.26 No Yes
Private GE Collage Storage 1.2.528.1.1001.5.1.1.1 No Yes
Private GE eNTEGRA Protocol or NM Genie Storage 1.2.840.113619.4.27 No Yes
Private GE PET Raw Data Storage 1.2.840.113619.4.30 No Yes
Private GE RT Plan Storage 1.2.840.113619.4.5.249 No Yes
Private Philips 3D Object Storage 1.3.46.670589.5.0.2.1 No Yes
Continued on next page

4.2. AE Specifications 23
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.1 continued from previous page


SOP Class Name SOP Class UID SCU SCP
Private Philips 3D Object Storage (Retired) 1.3.46.670589.5.0.2 No Yes
Private Philips 3D Presentation State Storage 1.3.46.670589.2.5.1.1 No Yes
Private Philips Composite Object Storage 1.3.46.670589.5.0.4 No Yes
Private Philips HP Live 3D 01 Storage 1.2.840.113543.6.6.1.3.10001 No Yes
Private Philips HP Live 3D 02 Storage 1.2.840.113543.6.6.1.3.10002 No Yes
Private Philips Live Run Storage 1.3.46.670589.7.8.1618510092 No Yes
Private Philips MR Cardio Analysis Storage 1.3.46.670589.5.0.11.1 No Yes
Private Philips MR Cardio Analysis Storage (Retired) 1.3.46.670589.5.0.11 No Yes
Private Philips MR Cardio Profile Storage 1.3.46.670589.5.0.7 No Yes
Private Philips MR Cardio Storage 1.3.46.670589.5.0.8.1 No Yes
Private Philips MR Cardio Storage (Retired) 1.3.46.670589.5.0.8 No Yes
Private Philips MR Examcard Storage 1.3.46.670589.11.0.0.12.4 No Yes
Private Philips MR Series Data Storage 1.3.46.670589.11.0.0.12.2 No Yes
Private Philips MR Spectrum Storage 1.3.46.670589.11.0.0.12.1 No Yes
Private Philips Perfusion Storage 1.3.46.670589.5.0.13 No Yes
Private Philips Reconstruction Storage 1.3.46.670589.7.8.16185100130 No Yes
Private Philips Run Storage 1.3.46.670589.7.8.16185100129 No Yes
Private Philips Specialised XA Storage 1.3.46.670589.2.3.1.1 No Yes
Private Philips Surface Storage 1.3.46.670589.5.0.3.1 No Yes
Private Philips Surface Storage (Retired) 1.3.46.670589.5.0.3 No Yes
Private Philips Volume Set Storage 1.3.46.670589.2.11.1.1 No Yes
Private Philips Volume Storage 1.3.46.670589.5.0.1.1 No Yes
Private Philips Volume Storage (Retired) 1.3.46.670589.5.0.1 No Yes
Private Philips VRML Storage 1.3.46.670589.2.8.1.1 No Yes
Private Philips X-Ray MF Storage 1.3.46.670589.7.8.1618510091 No Yes
Private Siemens AX Frame Sets Storage 1.3.12.2.1107.5.99.3.11 No Yes
Private Siemens CSA Non Image Storage 1.3.12.2.1107.5.9.1 No Yes
Private Siemens CT MR Volume Storage 1.3.12.2.1107.5.99.3.10 No Yes
Private TomTec Annotation Storage 1.2.276.0.48.5.1.4.1.1.7 No Yes

These are the default SOP Classes supported. By altering the configuration it is possible to support additional or fewer
SOP Classes.

Association Policies

General

The STORAGE-SCP AE can both accept and propose Association Requests. The STORAGE-SCP AE will accept
Association Requests for the Verification, Storage, and Storage Commitment Push Model Services. It will propose
Associations only for the Storage Commitment Push Model Service. The DICOM standard Application Context Name
for DICOM 3.0 is always accepted and proposed:

Number of Associations

The STORAGE-SCP AE can support multiple simultaneous Associations requested by peer AEs. Each time the
STORAGE-SCP AE receives an Association, a child process will be spawned to process the Verification, Storage, or
Storage Commitment Push Model Service requests. The maximum number of child processes, and thus the maximum
number of simultaneous Associations that can be processed, is set by configuration. The default maximum number

24 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

is 10 in total. This maximum number of simultaneous Associations can be either an absolute number or a maximum
number for each requesting external Application Entity. The latter flexibility can be useful if communication with one
external AE is unreliable and one does not wish hung connections with this AE to prevent Associations with other
client AEs. The STORAGE-SCP AE initiates one Association at a time for sending Storage Commitment Push Model
N-EVENT-REPORTs to peer AEs.

Table 4.2: Number of Simultaneous Associations as an SCP for STORAGE-SCP AE


Maximum number of simultaneous Associations requested by peer AEs 10 (Configurable)
Maximum number of simultaneous Associations proposed by STORAGE-SCP AE 1

Asynchronous Nature

The STORAGE-SCP AE does not support asynchronous communication (multiple outstanding transactions over a
single Association). The STORAGE-SCP AE does permit an SCU to send multiple Storage Commitment Push Model
Requests before it has sent back any N-EVENT-REPORT Notifications. However, the STORAGE-SCP AE must send
an N-ACTION Response before permitting another N-ACTION Request to be received so the DICOM communication
itself is not truly asynchronous.

Table 4.3: Asynchronous Nature as a SCP for STORAGE-SCP AE


Maximum number of outstanding asynchronous transactions 1 (Not Configurable)
There is no limit on the number of outstanding Storage Commitment Push Model Requests that can be received and
acknowledged before the STORAGE-SCP AE has responded with the corresponding N-EVENT-REPORT Notifica-
tions.

Table 4.4: Outstanding Storage Commitment Push Model Requests for STORAGE-SCP AE
Maximum number of outstanding Storage Commitment Requests for which no N-EVENT No Maximum
Notification has been sent Limit

Implementation Identifying Information

The implementation information for this Application Entity is:


Note that the STORAGE-SCP AE specifies a different Implementation Class UID than that used by the other Appli-
cation Entities. All DCM4CHEE archive AEs use the same Implementation Version Name. This Version Name is
updated with each new release of the product software, as the different AE versions are never released independently.

Association Initiation Policies

Activity - Send Storage Commitment Notification Over New Association

Description and Sequencing of Activity

The STORAGE-SCP AE will initiate a new Association if a Storage Commitment Push Model Notification (N-
EVENT-REPORT) cannot be sent back over the original Association used to send the corresponding request. A new
Association will always be requested by the STORAGE-SCP AE in such cases even if the peer AE requests another
Association after the original has been closed (i.e., A peer AE opens an Association and sends some Storage requests
and a Storage Commitment Push Model request. Before the STORAGE-SCP AE can send the Storage Commitment

4.2. AE Specifications 25
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Push Model N-EVEN-REPORT the Association is closed. The peer AE then opens another Association and begins
to send Storage requests. In such a case the STORAGE-SCP AE will always initiate a new Association to send the
N-EVENT-REPORT even though it could send the N-EVENT-REPORT over the new Association opened by the peer
AE). An Association Request is sent to the peer AE that sent the Storage Commitment Push Model request and upon
successful negotiation of the required Presentation Context the outstanding N-EVENT-REPORT is sent. If there are
multiple outstanding N-EVENT-REPORTs to be sent to a single peer AE then the STORAGE-SCP AE will attempt
to send them all over a single Association rather than requesting a new Association for each one. The Association
will be released when all the N-EVENT-REPORTs for the peer AE have been sent. If any type of error occurs during
transmission (either a communication failure or indicated by a Status Code returned by the peer AE) over an open
Association then the transfer of N-EVENT-REPORTs is halted. A new Association will be opened to retry sending
outstanding N-EVENT-REPORTs. The maximum number of times the STORAGE-SCP AE will attempt to resend
an N-EVENT-REPORT is configurable, along with the amount of time to wait between attempts to resend. If the
STORAGE-SCP AE sends a Notification request (N-EVENT-REPORT-RQ) over the original Association opened by
the peer AE but receives a request to close the Association rather than a response to the Notification (N-EVENT-
REPORT-RSP) then this is handled in the same way as if the request to close the Association had been received before
trying to send the Notification request. Thus, the STORAGE-SCP AE will then open a new Association to resend the
Notification request. The STORAGE-SCP AE can be configured to always open a new Association before sending
a Storage Commitment Push Model Notifications (N-EVENT-REPORT), in which case the sequencing illustrated in
figure below will always be followed.

Fig. 4.8: Figure : Sequencing of Activity - Send Storage Commitment Notification Over New Association

The following sequencing constraints illustrated in figure above apply to the STORAGE-SCP AE for handling Storage
Commitment Push Model Requests using a new Association:
1. Peer AE opens an Association with the STORAGE-SCP AE.
2. Peer AE requests Storage Commitment of Composite SOP Instance(s) (peer sends N-ACTION-RQ and
STORAGE-SCP AE responds with N-ACTION-RSP to indicate that it received the request).
3. Peer AE closes the Association before the STORAGE-SCP AE can successfully send the Storage Commitment
Push Model Notification (N-EVENT-REPORT-RQ).
4. STORAGE-SCP AE opens an Association with the peer AE.
5. STORAGE-SCP AE sends Storage Commitment Push Model Notification (N-EVENT-REPORT). More than
one can be sent over a single Association if multiple Notifications are outstanding.
6. STORAGE-SCP AE closes the Association with the peer AE.
The Verification Service as an SCU is only supported as a utility function for Service staff. It is used only as a
diagnostic tool when the STORAGE-SCP AE is failing to open new Associations to send N-EVENT-REPORTs to
peer AEs.

Proposed Presentation Contexts

The Storage Application Entity will propose Presentation Contexts for Verification and the Storage Commitment Push
Model SOP Class. The list of proposed Transfer Syntaxes for the Storage Commitment Push Model SOP Class is
configurable. By default, only the Transfer Syntax Implicit VR Little Endian will be proposed.

26 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.5: Proposed Presentation Contexts of Storage Application Entity by default configuration
Presentation Context Table
Abstract Syntax Transfer Syntax
Role Ext. Neg.
Name UID Name UID
Verification 1.2.840.10008.1.1 Implicit VR Little 1.2.840.10008.1.2 SCU None
Endian
Storage Commitment Push 1.2.840.10008.1.20.1Implicit VR Little 1.2.840.10008.1.2 SCP None
Model Endian

SOP Specific Conformance for Storage Commitment Push Model SOP Class

The associated Activity with the Storage Commitment Push Model service is the communication by the STORAGE-
SCP AE to peer AEs that it has committed to permanently store Composite SOP Instances that have been sent to it.
It thus allows peer AEs to determine whether the DCM4CHEE archive has taken responsibility for the archiving of
specific SOP Instances so that they can be flushed from the peer AE system.
The STORAGE-SCP AE will initiate a new Association to a peer AE that sent a Storage Commitment Push Model
request if the original Association over which this was sent is no longer open. For a detailed explanation of the SOP
specific Behavior of the STORAGE-SCP AE in this case please refer to 4.2.4.4.1.3.3, Storage Commitment Push
Model as an SCP.

SOP Specific Conformance for Storage Commitment Verification SOP Class

Standard conformance is provided to the DICOM Verification Service Class as an SCU. The Verification Service as an
SCU is actually only supported as a diagnostic service tool for network communication issues. It can be used to test
whether Associations can actually be opened with a peer AE that is issuing Storage Commitment Push Model requests
(i.e., to test whether the indicated TCP/IP port and AE Title for sending N-EVENT-REPORT Requests to the peer AE
are truly functional).

Association Acceptance Policy

Activity - Receive Images and Storage Commitment Requests

Description and Sequencing of Activities

The STORAGE-SCP AE accepts Associations only if they have valid Presentation Contexts. If none of the requested
Presentation Contexts are accepted then the Association Request itself is rejected. It can be configured to only accept
Associations with certain hosts (using TCP/IP address) and/or Application Entity Titles. The default behavior of
the STORAGE-SCP AE is to always attempt to send a Storage Commitment Push Model Notification (N-EVENT-
REPORT) over the same Association opened by the peer AE to send the request (N-ACTION). If the STORAGE-
SCP AE receives a request to close the Association either before sending the Notification or before receiving the
corresponding N-EVENT-REPORT-RSP then it will open a new Association to send the Notification. Refer to Section
F.4.2.3.4.1.5 for the details.

Fig. 4.9: Figure : Sequencing of Activity - Receive Images and Storage Commitment Requests

The following sequencing constraints illustrated in figure above apply to the STORAGE-SCP AE for handling Storage
Commitment Push Model Requests over the original Association:

4.2. AE Specifications 27
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

1. Peer AE opens an Association with the STORAGE-SCP AE.


2. Peer AE sends zero or more Composite SOP Instances.
3. Peer AE requests Storage Commitment of Composite SOP Instance(s) (peer sends N-ACTION-RQ and
STORAGE-SCP AE responds with N-ACTION-RSP to indicate that it received the request).
4. STORAGE-SCP AE sends Storage Commitment Push Model Notification request (N-EVENT-REPORT-RQ)
and successfully receives Notification response (N-EVENT-REPORT-RSP) from peer AE.
5. Peer AE closes the Association.
If the STORAGE-SCP AE receives a request to close the Association from the peer AE before sending the Notification
request (N-EVENT-REPORT-RQ) or when expecting to receive a Notification response (N-EVENT-REPORT-RSP)
then it will open a new Association to send (or resend) the Notification. Refer to 0 for the details. The STORAGE-SCP
AE has a configurable timeout value for the maximum amount of time that it will wait on an open Association for a
new request from a peer AE. A peer AE can reset this timer by sending a Verification request (C-ECHO-RQ). This
can act as a useful mechanism for a peer AE to maintain an active Association if the length of time between sending
Storage or Storage Commitment requests can be long (such as when using a single Association to send images as they
are acquired during an ultrasound exam). The STORAGE-SCP AE may reject Association attempts as shown in the
Table below. The Result, Source and Reason/Diag columns represent the values returned in the corresponding fields
of an ASSOCIATE-RJ PDU. The following abbreviations are used in the Source column:
1. 1 - DICOM UL service-user
2. 2 - DICOM UL service-provider (ASCE related function)
3. 3 - DICOM UL service-provider (Presentation related function)

Accepted Presentation Contexts

The Storage Application Entity will accept Presentation Contexts for all SOP Classes listed in Table 4.2.1.1-1 by
default. The list of accepted Transfer Syntaxes for each accepted Abstract Syntax - as the list of accepted Abstract
Syntaxes itselfs - is configurable.

Table 4.6: Accepted Presentation Contexts of Storage Application Entity by default configuration
Presentation Context Table
Abstract Syntax Transfer Syntax
Role Ext. Neg.
Name UID Name UID
Verification 1.2.840.10008.1.1 Implicit VR Little Endian 1.2.840.10008.1.2 SCP None
Storage Commitment 1.2.840.10008.1.20.1
Implicit VR Little Endian 1.2.840.10008.1.2 SCP None
Push Model
Image Storage SOP Classes in Table 4.1 see Table 4.7 SCP None
Video Storage SOP Classes in Table 4.1 see Table 4.8 SCP None
Implicit VR Little Endian 1.2.840.10008.1.2
SR Storage SOP Classes in Table 4.1 Explicit VR Little Endian 1.2.840.10008.1.2.1 SCP None
Deflated Explicit VR 1.2.840.10008.1.2.1.99
Little Endian
Implicit VR Little Endian 1.2.840.10008.1.2
Other Storage SOP Classes in Table 4.1 SCP None
Explicit VR Little Endian 1.2.840.10008.1.2.1

28 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.7: Transfer Syntaxes for Image Storage SOP Classes


Transfer Syntax Name UID
Implicit VR Little Endian 1.2.840.10008.1.2
Explicit VR Little Endian 1.2.840.10008.1.2.1
JPEG Baseline (Process 1) 1.2.840.10008.1.2.4.50
JPEG Extended (Process 2 & 4) 1.2.840.10008.1.2.4.51
JPEG Lossless, Non-Hierarchical (Process 14) 1.2.840.10008.1.2.4.54
JPEG Lossless, Non-Hierarchical, First-Order Prediction (Process 14 [Selection Value 1.2.840.10008.1.2.4.70
1])
JPEG-LS Lossless 1.2.840.10008.1.2.4.80
JPEG-LS Lossy (Near-Lossless) 1.2.840.10008.1.2.4.81
JPEG 2000 (Lossless Only)1 1.2.840.10008.1.2.4.90
JPEG 20001 1.2.840.10008.1.2.4.91
RLE Lossless 1.2.840.10008.1.2.5

Table 4.8: Transfer Syntax for Video Storage SOP Classes


Transfer Syntax Name UID
JPEG Baseline (Process 1) 1.2.840.10008.1.2.4.50
MPEG2 Main Profile @ Main Level 1.2.840.10008.1.2.4.100
MPEG2 Main Profile @ High Level 1.2.840.10008.1.2.4.101
MPEG-4 AVC/H.264 High Profile / Level 4.1 1.2.840.10008.1.2.4.102
MPEG-4 AVC/H.264 BD-compatible High Profile / Level 4.1 1.2.840.10008.1.2.4.103
MPEG-4 AVC/H.264 High Profile / Level 4.2 For 2D Video 1.2.840.10008.1.2.4.104
MPEG-4 AVC/H.264 High Profile / Level 4.2 For 3D Video 1.2.840.10008.1.2.4.105
MPEG-4 AVC/H.264 Stereo High Profile / Level 4.2 1.2.840.10008.1.2.4.106
If multiple Transfer Syntaxes are proposed per Presentation Context the order of Transfer Syntax preference is defined
by the order in the proposed Presentation Context.

SOP Specific Conformance for Verification SOP Class

The Storage Application Entity provides standard conformance to the Verification SOP Class as an SCP.

SOP Specific Conformance for Storage SOP Class

The associated Activity with the Storage service is the storage of medical image data received over the network on a
designated hard disk. The Storage Application Entity will return a failure status if it is unable to store the images on
to the hard disk.
The Storage Application Entity does not have any dependencies on the number of Associations used to send images
to it. Images belonging to more than one Study or Series can be sent over a single or multiple Associations. Images
belonging to a single Study or Series can also be sent over different Associations. There is no limit on either the
number of SOP Instances or the maximum amount of total SOP Instance data that can be transferred over a single
Association.
The Storage Application Entity retains the original DICOM data in DICOM Part 10 compliant file format. The Storage
Application Entity is Level 2 (Full) conformant as a Storage SCP. In addition, all Private and SOP Class Extended
Elements are maintained in the DICOM format files.
1 Because of known issues of the JPEG 2000 implementation, acceptance of JPEG 2000 is only recommended for production, if all Retrieve

Destinations also accepts JPEG 2000, so the archive does not need to decompress JPEG 2000 images for retrieval.

4.2. AE Specifications 29
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

In addition to saving all Elements in files, a subset of the Elements are stored in the archive database to support query
and retrieval requests and also allow updating of Patient, Study, and Series information by user input, or demographic
and Study related messages.
The behavior for handling duplicate SOP Instances is configurable by selecting one of 5 available Overwrite Policies:
NEVER: Never overwrite stored Instances on receive of a different Instance with equal SOP Instance UID. Ignore
the received instance silently - returning a success status.
ALWAYS: Always overwrite stored Instances by subsequently received Instances with equal SOP Instance UID.
SAME_SOURCE (default): Only overwrite stored Instances by subsequently received Instances with equal SOP
Instance UID, if the new Instance was sent from the same Source Application Entity or HTTP client as the
previous received Instance. Otherwise ignore the received instance silently - returning a success status.
SAME_SERIES: Only overwrite stored Instances by subsequently received Instances with equal SOP Instance UID,
if the new Instance belongs to the same Series as the previous received Instance (= if beside the SOP Instance
UID, also Study and Series Instance UID are equal). Otherwise ignore the received instance silently - returning
a success status.
SAME_SOURCE_AND_SERIES: Only overwrite stored Instances by subsequently received Instances with equal
SOP Instance UID, if the new Instance was sent from the same Source Application Entity or HTTP client as the
previous received Instance, and if the new Instance belongs to the same Series as the previous received Instance
(= if beside the SOP Instance UID, also Study and Series Instance UID are equal). Otherwise ignore the received
instance silently - returning a success status.
The behavior for updating Patient, Study and Series Attributes in the archive database, if there values differs between
received Instances of the same Patient, Study and Series is configurable for each Entity Level by selecting one of 4
Attribute Update Policies:
NONE: Do not update the Attributes of the Entity in the database from its initial values extracted from the first
received Instance of the Entity.
SUPPLEMENT (default for Patient Attributes): Supplement the Attributes of the Entity in the database with At-
tributes of subsequently received Instances which were not present or had no value in previous received Instances
of the same Entity.
MERGE (default for Study and Series Attributes): Overwrite the Attributes of the Entity in the database with non-
empty Attributes from subsequently received Instances of the same Entity.
OVERWRITE: Overwrite the Attributes of the Entity in the database with all Attributes from subsequently received
Instances of the same Entity.
The Storage Application Entity can be configured to compress uncompressed received Image SOP Instances, depen-
dent on the Source Application Entity or HTTP client and dependent of DICOM Attribute values of received SOP
Instances, using one of following Transfer Syntaxes:
By default, no image compression is configured.

30 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.9: Storage Application C-STORE Response Status Return Reasons


Ser- Further Er- Error Comment Behaviour
vice Meaning ror
Sta- Code
tus
Suc- Success 0000 The Composite SOP Instance was successfully
cess received, verified, and stored in the system
database.
Re- Out of A700 Indicates that there was not enough disk space
fused Resources to store the image. Error message is output to
the Service Log. The SOP Instance will not be
saved.
Duplicate A770 Rejection Note [uid={SOP Indicates that rejection note was already
Rejection Note Instance UID}] already received.
received.
Subsequent A771 Subsequent occurrence of Indicates that there was a subsequent occurrence
Occurrence of rejected Object [uid={SOP of a rejected object during store operation.
Rejected Instance UID},
Object rejection={Rejection Note
Code}]
Rejection A772 Failed to reject Indicates that one or more objects were not
Failed - No Instance[uid={SOP Instance previously stored in archive to be rejected.
Such Instance UID}] - no such Instance.
Rejection A773 Failed to reject Indicates that there was a conflict in SOP Class
Failed - Class Instance[uid={SOP Instance UIDs of object (between that of the previously
Instance UID}] - class-instance received object and the one referenced in the
Conflict conflict. current rejection note) to be rejected.
Rejection A774 Failed to reject Indicates that the rejected object was already
Failed - Instance[uid={SOP Instance rejected.
Already UID}] - already rejected.
Rejected
Rejection for A775 Rejection for Retention Indicates that rejection of objects with type as
Retention Policy Expired not Retention Expired are not allowed by LDAP
Policy Expired authorized. configuration.
not Authorized
Retention A776 Retention Period of Study not Indicates that rejection of objects is not allowed
Period of Study yet expired. as Study Retention Period has not expired yet.
not yet Expired
Patient ID A777 Storage denied as Patient ID Indicates that the Patient ID is missing in the
Missing in missing in object. object.
Object
Conflicting A778 Patient ID in incoming object Indicates that the Patient ID in incoming object
Patient ID in does not match with that of does not match with that of patient associated
Object patient associated with study. with study.
Not Authorized 0124 Storage denied. Indicates that the storage is denied.
Er- Data Set does A900 Indicates that the Data Set does not encode a
ror not match SOP valid instance of the SOP Class specified. This
Class status is returned if the DICOM Object stream
can be successfully parsed but does not contain
values for one or more mandatory Elements of
the SOP Class. The STORAGE-SCP AE does
not perform a comprehensive check, as it only
checks a subset of required Elements. In
addition, if the SOP Class is for a type of image
4.2. AE Specifications but the SOP Instance does not contain values 31
necessary for its display then this status is
returned. Error message is output to the Service
Log. The system can be configured to
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Note : If a failure condition does occur when handling an Association then all images previously received successfully
over the Association are maintained in the DCM4CHEE archive database. No previously successfully received images
are discarded. Even if an image is successfully received but an error occurs transmitting the C-STORE Response then
this final image is maintained rather than discarded. If the loss of an Association is detected then the Association is
closed. In the above table, some references to rejection error codes in Refused Service Status is due to the fact that,
when objects are rejected the rejection notes are stored in the database for further processing.
The Behavior of STORAGE-SCP AE during communication failure is summarized in the following table:

Table 4.10: STORAGE-SCP AE Storage Service Communication Failure Reasons


Exception Reason
Timeout expiry for an expected DICOM Message The Association is aborted by issuing a DICOM
Request (DIMSE level timeout). I.e. The A-ABORT. Error message is output to the Service Log.
STORAGE-SCP AE is waiting for the next C-STORE If some Composite SOP Instances have already been
Request on an open Association but the timer expires. successfully received then they are maintained in the
database. They are not automatically discarded because
of a later failure.
Timeout expiry for an expected DICOM PDU or The Association is aborted by issuing a DICOM
TCP/IP packet (Low-level timeout). I.e. The A-ABORT. Error message is output to the Service Log.
STORAGE-SCP AE is waiting for the next C-STORE If a C-STORE Data Set has not been fully received
Data Set PDU but the timer expires. then the data already received is discarded. If some
Composite SOP Instances have already been
successfully received over the Association then they
are maintained in the database.
Association aborted by the SCU or the network layers Error message is output to the Service Log. If some
indicate communication loss (i.e., low-level TCP/IP Composite SOP Instances have already been
socket closure) successfully received then they are maintained in the
database. They are not automatically discarded because
of a later failure.

SOP Specific Conformance for Storage Commitment SOP Class

The associated Activity with the Storage Commitment Push Model service is the communication by the STORAGE-
SCP AE to peer AEs that it has committed to permanently store Composite SOP Instances that have been sent to it.
It thus allows peer AEs to determine whether the DCM4CHEE archive has taken responsibility for the archiving of
specific SOP Instances so that they can be flushed from the peer AE system. The STORAGE-SCP AE takes the list
of Composite SOP Instance UIDs specified in a Storage Commitment Push Model N-ACTION Request and checks if
they are present in the DCM4CHEE archive database. As long as the Composite SOP Instance UIDs are present in
the database, the STORAGE-SCP AE will consider those Composite SOP Instance UIDs to be successfully archived.
The STORAGE-SCP AE does not require the Composite SOP Instances to actually be successfully written to archive
media in order to commit to responsibility for maintaining these SOP Instances. Once the STORAGE-SCP AE has
checked for the existence of the specified Composite SOP Instances, it will then attempt to send the Notification request
(N-EVENT-REPORT-RQ). The default behavior is to attempt to send this Notification over the same Association that
was used by the peer AE to send the original N-ACTION Request. If the Association has already been released or
Message transfer fails for some reason then the STORAGE-SCP AE will attempt to send the N-EVENT-REPORT-
RQ over a new Association. The STORAGE-SCP AE will request a new Association with the peer AE that made
the original N-ACTION Request. The STORAGE-SCP AE can be configured to always open a new Association in
order to send the Notification request. The STORAGE-SCP AE will not cache Storage Commitment Push Model
N-ACTION Requests that specify Composite SOP Instances that have not yet been transferred to the DCM4CHEE
archive. If a peer AE sends a Storage Commitment Push Model N-ACTION Request before the specified Composite
SOP Instances are later sent over the same Association, the STORAGE-SCP AE will not commit to responsibility
for such SOP Instances. The STORAGE-SCP AE does not support the optional Storage Media File-Set ID & UID

32 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

attributes in the N-ACTION. The DCM4CHEE archive never automatically deletes Composite SOP Instances from
the archive. The absolute persistence of SOP Instances and the maximum archiving capacity for such SOP Instances
is dependent on the archiving media and capacity used by the DCM4CHEE archive and is dependent on the actual
specifications of the purchased system. It is necessary to check the actual system specifications to determine these
characteristics. The STORAGE-SCP AE will support Storage Commitment Push Model requests for SOP Instances of
any of the Storage SOP Classes that are also supported by the STORAGE-SCP AE as given in 4.2.1.1-1.: SOP Classes
for Storage Application Entity (SCP)
The STORAGE-SCP AE will return the following Status Code values in N-ACTION Responses:

Table 4.11: STORAGE-SCP AE Storage Commitment Push Model N-ACTION Response Status Return Behavior
Ser- Further Error Behaviour
vice Mean- Code
Status ing
Success Success 0000 The SCP has successfully received the Storage Commitment Push Model
N-ACTION Request and can process the commitment request for the indicated
SOP Instances.
Error Process- 0110 Indicates that the Storage Commitment Push Model N-ACTION Request cannot
ing be parsed or fully processed due to a database or system failure.
Failure
The STORAGE-SCP AE will exhibit the following Behavior according to the Status Code value returned in an N-
EVENT-REPORT Response from a destination Storage Commitment Push Model SCU:

Table 4.12: STORAGE-SCP AE N-EVENT-REPORT Response Status Handling Behavior


Service Status Further Meaning Error Code Behaviour
Success Success 0000 The SCU has success-
fully received the Storage
Commitment Push Model
N-EVENT-REPORT Re-
quest. Success indication
message is output to the
Service Logs. No mes-
sage is posted to the User
Interface.
Warning Attribute List Error 0107 Transmission of Storage
Commitment Push Model
N-EVENT-REPORT Re-
quest is considered suc-
cessful. Warning indica-
tion message is output to
the Service Logs. No
message is posted to the
User Interface.
Any other status code. This is treated as a perma-
nent Failure. Error indi-
cation message is output
to the Service Logs. No
message is posted to the
User Interface.
All Status Codes indicating an error or refusal are treated as a permanent failure. The STORAGE-SCP AE can be
configured to automatically reattempt the sending of Storage Commitment Push Model N-EVENT-REPORT Requests

4.2. AE Specifications 33
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

if an error Status Code is returned or a communication failure occurs. The maximum number of times to attempt
sending as well as the time to wait between attempts is configurable.

Query/Retrieve Application Entity Specification

SOP Classes

The Query/Retrieve Application Entity provides Standard Conformance to the following SOP Classes:

Table 4.13: SOP Classes for Query/Retrieve Application Entity

SOP Class Name SOP Class UID SCU SCP


Verification SOP Class 1.2.840.10008.1.1 Yes Yes
Patient Root Query/Retrieve Information Model - FIND 1.2.840.10008.5.1.4.1.2.1.1 No Yes
Patient Root Query/Retrieve Information Model - MOVE 1.2.840.10008.5.1.4.1.2.1.2 No Yes
Patient Root Query/Retrieve Information Model - GET 1.2.840.10008.5.1.4.1.2.1.3 No Yes
Study Root Query/Retrieve Information Model - FIND 1.2.840.10008.5.1.4.1.2.2.1 Yes Yes
Study Root Query/Retrieve Information Model - MOVE 1.2.840.10008.5.1.4.1.2.2.2 Yes Yes
Study Root Query/Retrieve Information Model - GET 1.2.840.10008.5.1.4.1.2.2.3 No Yes
Image Storage SOP Classes:
Computed Radiography Image Storage 1.2.840.10008.5.1.4.1.1.1 Yes No
Digital X-Ray Image Storage - For Presentation 1.2.840.10008.5.1.4.1.1.1.1 Yes No
Digital X-Ray Image Storage - For Processing 1.2.840.10008.5.1.4.1.1.1.1.1 Yes No
Digital Mammography X-Ray Image Storage - For Presentation 1.2.840.10008.5.1.4.1.1.1.2 Yes No
Digital Mammography X-Ray Image Storage - For Processing 1.2.840.10008.5.1.4.1.1.1.2.1 Yes No
Digital Intra-Oral X-Ray Image Storage - For Presentation 1.2.840.10008.5.1.4.1.1.1.3 Yes No
Digital Intra-Oral X-Ray Image Storage - For Processing 1.2.840.10008.5.1.4.1.1.1.3.1 Yes No
CT Image Storage 1.2.840.10008.5.1.4.1.1.2 Yes No
Enhanced CT Image Storage 1.2.840.10008.5.1.4.1.1.2.1 Yes No
Legacy Converted Enhanced CT Image Storage 1.2.840.10008.5.1.4.1.1.2.2 Yes No
Ultrasound Multi-frame Image Storage (Retired) 1.2.840.10008.5.1.4.1.1.3 Yes No
Ultrasound Multi-frame Image Storage 1.2.840.10008.5.1.4.1.1.3.1 Yes No
MR Image Storage 1.2.840.10008.5.1.4.1.1.4 Yes No
Enhanced MR Image Storage 1.2.840.10008.5.1.4.1.1.4.1 Yes No
Enhanced MR Color Image Storage 1.2.840.10008.5.1.4.1.1.4.3 Yes No
Legacy Converted Enhanced MR Image Storage 1.2.840.10008.5.1.4.1.1.4.4 Yes No
Nuclear Medicine Image Storage (Retired) 1.2.840.10008.5.1.4.1.1.5 Yes No
Ultrasound Image Storage (Retired) 1.2.840.10008.5.1.4.1.1.6 Yes No
Ultrasound Image Storage 1.2.840.10008.5.1.4.1.1.6.1 Yes No
Enhanced US Volume Storage 1.2.840.10008.5.1.4.1.1.6.2 Yes No
Secondary Capture Image Storage 1.2.840.10008.5.1.4.1.1.7 Yes No
Multi-frame Grayscale Byte Secondary Capture Image Storage 1.2.840.10008.5.1.4.1.1.7.2 Yes No
Multi-frame Grayscale Word Secondary Capture Image Storage 1.2.840.10008.5.1.4.1.1.7.3 Yes No
Multi-frame True Color Secondary Capture Image Storage 1.2.840.10008.5.1.4.1.1.7.4 Yes No
X-Ray Angiographic Image Storage 1.2.840.10008.5.1.4.1.1.12.1 Yes No
Enhanced XA Image Storage 1.2.840.10008.5.1.4.1.1.12.1.1 Yes No
X-Ray Radiofluoroscopic Image Storage 1.2.840.10008.5.1.4.1.1.12.2 Yes No
Enhanced XRF Image Storage 1.2.840.10008.5.1.4.1.1.12.2.1 Yes No
X-Ray Angiographic Bi-Plane Image Storage (Retired) 1.2.840.10008.5.1.4.1.1.12.3 Yes No
X-Ray 3D Angiographic Image Storage 1.2.840.10008.5.1.4.1.1.13.1.1 Yes No
X-Ray 3D Craniofacial Image Storage 1.2.840.10008.5.1.4.1.1.13.1.2 Yes No
Continued on next page

34 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.13 continued from previous page


SOP Class Name SOP Class UID SCU SCP
Breast Tomosynthesis Image Storage 1.2.840.10008.5.1.4.1.1.13.1.3 Yes No
Breast Projection X-Ray Image Storage - For Presentation 1.2.840.10008.5.1.4.1.1.13.1.4 Yes No
Breast Projection X-Ray Image Storage - For Processing 1.2.840.10008.5.1.4.1.1.13.1.5 Yes No
Intravascular Optical Coherence Tomography Image Storage - For Presentation 1.2.840.10008.5.1.4.1.1.14.1 Yes No
Intravascular Optical Coherence Tomography Image Storage - For Processing 1.2.840.10008.5.1.4.1.1.14.2 Yes No
Nuclear Medicine Image Storage 1.2.840.10008.5.1.4.1.1.20 Yes No
VL Image Storage - Trial (Retired) 1.2.840.10008.5.1.4.1.1.77.1 Yes No
VL Multi-frame Image Storage - Trial (Retired) 1.2.840.10008.5.1.4.1.1.77.2 Yes No
VL Endoscopic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.1 Yes No
VL Microscopic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.2 Yes No
VL Slide-Coordinates Microscopic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.3 Yes No
VL Photographic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.4 Yes No
Ophthalmic Photography 8 Bit Image Storage 1.2.840.10008.5.1.4.1.1.77.1.5.1 Yes No
Ophthalmic Photography 16 Bit Image Storage 1.2.840.10008.5.1.4.1.1.77.1.5.2 Yes No
Ophthalmic Tomography Image Storage 1.2.840.10008.5.1.4.1.1.77.1.5.4 Yes No
Wide Field Ophthalmic Photography Stereographic Projection Image Storage 1.2.840.10008.5.1.4.1.1.77.1.5.5 Yes No
Wide Field Ophthalmic Photography 3D Coordinates Image Storage 1.2.840.10008.5.1.4.1.1.77.1.5.6 Yes No
VL Whole Slide Microscopy Image Storage 1.2.840.10008.5.1.4.1.1.77.1.6 Yes No
Ophthalmic Thickness Map Storage 1.2.840.10008.5.1.4.1.1.81.1 Yes No
Corneal Topography Map Storage 1.2.840.10008.5.1.4.1.1.82.1 Yes No
Positron Emission Tomography Image Storage 1.2.840.10008.5.1.4.1.1.128 Yes No
Legacy Converted Enhanced PET Image Storage 1.2.840.10008.5.1.4.1.1.128.1 Yes No
Enhanced PET Image Storage 1.2.840.10008.5.1.4.1.1.130 Yes No
RT Image Storage 1.2.840.10008.5.1.4.1.1.481.1 Yes No
Private Fuji CR Image Storage 1.2.392.200036.9125.1.1.2 Yes No
Private GE Dicom CT Image Info Object 1.2.840.113619.4.3 Yes No
Private GE Dicom Display Image Info Object 1.2.840.113619.4.4 Yes No
Private GE Dicom MR Image Info Object 1.2.840.113619.4.2 Yes No
Private Philips CT Synthetic Image Storage 1.3.46.670589.5.0.9 Yes No
Private Philips CX Image Storage 1.3.46.670589.2.4.1.1 Yes No
Private Philips CX Synthetic Image Storage 1.3.46.670589.5.0.12 Yes No
Private Philips MR Color Image Storage 1.3.46.670589.11.0.0.12.3 Yes No
Private Philips MR Synthetic Image Storage 1.3.46.670589.5.0.10 Yes No
Private Philips Perfusion Image Storage 1.3.46.670589.5.0.14 Yes No
Private PixelMed Floating Point Image Storage 1.3.6.1.4.1.5962.301.9 Yes No
Private PixelMed Legacy Converted Enhanced CT Image Storage 1.3.6.1.4.1.5962.301.1 Yes No
Private PixelMed Legacy Converted Enhanced MR Image Storage 1.3.6.1.4.1.5962.301.2 Yes No
Private PixelMed Legacy Converted Enhanced PET Image Storage 1.3.6.1.4.1.5962.301.3 Yes No
Private PMOD Multi-frame Image Storage 2.16.840.1.114033.5.1.4.1.1.130 Yes No
Private Toshiba US Image Storage 1.2.392.200036.9116.7.8.1.1.1 Yes No
Video Storage SOP Classes:
Video Endoscopic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.1.1 Yes No
Video Microscopic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.2.1 Yes No
Video Photographic Image Storage 1.2.840.10008.5.1.4.1.1.77.1.4.1 Yes No
Structured Report Storage SOP Classes:
Spectacle Prescription Report Storage 1.2.840.10008.5.1.4.1.1.78.6 Yes No
Macular Grid Thickness and Volume Report Storage 1.2.840.10008.5.1.4.1.1.79.1 Yes No
Basic Text SR Storage 1.2.840.10008.5.1.4.1.1.88.11 Yes No
Enhanced SR Storage 1.2.840.10008.5.1.4.1.1.88.22 Yes No
Continued on next page

4.2. AE Specifications 35
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.13 continued from previous page


SOP Class Name SOP Class UID SCU SCP
Comprehensive SR Storage 1.2.840.10008.5.1.4.1.1.88.33 Yes No
Comprehensive 3D SR Storage 1.2.840.10008.5.1.4.1.1.88.34 Yes No
Extensible SR Storage 1.2.840.10008.5.1.4.1.1.88.35 Yes No
Procedure Log Storage 1.2.840.10008.5.1.4.1.1.88.40 Yes No
Mammography CAD SR Storage 1.2.840.10008.5.1.4.1.1.88.50 Yes No
Key Object Selection Document Storage 1.2.840.10008.5.1.4.1.1.88.59 Yes No
Chest CAD SR Storage 1.2.840.10008.5.1.4.1.1.88.65 Yes No
X-Ray Radiation Dose SR Storage 1.2.840.10008.5.1.4.1.1.88.67 Yes No
Radiopharmaceutical Radiation Dose SR Storage 1.2.840.10008.5.1.4.1.1.88.68 Yes No
Colon CAD SR Storage 1.2.840.10008.5.1.4.1.1.88.69 Yes No
Implantation Plan SR Storage 1.2.840.10008.5.1.4.1.1.88.70 Yes No
Acquisition Context SR Storage 1.2.840.10008.5.1.4.1.1.88.71 Yes No
Other Storage SOP Classes:
Stored Print Storage SOP Class (Retired) 1.2.840.10008.5.1.1.27 Yes No
Hardcopy Grayscale Image Storage SOP Class (Retired) 1.2.840.10008.5.1.1.29 Yes No
Hardcopy Color Image Storage SOP Class (Retired) 1.2.840.10008.5.1.1.30 Yes No
MR Spectroscopy Storage 1.2.840.10008.5.1.4.1.1.4.2 Yes No
Multi-frame Single Bit Secondary Capture Image Storage 1.2.840.10008.5.1.4.1.1.7.1 Yes No
Standalone Overlay Storage Retired 1.2.840.10008.5.1.4.1.1.8 Yes No
Standalone Curve Storage Retired 1.2.840.10008.5.1.4.1.1.9 Yes No
12-lead ECG Waveform Storage 1.2.840.10008.5.1.4.1.1.9.1.1 Yes No
General ECG Waveform Storage 1.2.840.10008.5.1.4.1.1.9.1.2 Yes No
Ambulatory ECG Waveform Storage 1.2.840.10008.5.1.4.1.1.9.1.3 Yes No
Hemodynamic Waveform Storage 1.2.840.10008.5.1.4.1.1.9.2.1 Yes No
Cardiac Electrophysiology Waveform Storage 1.2.840.10008.5.1.4.1.1.9.3.1 Yes No
Basic Voice Audio Waveform Storage 1.2.840.10008.5.1.4.1.1.9.4.1 Yes No
General Audio Waveform Storage 1.2.840.10008.5.1.4.1.1.9.4.2 Yes No
Arterial Pulse Waveform Storage 1.2.840.10008.5.1.4.1.1.9.5.1 Yes No
Respiratory Waveform Storage 1.2.840.10008.5.1.4.1.1.9.6.1 Yes No
Standalone Modality LUT Storage Retired 1.2.840.10008.5.1.4.1.1.10 Yes No
Standalone VOI LUT Storage Retired 1.2.840.10008.5.1.4.1.1.11 Yes No
Grayscale Softcopy Presentation State Storage SOP Class 1.2.840.10008.5.1.4.1.1.11.1 Yes No
Color Softcopy Presentation State Storage SOP Class 1.2.840.10008.5.1.4.1.1.11.2 Yes No
Pseudo-Color Softcopy Presentation State Storage SOP Class 1.2.840.10008.5.1.4.1.1.11.3 Yes No
Blending Softcopy Presentation State Storage SOP Class 1.2.840.10008.5.1.4.1.1.11.4 Yes No
XA/XRF Grayscale Softcopy Presentation State Storage 1.2.840.10008.5.1.4.1.1.11.5 Yes No
Grayscale Planar MPR Volumetric Presentation State Storage 1.2.840.10008.5.1.4.1.1.11.6 Yes No
Compositing Planar MPR Volumetric Presentation State Storage 1.2.840.10008.5.1.4.1.1.11.7 Yes No
Parametric Map Storage 1.2.840.10008.5.1.4.1.1.30 Yes No
Raw Data Storage 1.2.840.10008.5.1.4.1.1.66 Yes No
Spatial Registration Storage 1.2.840.10008.5.1.4.1.1.66.1 Yes No
Spatial Fiducials Storage 1.2.840.10008.5.1.4.1.1.66.2 Yes No
Deformable Spatial Registration Storage 1.2.840.10008.5.1.4.1.1.66.3 Yes No
Segmentation Storage 1.2.840.10008.5.1.4.1.1.66.4 Yes No
Surface Segmentation Storage 1.2.840.10008.5.1.4.1.1.66.5 Yes No
Tractography Results Storage 1.2.840.10008.5.1.4.1.1.66.6 Yes No
Real World Value Mapping Storage 1.2.840.10008.5.1.4.1.1.67 Yes No
Surface Scan Mesh Storage 1.2.840.10008.5.1.4.1.1.68.1 Yes No
Surface Scan Point Cloud Storage 1.2.840.10008.5.1.4.1.1.68.2 Yes No
Continued on next page

36 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.13 continued from previous page


SOP Class Name SOP Class UID SCU SCP
Stereometric Relationship Storage 1.2.840.10008.5.1.4.1.1.77.1.5.3 Yes No
Lensometry Measurements Storage 1.2.840.10008.5.1.4.1.1.78.1 Yes No
Autorefraction Measurements Storage 1.2.840.10008.5.1.4.1.1.78.2 Yes No
Keratometry Measurements Storage 1.2.840.10008.5.1.4.1.1.78.3 Yes No
Subjective Refraction Measurements Storage 1.2.840.10008.5.1.4.1.1.78.4 Yes No
Visual Acuity Measurements Storage 1.2.840.10008.5.1.4.1.1.78.5 Yes No
Ophthalmic Axial Measurements Storage 1.2.840.10008.5.1.4.1.1.78.7 Yes No
Intraocular Lens Calculations Storage 1.2.840.10008.5.1.4.1.1.78.8 Yes No
Ophthalmic Visual Field Static Perimetry Measurements Storage 1.2.840.10008.5.1.4.1.1.80.1 Yes No
BasicStructuredDisplayStorage 1.2.840.10008.5.1.4.1.1.131 Yes No
Encapsulated PDF Storage 1.2.840.10008.5.1.4.1.1.104.1 Yes No
Encapsulated CDA Storage 1.2.840.10008.5.1.4.1.1.104.2 Yes No
Standalone PET Curve Storage (Retired) 1.2.840.10008.5.1.4.1.1.129 Yes No
Text SR Storage Trial (Retired) 1.2.840.10008.5.1.4.1.1.88.1 Yes No
Audio SR Storage Trial (Retired) 1.2.840.10008.5.1.4.1.1.88.2 Yes No
Detail SR Storage Trial (Retired) 1.2.840.10008.5.1.4.1.1.88.3 Yes No
Comprehensive SR Storage Trial (Retired) 1.2.840.10008.5.1.4.1.1.88.4 Yes No
Content Assessment Results Storage 1.2.840.10008.5.1.4.1.1.90.1 Yes No
RT Dose Storage 1.2.840.10008.5.1.4.1.1.481.2 Yes No
RT Structure Set Storage 1.2.840.10008.5.1.4.1.1.481.3 Yes No
RT Beams Treatment Record Storage 1.2.840.10008.5.1.4.1.1.481.4 Yes No
RT Plan Storage 1.2.840.10008.5.1.4.1.1.481.5 Yes No
RT Brachy Treatment Record Storage 1.2.840.10008.5.1.4.1.1.481.6 Yes No
RT Treatment Summary Record Storage 1.2.840.10008.5.1.4.1.1.481.7 Yes No
RT Ion Plan Storage 1.2.840.10008.5.1.4.1.1.481.8 Yes No
RT Ion Beams Treatment Record Storage 1.2.840.10008.5.1.4.1.1.481.9 Yes No
RT Beams Delivery Instruction Storage 1.2.840.10008.5.1.4.34.7 Yes No
RT Brachy Application Setup Delivery Instruction Storage 1.2.840.10008.5.1.4.34.10 Yes No
Private Agfa Arrival Transaction 1.2.124.113532.3500.8.1 Yes No
Private Agfa Basic Attribute Presentation State 1.2.124.113532.3500.7 Yes No
Private Agfa Dictation Transaction 1.2.124.113532.3500.8.2 Yes No
Private Agfa Report Approval Transaction 1.2.124.113532.3500.8.4 Yes No
Private Agfa Report Transcription Transaction 1.2.124.113532.3500.8.3 Yes No
Private ERAD Practice Builder Report Dictation Storage 1.2.826.0.1.3680043.293.1.0.2 Yes No
Private ERAD Practice Builder Report Text Storage 1.2.826.0.1.3680043.293.1.0.1 Yes No
Private GE 3D Model Storage 1.2.840.113619.4.26 Yes No
Private GE Collage Storage 1.2.528.1.1001.5.1.1.1 Yes No
Private GE eNTEGRA Protocol or NM Genie Storage 1.2.840.113619.4.27 Yes No
Private GE PET Raw Data Storage 1.2.840.113619.4.30 Yes No
Private GE RT Plan Storage 1.2.840.113619.4.5.249 Yes No
Private Philips 3D Object Storage 1.3.46.670589.5.0.2.1 Yes No
Private Philips 3D Object Storage (Retired) 1.3.46.670589.5.0.2 Yes No
Private Philips 3D Presentation State Storage 1.3.46.670589.2.5.1.1 Yes No
Private Philips Composite Object Storage 1.3.46.670589.5.0.4 Yes No
Private Philips HP Live 3D 01 Storage 1.2.840.113543.6.6.1.3.10001 Yes No
Private Philips HP Live 3D 02 Storage 1.2.840.113543.6.6.1.3.10002 Yes No
Private Philips Live Run Storage 1.3.46.670589.7.8.1618510092 Yes No
Private Philips MR Cardio Analysis Storage 1.3.46.670589.5.0.11.1 Yes No
Private Philips MR Cardio Analysis Storage (Retired) 1.3.46.670589.5.0.11 Yes No
Continued on next page

4.2. AE Specifications 37
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.13 continued from previous page


SOP Class Name SOP Class UID SCU SCP
Private Philips MR Cardio Profile Storage 1.3.46.670589.5.0.7 Yes No
Private Philips MR Cardio Storage 1.3.46.670589.5.0.8.1 Yes No
Private Philips MR Cardio Storage (Retired) 1.3.46.670589.5.0.8 Yes No
Private Philips MR Examcard Storage 1.3.46.670589.11.0.0.12.4 Yes No
Private Philips MR Series Data Storage 1.3.46.670589.11.0.0.12.2 Yes No
Private Philips MR Spectrum Storage 1.3.46.670589.11.0.0.12.1 Yes No
Private Philips Perfusion Storage 1.3.46.670589.5.0.13 Yes No
Private Philips Reconstruction Storage 1.3.46.670589.7.8.16185100130 Yes No
Private Philips Run Storage 1.3.46.670589.7.8.16185100129 Yes No
Private Philips Specialised XA Storage 1.3.46.670589.2.3.1.1 Yes No
Private Philips Surface Storage 1.3.46.670589.5.0.3.1 Yes No
Private Philips Surface Storage (Retired) 1.3.46.670589.5.0.3 Yes No
Private Philips Volume Set Storage 1.3.46.670589.2.11.1.1 Yes No
Private Philips Volume Storage 1.3.46.670589.5.0.1.1 Yes No
Private Philips Volume Storage (Retired) 1.3.46.670589.5.0.1 Yes No
Private Philips VRML Storage 1.3.46.670589.2.8.1.1 Yes No
Private Philips X-Ray MF Storage 1.3.46.670589.7.8.1618510091 Yes No
Private Siemens AX Frame Sets Storage 1.3.12.2.1107.5.99.3.11 Yes No
Private Siemens CSA Non Image Storage 1.3.12.2.1107.5.9.1 Yes No
Private Siemens CT MR Volume Storage 1.3.12.2.1107.5.99.3.10 Yes No
Private TomTec Annotation Storage 1.2.276.0.48.5.1.4.1.1.7 Yes No

These are the default SOP Classes supported. By altering the configuration it is possible to support additional or fewer
SOP Classes.

Association Policies

General

The STORAGE-SCU AE can only form Associations when requested to do so by the DCM4CHEE SCP AE. The
STORAGE-SCU AE can only request the opening of an Association. It cannot accept requests to open Associations
from external Application Entities. The DCM4CHEE SCP AE will never initiate Associations; it only accepts As-
sociation Requests from external DICOM AEs. The DCM4CHEE SCP AE will accept Associations for Verification,
C-FIND, C-GET and C-MOVE requests. In the case of a C-MOVE/C-GET request, the DCM4CHEE SCP AE will
issue a command to the STORAGE-SCU AE to initiate an Association with the Destination DICOM AE to send
images as specified by the originator of the C-MOVE Request. In case of C-GET request the originator is itself the
destination. The DICOM standard Application Context Name for DICOM 3.0 is always proposed (Storage SCU) /
accepted (Query/Retrieve SCP).

Number Of Associations

The maximum number of simultaneous Associations is configurable, but is usually limited to a maximum of 10. This
configuration largely depends on whether relatively quick response to multiple simultaneous C-MOVE Destination
AEs is required or maximum throughput performance is required. If the latter is the case, then no simultaneous
Associations are permitted, in order to reduce disk thrashing and thus maximize throughput. The STORAGE-SCU
AE can initiate simultaneous Associations to a given external C-MOVE Destination AE up to the maximum number
configured. There is no separate limit on the maximum number permitted to the same C-MOVE Destination AE. If the
first attempt to open an Association fails then the STORAGE-SCU AE will reschedule the task to attempt it again after
a configurable time delay. The number of times to reattempt Association establishment is configurable, with the default

38 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

being zero. The DCM4CHEE SCP AE can support multiple simultaneous Associations. Each time the DCM4CHEE
SCP AE receives an Association, a child process will be spawned to process the Verification, Query, or Retrieval
request. The maximum number of child processes, and thus the maximum number of simultaneous Associations that
can be processed, is set by configuration. The default maximum is 10 in total. The maximum number of simultaneous
Associations can be either an absolute number or a maximum number for each requesting external Application Entity.
The latter flexibility can be useful if communication with one external AE is unreliable and one does not wish hung
connections with this AE to prevent Associations with other client AEs.

Table 4.14: Number of Associations as a SCU for STORAGE-SCU AE /


SCP for Query-Retrieve SCP AE
Maximum number of simultaneous Associations 10 (Configurable)

Asynchronous Nature

The Storage SCU AE and Query/Retrieve SCP AE do not support asynchronous communication (multiple outstanding
transactions over a single Association). All Association requests must be completed and acknowledged before a new
operation can be initiated.

Table 4.15: Asynchronous Nature as a SCU for STORAGE-SCU AE / SCP for Query-
Retrieve SCP AE
Maximum number of outstanding asynchronous transactions 1 (Not Configurable)

Implementation Identifying Information

The implementation information for the Application Entity is:


Note that the STORAGE-SCU AE and Query/Retrieve SCP AE use the same Implementation Class UID. All
DCM4CHEE archive AEs use the same Implementation Version Name. This Version Name is updated with each
new release of the product software, as the different AE versions are never released independently.

Association Initiation Policy

Activity - Send Images Requested By an External Peer AE

Description and Sequencing of Activity

The Storage SCU AE will initiate a new Association when the Query/Retrieve SCP AE invokes the Storage SCU AE
to transmit images. The Query/Retrieve SCP AE will issue such a command whenever it receives a valid C-MOVE
Request. An Association Request is sent to the specified C-MOVE Destination AE and upon successful negotiation of
the required Presentation Context the image transfer is started. In all cases an attempt will be made to transmit all the
indicated images in a single Association, but this may not always be possible. The Association will be released when
all the images have been sent. If an error occurs during transmission over an open Association then the image transfer
is halted. The Storage SCU AE will not attempt to independently retry the image export. Note that the Storage SCU
AE does not support the unsolicited sending of SOP Instances using the DICOM Storage Service Class. It will only
send SOP Instances in response to a C-MOVE Request from a peer AE.

Fig. 4.10: Figure : Sequencing of Activity - Send Images Requested By an External Peer AE

4.2. AE Specifications 39
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

The following sequencing constraints illustrated in figure above apply to the Storage SCU AE:
1. Peer AE requests retrieval of Study, Series, or Images from Query/Retrieve SCP AE (C-MOVE-RQ).
2. Query/Retrieve SCP AE signals Storage SCU AE to send the image Composite SOP Instances indicated in the
C-MOVE-RQ to the C-MOVE Destination AE.
3. Storage SCU AE opens a new Association with the indicated C-MOVE Destination AE.
4. Storage SCU AE sends the indicated Composite SOP Instances.
5. Storage SCU AE closes the Association.
6. The Verification Service is only supported as a utility function for Service staff. It is used only as a diagnostic
tool.

Proposed Presentation Contexts

The Query/Retrieve Application Entity will propose Presentation Contexts for Verification, Study Root Query/Retrieve
Information Model - FIND, Study Root Query/Retrieve Information Model - MOVE and of supported Storage SOP
Classes.

40 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.16: Proposed Presentation Contexts by the Query/Retrieve Application Entity


Presentation Context Table
Abstract Syntax Transfer Syntax
Role Ext. Neg.
UID Name UID
Name

1.2.840.10008.1.1 Implicit VR Lit- 1.2.840.10008.1.2 SCU None


tle Endian
Verification

1.2.840.10008.5.1.4.1.2.2.1
Implicit VR Lit- 1.2.840.10008.1.2 SCU None
tle Endian
Study Root
Query/Retrieve
Information
Model - FIND

1.2.840.10008.5.1.4.1.2.2.2
Implicit VR Lit- 1.2.840.10008.1.2 SCU None
tle Endian
Study Root
Query/Retrieve
Information
Model - MOVE

Image Storage SOP Class in Table 4.13 Table 4.17 SCU None
Video Storage SOP Class in Table 4.13 Table 4.18 SCU None
Implicit VR Lit- 1.2.840.10008.1.2
SR Storage SOP Class in Table 4.13 tle Endian SCU None
Explicit VR Lit- 1.2.840.10008.1.2.1
tle Endian
Deflated Ex- 1.2.840.10008.1.2.1.99
plicit VR Little
Endian
Implicit VR Lit- 1.2.840.10008.1.2
Other Storage SOP Class in Table 4.13 SCU None
tle Endian
Explicit VR Lit- 1.2.840.10008.1.2.1
tle Endian

Table 4.17: Transfer Syntaxes for Image Storage SOP Classes


Transfer Syntax Name UID
Implicit VR Little Endian 1.2.840.10008.1.2
Explicit VR Little Endian 1.2.840.10008.1.2.1
JPEG Baseline (Process 1) 1.2.840.10008.1.2.4.50
JPEG Extended (Process 2 & 4) 1.2.840.10008.1.2.4.51
JPEG Lossless, Non-Hierarchical (Process 14) 1.2.840.10008.1.2.4.54
JPEG Lossless, Non-Hierarchical, First-Order Prediction (Process 14 [Selection Value 1.2.840.10008.1.2.4.70
1])
JPEG-LS Lossless 1.2.840.10008.1.2.4.80
JPEG-LS Lossy (Near-Lossless) 1.2.840.10008.1.2.4.81
JPEG 2000 (Lossless Only) 1.2.840.10008.1.2.4.90
JPEG 2000 1.2.840.10008.1.2.4.91
RLE Lossless 1.2.840.10008.1.2.5

4.2. AE Specifications 41
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.18: Transfer Syntax for Video Storage SOP Classes


Transfer Syntax Name UID
JPEG Baseline (Process 1) 1.2.840.10008.1.2.4.50
MPEG2 Main Profile @ Main Level 1.2.840.10008.1.2.4.100
MPEG2 Main Profile @ High Level 1.2.840.10008.1.2.4.101
MPEG-4 AVC/H.264 High Profile / Level 4.1 1.2.840.10008.1.2.4.102
MPEG-4 AVC/H.264 BD-compatible High Profile / Level 4.1 1.2.840.10008.1.2.4.103
MPEG-4 AVC/H.264 High Profile / Level 4.2 For 2D Video 1.2.840.10008.1.2.4.104
MPEG-4 AVC/H.264 High Profile / Level 4.2 For 3D Video 1.2.840.10008.1.2.4.105
MPEG-4 AVC/H.264 Stereo High Profile / Level 4.2 1.2.840.10008.1.2.4.106

SOP Specific Conformance for Verification SOP Class

Standard conformance is provided to the DICOM Verification Service Class as an SCU. The Verification Service as
an SCU is actually only supported as a diagnostic service tool for network communication issues.

SOP Specific Conformance for Image SOP Classes

Composite DICOM SOP Instances are maintained as DICOM Part 10 compliant files in the DCM4CHEE archive
database. The entire set of tags received with the image will be saved in DCM4CHEE archive; this includes all Private
and SOP Extended Elements. When a SOP Instance is selected for export from DCM4CHEE archive, its content
will be exported as it was originally received except for a few possible exceptions. Some of the Patient demographic
and Study information Elements whose values can have been altered due to changes administered on DCM4CHEE
archive or changes to the state of the image data due to compression can be altered when the SOP Instance is exported.
The Patient demographic and Study information can be entered or altered by several means: manually, or from HL7
messaging,. The replacement behavior depends on which specific DICOM and HL7 services are supported. Also,
this behavior is configurable. Values can be altered without changing the SOP Instance UID unless otherwise noted.
Refer to the Annex for the specific details of which Elements can have their values altered at time of export. The
DCM4CHEE archive creates files called Service Logs that can be used to monitor their status and diagnose any
problems that may arise. If any error occurs during DICOM communication then appropriate messages are always
output to these Service Logs. In addition, error messages may be output as alerts to the User Interface in certain cases.
The Storage SCU AE will exhibit the following Behavior according to the Status Code value returned in a C-STORE
Response from a destination C-STORE SCP:

42 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.19: STORAGE-SCU AE C-STORE Response Status Handling Behavior


Service Status Further Meaning Error Code Behaviour
Success Success 0000 The SCP has successfully
stored the exported SOP
Instance. A message
is sent to the QUERY-
RETRIEVE-SCP AE
indicating successful
export. The QUERY-
RETRIEVE-SCP AE
will send the appropriate
PENDING or SUCCESS
Status in the C-MOVE
Response. Success indi-
cation message is output
to the Service Logs. No
message is posted to the
User Interface.
Refused Out of Resources A700 - A7FF This is treated as a perma-
nent Failure. A message
is sent to the QUERY-
RETRIEVE-SCP AE in-
dicating an export fail-
ure and the Association is
released. The QUERY-
RETRIEVE-SCP AE will
send an appropriate Sta-
tus in the C-MOVE Re-
sponse. Error indication
message is output to the
Service Logs. No mes-
sage is posted to the User
Interface.
Error Data Set does not match A900 - A9FF This is treated as a perma-
SOP Class nent Failure. A message
is sent to the QUERY-
RETRIEVE-SCP AE in-
dicating an export fail-
ure and the Association is
released. The QUERY-
RETRIEVE-SCP AE will
send an appropriate Sta-
tus in the C-MOVE Re-
sponse. Error indication
message is output to the
Service Logs. No mes-
sage is posted to the User
Interface.
Error Cannot Understand C000 - CFFF This is treated as a perma-
nent Failure. A message
is sent to the QUERY-
RETRIEVE-SCP AE in-
dicating an export fail-
ure and the Association is
4.2. AE Specifications released. The QUERY-43
RETRIEVE-SCP AE will
send an appropriate Sta-
tus in the C-MOVE Re-
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

All Status Codes indicating an error or refusal are treated as a permanent failure. The STORAGE-SCU AE never
automatically resends images when an error Status Code is returned in a C-STORE Response. For specific behavior
regarding Status Code values returned in C-MOVE Responses, refer to the Services Supported as an SCP by the
DCM4CHEE SCP AE.

Table 4.20: STORAGE-SCU AE Communication Failure Behavior


Exception Behaviour
Timeout expiry for an expected DICOM The Association is aborted using a DICOM A-ABORT and a
Message Response (DIMSE level timeout). message is sent to the QUERY-RETRIEVE-SCP AE indicating
an export failure. The QUERY-RETRIEVE-SCP AE will send
an appropriate Status in the C-MOVE Response. Error
indication message is output to the Service Logs. No message
is posted to the User Interface.
Timeout expiry for an expected DICOM PDU The Association is aborted using a DICOM A-ABORT and a
or TCP/IP packet (Low-level timeout). message is sent to the QUERY-RETRIEVE-SCP AE indicating
an export failure. The QUERY-RETRIEVE-SCP AE will send
an appropriate Status in the C-MOVE Response. Error
indication message is output to the Service Logs. No message
is posted to the User Interface.
Association A-ABORTed by the SCP or the A message is sent to the QUERY-RETRIEVE-SCP AE
network layers indicate communication loss indicating an export failure. The QUERY-RETRIEVE-SCP AE
(i.e., low-level TCP/IP socket closure) will send an appropriate Status in the C-MOVE Response.
Error indication message is output to the Service Logs. No
message is posted to the User Interface.

Association Acceptance Policy

Activity - Handling Query and Retrieval Requests

Description and Sequencing of Activity

The Query/Retrieve SCP AE accepts Associations only if they have valid Presentation Contexts. If none of the re-
quested Presentation Contexts are accepted then the Association Request itself is rejected. It can be configured to only
accept Associations with certain hosts (using TCP/IP address) and/or Application Entity Titles. If Query/Retrieve SCP
AE receives a query (C-FIND) request then the response(s) will be sent over the same Association used to send the C-
FIND-Request. If Query/Retrieve SCP AE receives a retrieval (C-MOVE) request then the responses will be sent over
the same Association used to send the C-MOVE-Request. The Query/Retrieve SCP AE will notify the Storage SCU
to send the requested SOP Instances to the C-MOVE Destination. The Storage SCU AE notifies the Query/Retrieve
SCP AE of the success or failure of each attempt to send a Composite SOP Instance to the peer C-MOVE Destination
AE. The Query/Retrieve SCP AE then sends a C-MOVE Response indicating this status after each attempt. Once
the Storage SCU AE has finished attempting to transfer all the requested SOP Instances, the Query/Retrieve SCP AE
sends a final C-MOVE Response indicating the overall status of the attempted retrieval.

Fig. 4.11: Figure : Sequencing of Activity - Handling Query and Retrieval Requests

The following sequencing constraints illustrated in above figure apply to the DCM4CHEE SCP AE for handling
queries (C-FIND-Requests) :
1. Peer AE opens an Association with the Query/Retrieve SCP AE.
2. Peer AE sends a C-FIND-RQ Message

44 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

3. Query/Retrieve SCP AE returns a C-FIND-RSP Message to the peer AE with matching information. A C-FIND-
RSP is sent for each entity matching the identifier specified in the C-FIND-RQ. A final C-FIND-RSP is sent
indicating that the matching is complete.
4. Peer AE closes the Association. Note that the peer AE does not have to close the Association immediately.
Further C-FIND or C-MOVE Requests can be sent over the Association before it is closed.
The following sequencing constraints illustrated in above figure apply to the DCM4CHEE SCP AE for handling
retrievals (C-MOVE-Requests) :
1. Peer AE opens an Association with the Query/Retrieve SCP AE.
2. Peer AE sends a C-MOVE-RQ Message
3. Query/Retrieve SCP AE notifies the Storage SCU AE to send the Composite SOP Instances to the peer C-MOVE
Destination AE as indicated in the C-MOVE-RQ.
4. After attempting to send a SOP Instance, the Storage SCU AE indicates to the Query/Retrieve SCP AE whether
the transfer succeeded or failed. The Query/Retrieve SCP AE then returns a C-MOVE-RSP indicating this
success or failure.
5. Once the Storage SCU AE has completed all attempts to transfer the SOP Instances to the C-MOVE Destination
AE, or the first failure occurred, the Query/Retrieve SCP AE sends a final C-MOVE-RSP indicating the overall
success or failure of the retrieval.
6. Peer AE closes the Association. Note that the peer AE does not have to close the Association immediately.
Further C-FIND or C-MOVE Requests can be sent over the Association before it is closed.
The Query/Retrieve SCP AE may reject Association attempts as shown in the table below. The Result, Source and
Reason/Diag columns represent the values returned in the corresponding fields of an ASSOCIATE-RJ PDU. The
following abbreviations are used in the Source column:
1. 1 - DICOM UL service-user
2. 2 - DICOM UL service-provider (ASCE related function)
3. 3 - DICOM UL service-provider (Presentation related function)

Accepted Presentation Contexts

The Query/Retrieve Application Entity will accept Presentation Contexts for all SOP Classes listed in Table 4.2.1.1-1
by default. The list of accepted Transfer Syntaxes for each accepted Abstract Syntax - as the list of accepted Abstract
Syntaxes itselfs - is configurable.

SOP Specific Conformance for Query SOP Classes

The Query/Retrieve SCP AE supports hierarchical queries and not relational queries. There are no attributes always
returned by default. Only those attributes requested in the query identifier are returned. Query responses always return
values from the DCM4CHEE archive database. Exported SOP Instances are always updated with the latest values in
the database prior to export. Thus, a change in Patient demographic information will be contained in both the C-FIND
Responses and any Composite SOP Instances exported to a C-MOVE Destination AE. Patient Root Information Model
All required search keys on each of the four levels (Patient, Study, Series, and Image) are supported. However, the
Patient ID (0010,0020) key must have at least a partial value if the Patients Name (0010,0010) is not present in a
Patient Level query. Study Root Information Model All the required search keys on each of the three levels (Study,
Series, and Image) are supported. If no partial values are specified for Study attributes then either the Patient ID
(0010,0020) key or the Patients Name (0010,0010) must have at least a partial value specified.

4.2. AE Specifications 45
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.21: Patient Root C-FIND SCP Supported Elements


Level Name/Attribute Name Tag VR Types of Matching
SOP Common
Specific Character Set 0008,0005 CS NONE
Patient Level
Patients Name 0010,0010 PN S,*,U
Patient ID 0010,0020 LO S,*,U
Patients Birth Date 0010,0030 DA S,U
Patients Sex 0010,0040 CS S,U
Other Patient IDs 0010,1000 LO NONE
Other Patient Names 0010,1001 PN NONE
Study Level
Study Date 0008,0020 DA S,*,U,R
Study Time 0008,0030 TM U,R
Accession Number 0008,0050 SH S,*,U
Study ID 0020,0010 SH S,*,U
Study Instance UID 0020,000D SH S,U,L
Referring Physicians Name 0008,0090 PN S,*,U
Study Description 0008,1030 LO S,*,U
Series Level
Modality 0008,0060 CS S,*,U
SeriesNumber 0020,0011 IS S,*,U
SeriesInstanceUID 0020,000E UI S,U,L
Operators Name 0008,1070 PN NONE
Image Level
Instance Number 0020,0013 IS S,*,U
SOP Instance UID 0008,0018 UI S,U,L

46 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.22: Study Root C-FIND SCP Supported Elements


Level Name/Attribute Name Tag VR Types of Matching
SOP Common
Specific Character Set 0008,0005 CS NONE
Study Level
Patients Name 0010,0010 PN S,*,U
Patient ID 0010,0020 LO S,*,U
Patients Birth Date 0010,0030 DA S,U
Patients Sex 0010,0040 CS S,U
Other Patient IDs 0010,1000 LO NONE
Other Patient Names 0010,1001 PN NONE
Study Date 0008,0020 DA S,*,U,R
Study Time 0008,0030 TM U,R
Accession Number 0008,0050 SH S,*,U
Study ID 0020,0010 SH S,*,U
Study Instance UID 0020,000D SH S,U,L
Referring Physicians Name 0008,0090 PN S,*,U
Study Description 0008,1030 LO S,*,U
Series Level
Modality 0008,0060 CS S,*,U
SeriesNumber 0020,0011 IS S,*,U
SeriesInstanceUID 0020,000E UI S,U,L
Operators Name 0008,1070 PN NONE
Image Level
Instance Number 0020,0013 IS S,*,U
SOP Instance UID 0008,0018 UI S,U,L
The tables should be read as follows:
Attribute Name: Attributes supported for returned C-FIND Responses.
Tag: Appropriate DICOM tag for this attribute.
VR: Appropriate DICOM VR for this attribute.
Types of Matching: The types of Matching supported by the C-FIND SCP.
The values in Types of Matching column mean as follows :
S indicates the identifier attribute can specify Single Value Matching.
R will indicate Range Matching.
* will denote wild card matching.
U will indicate universal matching.
L will indicate that UID lists are supported for matching.
NONE indicates that no matching is supported, but that values for this Element in the database can be returned.

4.2. AE Specifications 47
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.23: Query/Retrieve SCP AE C-FIND Response Status Return Behavior


Ser- Further Meaning Er- Behaviour
vice ror
Sta- Code
tus
Suc- Success 0000 Matching is complete. No final identifier is supplied.
cess
Re- Out of Resources A700 System reached the limit in disk space or memory usage. Error
fused message is output to as an alert to the User Interface, and to the
Service Log.
Failed Identifier does not match A900 The C-FIND query identifier contains invalid Elements or
SOP Class values, or is missing mandatory Elements or values for the
specified SOP Class. Error message is output to the Service Log.
Unable to process C001 The C-FIND query identifier is valid for the specified SOP Class
but cannot be used to query the database. For example, this can
occur if a Patient Level query is issued but the identifier has only
empty values for both the Patient ID and the Patient Name. Error
message is output to the Service Log.
Can- Matching terminated due to FE00 The C-FIND SCU sent a Cancel Request. This has been
cel Cancel Request acknowledged and the search for matches has been halted.
Pend- Matches are continuing and FF00 Indicates that the search for further matches is continuing. This
ing current match is supplied. is returned when each successful match is returned and when
further matches are forthcoming. This status code is returned if
all Optional keys in the query identifier are actually supported.
Matches are continuing but FF01 Indicates that the search for further matches is continuing. This
one or more Optional Keys is returned when each successful match is returned and when
were not supported. further matches are forthcoming. This status code is returned if
there are Optional keys in the query identifier that are not
supported.

SOP Specific Conformance for Retrieval SOP Classes

The Query/Retrieve SCP AE will convey to the Storage SCU AE that an Association with a DICOM Application
Entity named by the external C-MOVE SCU (through a MOVE Destination AE Title) should be established. It will
also convey to the Storage SCU AE to perform C-STORE operations on specific images requested by the external
C-MOVE SCU. One or more of the Image Storage Presentation Contexts listed in Table 4.2.2.3-1. will be negotiated.
The Query/Retrieve SCP AE can support lists of UIDs in the C-MOVE Request at the Study, Series, and Image Levels.
The list of UIDs must be at the Level of the C-MOVE Request however. For example, if the C-MOVE Request is for
Series Level retrieval but the identifier contains a list of Study UIDs then the C-MOVE Request will be rejected, and
the A900 Failed Status Code will be returned in the C-MOVE Response. An initial C-MOVE Response is always sent
after confirming that the C-MOVE Request itself can be processed. After this, the Query/Retrieve SCP AE will return
a response to the C-MOVE SCU after the Storage SCU AE has attempted to send each image. This response reports
the number of remaining SOP Instances to transfer, and the number transferred having a successful, failed, or warning
status. If the Composite SOP Instances must be retrieved from long-term archive prior to export there may be quite
a long delay between the first C-MOVE Response and the next one after the attempt to export the first image. The
maximum length of time for this delay will depend on the particular type of archive used but typically varies between
3 and 10 minutes.
Note that the Warning Status, B000 (Sub-operations complete - One or more Failures) is never returned. If a failure
occurs during export to the C-MOVE Destination AE by the STORAGE-SCU AE then the entire task is aborted. Thus
any remaining matches are not exported.

48 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.24: Query/Retrieve SCP AE Communication Failure Behavior


Exception Behaviour
Timeout expiry for an expected DICOM Message The Association is aborted by issuing a DICOM
Request (DIMSE level timeout). I.e. The A-ABORT. Error message is output to the Service Log.
QUERY-RETRIEVE-SCP AE is waiting for the next If the STORAGE-SCU AE is still exporting Composite
C-FIND or C-MOVE Request on an open Association SOP Instances as a result of an earlier C-MOVE
but the timer expires. Request received on this Association, it will continue
attempting to complete the entire C-MOVE Request.
Timeout expiry for an expected DICOM PDU or The Association is aborted by issuing a DICOM
TCP/IP packet (Low-level timeout). I.e. The A-ABORT. Error message is output to the Service Log.
QUERY-RETRIEVE-SCP AE is waiting for the next If the STORAGE-SCU AE is still exporting Composite
message PDU but the timer expires. SOP Instances as a result of an earlier C-MOVE
Request received on this Association, it will continue
attempting to complete the entire C-MOVE Request.
Association aborted by the SCU or the network layers Error message is output to the Service Log. If the
indicate communication loss (i.e., low-level TCP/IP STORAGE-SCU AE is still exporting Composite SOP
socket closure) Instances as a result of an earlier C-MOVE Request
received on this Association, it will continue
attempting to complete the entire C-MOVE Request.

Workflow Application Entity Specification

SOP Classes

The Workflow Application Entity provides Standard Conformance to the following SOP Class(es) :

Table 4.25: SOP Classes for Workflow Application Entity (SCP)


SOP Class Name SOP Class UID SCU SCP
Modality Performed Procedure Step 1.2.840.10008.3.1.2.3.3 Yes Yes
Instance Availability Notification 1.2.840.10008.5.1.4.33 Yes No
Modality Worklist 1.2.840.10008.5.1.4.31 No Yes

Association Policies

General

The DICOM standard application context name for DICOM 3.0 is always proposed:

Number of Associations

The Workflow AE initiates one Association at a time for a Worklist request.

Table 4.26: Number of Associations Initiated for AE


Workflow
Maximum number of simultaneous Associations 1

4.2. AE Specifications 49
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Asynchronous Nature

The Workflow AE does not support asynchronous communication (multiple outstanding transactions over a single
Association).

Table 4.27: Asynchronous Nature as a SCU for STORAGE-SCU AE


Maximum number of outstanding asynchronous transactions 1

Implementation Identifying Information

The implementation information for this Application Entity is:

Table 4.28: DICOM Implementation Class and Version for AE


Workflow
Implementation Class UID 1.xxxxxxx.yyy.etc.ad.inf.usw
Implementation Version Name EXINTMOD_01

Association Initiation Policies

Activity - Worklist Update

Description and Sequencing of Activities

The request for a Worklist Update is initiated by user interaction, i.e., pressing the buttons Worklist Update/Patient
Worklist Query or automatically at specific time intervals, configurable by the user. With Worklist Update the
automated query mechanism is performed immediately on request, while with Patient Worklist Query a dialog to
enter search criteria is opened and an interactive query can be performed. The interactive Patient Worklist Query will
display a dialog for entering data as search criteria. When the Query is started on user request, only the data from
the dialog will be inserted as matching keys into the query. With automated worklist queries (including Worklist
Update) the Worklist Application Entity always requests all items for a Scheduled Procedure Step Start Date (actual
date), Modality (RF) and Scheduled Station AE Title. Query for the Scheduled Station AE Title is configurable by
a Service Engineer. Upon initiation of the request, the Worklist Application Entity will build an Identifier for the
C-FIND request, will initiate an Association to send the request and will wait for Worklist responses. After retrieval of
all responses, Worklist Application Entity will access the local database to add or update patient demographic data. To
protect the system from overflow, the Worklist Application Entity will limit the number of processed worklist responses
to a configurable maximum. During receiving the worklist response items are counted and the query processing is
canceled by issuing a C-FIND-CANCEL if the configurable limit of items is reached. The results will be displayed
in a separate list, which will be cleared with the next worklist update. Worklist Application Entity will initiate an
Association in order to issue a C-FIND request according to the Modality Worklist Information Model.

Fig. 4.12: Figure : Sequencing of Activity - Worklist Update

A possible sequence of interactions between the Workflow AE and a Departmental Scheduler (e.g., a device such as a
RIS or HIS that supports the Modality Worklist SOP Class as an SCP) is illustrated in the Figure above:
1. The Worklist AE opens an association with the Departmental Scheduler
2. The Worklist AE sends a C-FIND request to the Departmental Scheduler containing the Worklist Query at-
tributes.

50 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

3. The Departmental Scheduler returns a C-FIND response containing the requested attributes of the first matching
Worklist Item.
4. The Departmental Scheduler returns another C-FIND response containing the requested attributes of the second
matching Worklist Item. 5. The Departmental Scheduler returns another C-FIND response with status Success in-
dicating that no further matching Worklist Items exist. This example assumes that only 2 Worklist items match the
Worklist Query. 6. The Worklist AE closes the association with the Departmental Scheduler. 7. The user selects a
Worklist Item from the Worklist and prepares to acquire new images.
After Patient registration, the Modality is awaiting the 1st application of X-Ray Dose to the patient. The trigger to
create a MPPS SOP Instance is derived from this event. An Association to the configured MPPS SCP system is estab-
lished immediately and the related MPPS SOP Instance will be created. A manual update can be performed with the
MPPS user interface where is it possible to set the final state of the MPPS to COMPLETED or DISCONTINUED.
In the Discontinued case the user can also select the discontinuation reason. A MPPS Instance that has been sent
with a state of COMPLETED or DISCONTINUED can no longer be updated. The Modality will support creation
of unscheduled cases by allowing MPPS Instances to be communicated for locally registered Patients. The Modality
only supports a 0-to-1 relationship between Scheduled and Performed Procedure Steps. The Modality will initiate an
Association to issue an:
1. N-CREATE request according to the CREATE Modality Performed Procedure Step SOP Instance operation or
a
2. N-SET request to update the contents and state of the MPPS according to the SET Modality Performed Proce-
dure Step Information operation.

Fig. 4.13: Figure : Sequencing of Activity - Acquire Images

A possible sequence of interactions between the Workflow AE and a Departmental Scheduler (e.g., a device such as a
RIS or HIS that supports the MPPS SOP Class as an SCP) is illustrated in above figure.
1. The Worklist AE opens an association with the Departmental Scheduler
2. The Worklist AE sends an N-CREATE request to the Departmental Scheduler to create an MPPS instance with
status of IN PROGRESS and create all necessary attributes. The Departmental Scheduler acknowledges the
MPPS creation with an N-CREATE response (status success).
3. The Worklist AE closes the association with the Departmental Scheduler.
4. All images are acquired and stored in the local database.
5. The Worklist AE opens an association with the Departmental Scheduler.
6. The Worklist AE sends an N-SET request to the Departmental Scheduler to update the MPPS instance with
status of COMPLETED and set all necessary attributes. The Departmental Scheduler acknowledges the MPPS
update with an N-SET response (status success).
7. The Worklist AE closes the association with the Departmental Scheduler.

Proposed Presentation Contexts

The Workflow AE will propose Presentation Contexts as shown in the following table:

4.2. AE Specifications 51
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Presentation Context Table


Abstract Syntax Transfer Syntax
Role Extended Negotiation
Name UID Name UID
DICOM Im- 1.2.840.10008.1.2 SCU
Modality Performed1.2.840.10008.3.1.2.3.3
Procedure Step None
plicit VR Little
Endian SCP
DICOM Ex- 1.2.840.10008.1.2.1
plicit VR Little
Endian
DICOM Im- 1.2.840.10008.1.2
Modality Worklist 1.2.840.10008.5.1.4.31 SCP None
plicit VR Little
Endian
DICOM Ex- 1.2.840.10008.1.2.1
plicit VR Little
Endian
DICOM Im- 1.2.840.10008.1.2
Instance Availability1.2.840.10008.5.1.4.33
Notification SCU None
plicit VR Little
Endian
DICOM Ex- 1.2.840.10008.1.2.1
plicit VR Little
Endian

SOP Specific Conformance

The behavior of modality worklist when encountering status codes in a Modality Worklist C-FIND response is sum-
marized in the Table below. If any other SCP response status than Success or Pending is received by modality
worklist, a message query failed will appear on the user interface.

52 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.29: Modality Worklist C-FIND Response Status Handling Behavior


Service Status Further Meaning Error Code Behaviour
Success Matching is complete 0000 The SCP has completed
the matches. Worklist
items are available for dis-
play or further processing.
Refused Out of Resources A700 The Association is
aborted using A-ABORT
and the worklist query
is marked as failed. The
status meaning is logged
and reported to the user if
an interactive query. Any
additional error informa-
tion in the Response will
be logged.
Failed Identifier does not match A900 The Association is
SOP Class aborted using A-ABORT
and the worklist query
is marked as failed. The
status meaning is logged
and reported to the user if
an interactive query. Any
additional information
in the Response will be
logged.
Failed Unable to Process C000 - CFFF The Association is
aborted using A-ABORT
and the worklist query
is marked as failed. The
status meaning is logged
and reported to the user if
an interactive query. Any
additional information
in the Response will be
logged.
Cancel Matching terminated due FE00 If the query was canceled
to Cancel request due to too many worklist
items then the SCP has
completed the matches.
Worklist items are avail-
able for display or fur-
ther processing. Other-
wise, the Association is
aborted using A-ABORT
and the worklist query is
marked as failed. The sta-
tus meaning is logged and
reported to the user if an
interactive query.
Pending Matches are continuing FF00 The worklist item con-
tained in the Identifier is
collected for later display
or further processing.
Pending
4.2. AE Specifications Matches are continuing - FF01 The worklist item con-53
Warning that one or more tained in the Identifier is
Optional Keys were not collected for later display
supported or further processing. The
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

The behavior when encountering status codes in an MPPS N-CREATE or N-SET response is summarized in table
below. If any other SCP response status than Success or Warning is received, a message MPPS update failed
will appear on the user interface.

Table 4.30: MPPS N-CREATE / N-SET Response Status Handling Behavior


Service Status Further Meaning Error Code Behaviour
Success Success 0000 The SCP has completed
the operation successfully.
Failure Processing Failure - Per- 0110 The Association is
formed Procedure Step aborted using A-ABORT
Object may no longer be and the MPPS is marked
updated as failed. The status
meaning is logged and
reported to the user. Ad-
ditional information in the
Response will be logged
(i.e., Error Comment and
Error ID).
Duplicate SOP instance 0111 the new managed SOP
Instance Value supplied
by the invoking DIMSE-
service-user was already
registered for a managed
SOP Instance of the spec-
ified SOP Class.
No Such Object Instance 0112 The SOP Instance was not
recognized.
Warning Attribute Value Out of 0116 The MPPS operation is
Range considered successful
but the status meaning
is logged. Additional
information in the Re-
sponse identifying the
attributes out of range
will be logged (i.e., Ele-
ments in the Modification
List/Attribute List)
Any other status code. The Association is
aborted using A-ABORT
and the MPPS is marked
as failed. The status
meaning is logged and
reported to the user.
The behavior during communication failure is summarized in the Table below:

Table 4.31: MPPS / Modality Worklist Communication Failure Behavior


Exception Behaviour
Timeout The Association is aborted using A-ABORT and MPPS / Modality Worklist is
marked as failed. The reason is logged and reported to the user.
Association aborted by the The MPPS / Modality Worklist is marked as failed. The reason is logged and
SCP or network layers reported to the user.

54 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Acquired images will always use the Study Instance UID specified for the Scheduled Procedure Step (if available). If
an acquisition is unscheduled, a Study Instance UID will be generated locally. The Table below provides a description
of the Modality Worklist Request Identifier and specifies the attributes that are copied into the images. Unexpected
attributes returned in a C-FIND response are ignored. Requested return attributes not supported by the SCP are set to
have no value. Non-matching responses returned by the SCP due to unsupported optional matching keys are ignored.
No attempt is made it filter out possible duplicate entries.

Module Name
Attribute Tag VR M R Q D IOD
Name
Scheduled Procedure Step
Scheduled (0040,0100)
Proce-
dure Step
Sequence
>Scheduled (0040,0001) AE x
Station 19.
AET
>Scheduled (0040,0002) DA S x
Procedure
Step Start
Date
>Scheduled (0040,0003) TM x x
Procedure
Step Start
Time
>Modality (0008,0060) CS S x x
>Scheduled (0040,0006) PN x x x x
Performing
Physicians
Name
>Scheduled (0040,0007) LO x x x
Procedure
Step De-
scription
>Scheduled (0040,0010) SH x x
Station
Name
>Scheduled (0040,0011) SH x x
Procedure
Step Loca-
tion
>Scheduled (0040,0008) SQ x x x
Protocol
Code
Sequence
>Pre- (0040,0012) LO x x
Medication
>Scheduled (0040,0009) SH x x x
Procedure
Step ID
Continued on next page

4.2. AE Specifications 55
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.32 continued from previous page


Module Name
Attribute Tag VR M R Q D IOD
Name
>Requested (0032,1070) LO x x
Contrast
Agent
Requested Procedure
Requested (0040,1001) SH x x x x
Procedure
ID
Requested (0032,1060) LO x x x
Procedure
Descrip-
tion
Study (0020,000D) UI x x
Instance
UID
Requested (0040,1003) SH x
Procedure
Priority
Patient (0040,1004) LO x
Transport
Arrange-
ments
Referenced (0008,1110) SQ x x
Study
Sequence
Requested (0032,1064) SQ x x
Proce-
dure Code
Sequence
Imaging Service Request
Accession (0008,0050) SH x x x x
Number
Requesting (0032,1032) PN x x x
Physician
Requesting (0008,0090) PN x x x x
Physicians
Name
Visit Identification
Admission (0038,0010) LO x
ID
Visit Status
Current Pa- (0038,0300) LO x x
tient Loca-
tion
Visit Admission
Admitting (0008,1080) LO x x
Diagnosis
Descrip-
tion
Continued on next page

56 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.32 continued from previous page


Module Name
Attribute Tag VR M R Q D IOD
Name
Patient Identification
Patient (0010,0010) PN x x x x
Name
Patient ID (0010,0020) LO x x x x
Patient Demographic
Patients (0010,0030) DA x x x x
Birth Date
Patients (0010,0040) CS x x x x
Sex
Patients (0010,1030) DS x x x
Weight
Confidentiality(0040,3001) LO x x x x
constraint
on patient
data
Patient Medical
Patient (0038,0500) LO x x
State
Pregnancy (0010,21C0) US x x
Status
Medical (0010,2000) LO x x
Alerts
Allergies (0010,2110) LO x x
Special (0038,0050) LO x x
Needs

The above tables should be read as follows:


1. Module Name : The name of the associated module for supported worklist attributes.
2. Attribute Name : Attributes supported to build an Modality Worklist Request Identifier.
3. Tag : DICOM tag for this attribute.
4. VR : DICOM VR for this attribute.
5. M : Matching keys for (automatic) Worklist Update. A S will indicate that Modality Worklist will supply an
attribute value for Single Value Matching, a R will indicate Range Matching and a * will denote wild card
matching. It can be configured if Scheduled Station AE Title is additionally supplied (S) and if Modality
is set to RF or SC.
6. R : Return keys. An x will indicate that Modality Worklist will supply this attribute as Return Key with
zero length for Universal Matching. The Modality Worklist will support retired date format (yyyy.mm.dd) for
Patients Birth Date and Scheduled Procedure Step Start Date in the response identifiers. For Scheduled
Procedure Step Start Time also retired time format as well as unspecified time components are supported.
7. Q : Interactive Query Key. An x will indicate that Modality Worklist will supply this attribute as matching
key, if entered in the Query Patient Worklist dialog. For example, the Patient Name can be entered thereby
restricting Worklist responses to Procedure Steps scheduled for the patient.
8. D : Displayed keys. An x indicates that this worklist attribute is displayed to the user during a patient registra-
tion dialog. For example, Patient Name will be displayed when registering the patient prior to an examination.

4.2. AE Specifications 57
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

9. IOD : An x indicates that this Worklist attribute is included into all Object Instances created during perfor-
mance of the related Procedure Step.
The default Query Configuration is set to Modality (RF) and Date (date of today). Optionally, additional matching
for the own AET is configurable. Below table provides a description of the MPPS N-CREATE and N-SET request
identifiers sent. Empty cells in the N-CREATE and N-SET columns indicate that the attribute is not sent. An x
indicates that an appropriate value will be sent. A Zero length attribute will be sent with zero length.

Attribute Name Tag VR N-CREATE


Specific Character Set (0008,0005) CS ISO_IR 100 or ISO_IR 144
Modality (0008,0060) CS RF
Referenced Patient Sequence (0008,1120) SQ Zero Length
Patients Name (0010,0010) PN From Modality Worklist or user input (all
Patients ID (0010,0020) LO From Modality Worklist or user input. Th
Patients Birth Date (0010,0030) DA From Modality Worklist or user input. Th
Patients Sex (0010,0040) CS From Modality Worklist or user input. Th
Distance Source to Detector (SID) (0018,1110) DS Zero Length
Image Area Dose Product (0018,115E) DS Zero Length
Study ID (0020,0010) SH From Modality Worklist or user input. Th
Performed Station AE Title (0040,0241) AE MPPS AE Title
Performed Station Name (0040,0242) SH From configuration
Performed Location (0040,0243) SH From configuration
Performed Procedure Step Date (0040,0244) DA Actual Start Date
Performed Procedure Step Time (0040,0245) TM Actual Start Time
Performed Procedure Step End Date (0040,0250) DA Zero Length
Performed Procedure Step End Time (0040,0251) TM Zero Length
Performed Procedure Step Status (0040,0252) CS IN PROGRESS
Performed Procedure Step Discontinuation Reason Code Sequence (0040,0281) SQ Zero Length
Performed Procedure Step ID (0040,0253) SH Automatically created but can be modifie
Performed Procedure Step Description (0040,0254) LO From Modality Worklist or user input. Th
Performed Procedure Type Description (0040,0255) LO Zero length
Performed Protocol Code Sequence (0040,0260) SQ Zero length
Scheduled Step Attributes Sequence (0040,0270) SQ If 1st dose applied results in an Instance
> Accession Number (0008,0050) SH From Modality Worklist or user input. Th
> Referenced Study Sequence (0008,1110) SQ From Modality Worklist
>> Referenced SOP Class UID (0008,1150) UI From Modality Worklist
>> Referenced SOP Instance UID (0008,1155) UI From Modality Worklist
> Study Instance UID (0020,000D) UI From Modality Worklist
> Requested Procedure Description (0032,1060) LO From Modality Worklist
> Scheduled Procedure Step Description (0040,0007) LO From Modality Worklist
> Scheduled Protocol Code Sequence (0040,0008) SQ From Modality Worklist
> Scheduled Procedure Step ID (0040,0009) SH From Modality Worklist
> Requested Procedure ID (0040,1001) SH From Modality Worklist
Performed Series Sequence (0040,0340) SQ if 1st dose applied results in an instance
> Retrieve AE Title (0008,0054) AE x
> Series Description (0008,103E) LO x
> Performing Physicians Name (0008,1050) PN x
> Operators Name (0008,1070) PN x
> Referenced Image Sequence (0040,1140) SQ One or more items
>> Referenced SOP Class UID (0008,1150) UI x

58 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Attribute Name Tag VR N-CREATE


>> Referenced SOP Instance UID (0008,1155) UI x
> Protocol Name (0018,1030) LO x
> Series Instance UID (0020,000E) UI x
> Referenced Standalone SOP Instance Seq. (0040,0220) SQ Zero length (SOP classes not supported)
Total Time of Fluoroscopy (0040,0300) US Zero length
Total Number of Exposures (0040,0301) US Zero length
Entrance Dose (0040,0302) US Zero length
Exposed Area (0040,0303) US Zero length
Film Consumption Sequence (0040,0321) SQ Zero length
> Medium Type (2000,0030) CS
> Film Size ID (2010,0050) CS
> Number of Films (2100,0170) IS

Association Acceptance Policies

The Workflow Application Entity does not accept Associations.

STOW-RS Specifications

STOW-RS Store Instance

Table 4.34: STOW-RS Store Instances Specification


Category Restrictions
Media Types Supported (Accept header) Restricted to application/dicom or application/dicom+xml
Transfer Syntaxes Supported (Media Type Any Transfer Syntax supported by the hosting DCM4CHEE
parameter) ARCHIVE
SOP Class Restrictions Restricted to SOP classes supported by the hosting DCM4CHEE
ARCHIVE
Size restriction Restricted to size supported by the hosting DCM4CHEE
ARCHIVE

Connection Policies

General

All standard RS connection policies apply. There are no extensions for RS options.

Number Of Connections

DCM4CHEE-STOW-SERVICE limits the number of simultaneous RS requests. Additional requests will be queued
after the HTTP connection is accepted. When an earlier request completes, a pending request will proceed.

Asynchronous Nature

DCM4CHEE-STOW-SERVICE does not support RS asynchronous response.

4.2. AE Specifications 59
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

SOP Specific Conformance for SOP Class(es)

The DCM4CHEE-STOW-SERVICE response message header contains status codes indicating success, warning, or
failure as shown in the HTTP Standard Response Codes below. No additional status codes are used.

Table 4.35: HTTP Standard Response Codes


Service HTTP STOW-RS Description
Status Status
Code
Failure 400 - Bad This indicates that the STOW-RS Service was unable to store any instances due to bad
Request syntax.
401 - This indicates that the STOW-RS Service refused to create or append any instances
Unautho- because the client is not authenticated.
rized
403 - This indicates that the STOW-RS Service understood the request, but is refusing to
Forbidden fulfill it (e.g., an authenticated user with insufficient privileges).
409 - This indicates that the STOW-RS Service request was formed correctly but the service
Conflict was unable to store any instances due to a conflict in the request (e.g., unsupported SOP
Class or Study Instance UID mismatch). This may also be used to indicate that a
STOW-RS Service was unable to store any instances for a mixture of reasons.
Additional information regarding the instance errors can be found in the XML response
message body.
503 - Busy This indicates that the STOW-RS Service was unable to store any instances because it
was out of resources.
Warn- 202 - This indicates that the STOW-RS Service stored some of the instances but warnings or
ing Accepted failures exist for others. Additional information regarding this error can be found in the
XML response message body.
Success 200 - OK This indicates that the STOW-RS Service successfully stored all the instances.

QIDO-RS Specifications

QIDO-RS Search For Studies

Table 4.36: QIDO-RS Search for Studies Specification


Parameter Restrictions
Media Types Restricted to multipart/related; type=application/dicom+xml or application/json
Matching Attributes Refer Table 4.37
Return Attributes Refer Table 4.37
Limit and Offset supported Yes
Person Name Matching Literal, case insensitive. Refer Extended Negotiation

Table 4.37: QIDO-RS Study Attribute Matching

Attributes Names Tag Query Keys Matching (SCP) Return Attributes (SCP)
Study Instance UID 0002000D UNIQUE UNIQUE
Study ID 00020010 S,*,U S,*,U
Study Date 00080020 S,*,U,R S,*,U,R
Study Time 00080030 S,*,U,R S,*,U,R
Continued on next page

60 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.37 continued from previous page


Attributes Names Tag Query Keys Matching (SCP) Return Attributes (SCP)
Study Description 00081030 S,*,U S,*,U
Accession Number 00080050 S,*,U S,*,U
Issuer of Accession Number 00080051
Referring Physicians Name 00080090 S,*,U S,*,U
Institution Name 00080080 S,*,U
Station Name 00081010 S,*,U
Body Part Examined 00180015 S,*,U
SOP Classes in Study 00080062 S,*,U
Institutional Department Name 00081040 S,*,U
Series Description 0008103E S,*,U
Sending Application Entity Title of Series S,*,U
Patient Name 00100010 S,*,U
Patient ID 00100020 S,*,U
Issuer of Patient ID 00100021 UNIQUE
Modality 00080061 S,*,U
Failed SOP Instance UID List 00080058 L
Procedure Code Sequence 00081032 NONE
Patient Age 00101010 NONE
Patient Size 00101020 NONE
Patient Size Code Sequence 00101021 NONE
Patient Weight 00101030 NONE
Occupation 00102180 NONE
Additional Patient History 001021B0 NONE
Patient Sex Neutered 00102203 NONE
Physicians of Record 00081048 NONE
Specific Character Set 00080005 NONE
Retrieve URL 00081190 NONE
Retrieve AE Title 00080054 NONE
Instance Availability 00080056 NONE
Number of Study Related Series 00201206 NONE
Number of Study Related Instances 00201208 NONE

Types of Matching :
1. S indicates the identifier attribute uses Single Value Matching.
2. L indicates UID List Matching.
3. U indicates Universal Matching. (Note : If only Universal Matching is supported for an attribute then that
attribute can only be passed as an includefield query key.)
4. * indicates wild card matching.
5. R indicates Range Matching.
6. SEQUENCE indicates Sequence Matching.
7. NONE indicates that no matching is supported, but that values for this Element requested will be returned
with all requests.
8. UNIQUE indicates that this is the Unique Key for that query level, in which case Universal Matching or Single
Value Matching is used depending on the query level.

4.2. AE Specifications 61
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

QIDO-RS Search For Series

Table 4.38: QIDO-RS Search for Series Specification


Parameter Restrictions
Media Types Restricted to multipart/related; type=application/dicom+xml or
application/json
Matching Attributes Refer Table 4.37 and Table 4.39
Return Attributes Refer Table 4.39
Limit and Offset supported Yes
Relational Queries No
Supported
Person Name Matching Literal, case insensitive. Refer Extended Negotiation
Types of Matching: As explained above in QIDO-RS Search For Studies

Table 4.39: QIDO-RS Series Attribute Matching

Attributes Names Tag Query Keys Matching (SCP) Return Attributes (SCP)
Series Instance UID 0002000E UNIQUE UNIQUE
Series Number 00200011 S,*,U S,*,U
Modality 00080060 S,*,U S,*,U
Body Part Examined 00180015 S,*,U S,*,U
Performed Procedure Step Start Date 00400244 S,*,U,R S,*,U,R
Performed Procedure Step Start Time 00400245 S,*,U,R S,*,U,R
Performing Physician Name 00081050 S,*,U S,*,U
Station Name 00081010 S,*,U S,*,U
Series Description 0008103E S,*,U S,*,U
Institutional Department Name 00081040 S,*,U S,*,U
Institution Name 00080080 S,*,U S,*,U
Request Attributes Sequence 00400275 SEQUENCE SEQUENCE
>Accession Number 00080050 S,*,U S,*,U
>Issuer of Accession Number 00080051
>Requesting Service 00321033 S,*,U S,*,U
>Requesting Physician 00321032 S,*,U S,*,U
>Requested Procedure ID 00401001 S,*,U S,*,U
>Study Instance UID 0002000D UNIQUE UNIQUE
>Scheduled Procedure ID 00400009 S,*,U S,*,U
Institution Code Sequence 00080082 SEQUENCE SEQUENCE
>Code Value 00080100 S,*,U S,*,U
>Coding Scheme Designator 00080102 S,*,U S,*,U
>Coding Scheme Version 00080103 S,*,U S,*,U
Sending Application Entity Title of Series S,*,U
Failed SOP Instance UID List 00080058 L
Laterality 00200060 NONE
Manufacturer 00080070 NONE
Manufacturer Model Name 00081090 NONE
Referenced Performed Procedure Step Sequence 00081111 NONE
Specific Character Set 00080005 NONE
Retrieve URL 00081190 NONE
Retrieve AE Title 00080054 NONE
Instance Availability 00080056 NONE
Continued on next page

62 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.39 continued from previous page


Attributes Names Tag Query Keys Matching (SCP) Return Attributes (SCP)
Number of Series Related Instances 00201209 NONE

QIDO-RS Search For Instances

Table 4.40: QIDO-RS Search for Instances Specification


Parameter Restrictions
Media Types Restricted to multipart/related; type=application/dicom+xml or
application/json
Matching Attributes Refer Table 4.37, Table 4.39 and Table 4.41
Return Attributes Refer Table 4.41
Limit and Offset supported Yes
Relational Queries Series-level, only
Supported
Person Name Matching Literal, case insensitive. Refer Extended Negotiation
Types of Matching: As explained above in QIDO-RS Search For Studies

Table 4.41: QIDO-RS Instance Attribute Matching

Attributes Names Tag Query Keys Matching (SCP) Return Attributes (SCP)
SOP Class UID 00080016 L L
SOP Instance UID 00080018 UNIQUE UNIQUE
Content Date 00080023 S,*,U,R S,*,U,R
Content Time 00080033 S,*,U,R S,*,U,R
Instance Number 00200013 S,*,U S,*,U
Concept Name Code Sequence 0040A043 SEQUENCE SEQUENCE
>Code Value 00080100 S,*,U S,*,U
>Coding Scheme Designator 00080102 S,*,U S,*,U
>Coding Scheme Version 00080103 S,*,U S,*,U
Verifying Observer Sequence 0040A073 SEQUENCE SEQUENCE
>Verifying Observer Name 0040A075 S,*,U S,*,U
>Verification Date Time 0040A030 S,*,U, R S,*,U, R
Completion Flag 0040A491 S,*,U S,*,U
Verification Flag 0040A493 S,*,U S,*,U
Content Sequence 0040A730 SEQUENCE SEQUENCE
>Value Type 0040A040 S S
>Concept Name Code Sequence 0040A043 SEQUENCE SEQUENCE
>>Code Value 00080100 S,*,U S,*,U
>>Coding Scheme Designator 00080102 S,*,U S,*,U
>>Coding Scheme Version 00080103 S,*,U S,*,U
>Relationship Type 0040A010 S,*,U S,*,U
>Concept Code Sequence 0040A168 SEQUENCE SEQUENCE
>>Code Value 00080100 S,*,U S,*,U
>>Coding Scheme Designator 00080102 S,*,U S,*,U
>>Coding Scheme Version 00080103 S,*,U S,*,U
>Text Value 0040A160 S,*,U S,*,U
Image Type 00080008 NONE
Observation Date Time 0040A032 NONE
Continued on next page

4.2. AE Specifications 63
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.41 continued from previous page


Attributes Names Tag Query Keys Matching (SCP) Return Attributes (SCP)
Referenced Series Sequence 00081115 NONE
Number of Frames 00280008 NONE
Rows 00280010 NONE
Columns 00280011 NONE
Bits Allocated 00280100 NONE
Referenced Request Sequence 0040A370 NONE
Current Requested Procedure Evidence Sequence 0040A375 NONE
Content Template Sequence 0040A504 NONE
Identical Documents Sequence 0040A525 NONE
Document Title 00420010 NONE
MIME Type of Encapsulated Document 00420012 NONE
Content Label 00700080 NONE
Content Description 00700081 NONE
Presentation Creation Date 00700082 NONE
Presentation Creation Time 00700083 NONE
Content Creators Name 00700084 NONE
Specific Character Set 00080005 NONE
Retrieve URL 00081190 NONE
Retrieve AE Title 00080054 NONE
Instance Availability 00080056 NONE

QIDO-RS Search For Patients

Table 4.42: QIDO-RS Search for Patients Specification


Parameter Restrictions
Media Types Restricted to multipart/related; type=application/dicom+xml or
application/json
Matching Attributes Refer Table 4.43
Return Attributes Refer Table 4.43
Limit and Offset supported Yes
Relational Queries No
Supported
Person Name Matching Literal, case insensitive. Refer Extended Negotiation
Types of Matching: As explained above in QIDO-RS Search For Studies

Table 4.43: QIDO-RS Patient Attribute Matching

Attributes Names Tag Query Keys Matching (SCP) Return Attributes (SC
Patient Name 00100010 S,*,U S,*,U
Patient ID 00100020 S,*,U S,*,U
Patient Birth Date 00100030 S,*,U,R S,*,U,R
Patient Sex 00100040 S,*,U S,*,U
Issuer of Patient ID 00100021 S,*,U S,*,U
Issuer of Patient ID Qualifier Sequence 00100024 NONE
Patient Birth Time 00100032 NONE
Patient Insurance Plan Code Sequence 00100050 NONE
Patient Primary Language Code Sequence 00100101 NONE
Continued on next pa

64 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.43 continued from previous page


Attributes Names Tag Query Keys Matching (SCP) Return Attributes (SC
Other Patient Names 00101001 NONE
Other Patient IDs Sequence 00101002 NONE
Patient Birth Name 00101005 NONE
Patient Address 00101040 NONE
Patient Mother Birth Name 00101060 NONE
Military Rank 00101080 NONE
Branch of Service 00101081 NONE
Medical Record Locator 00101090 NONE
Medical Alerts 00102000 NONE
Allergies 00102110 NONE
Country of Residence 00102150 NONE
Region of Residence 00102152 NONE
Patient Telephone Numbers 00102154 NONE
Ethnic Group 00102160 NONE
Smoking Status 001021A0 NONE
Pregnancy Status 001021C0 NONE
Last Menstrual Date 001021D0 NONE
Patient Religious Preference 001021F0 NONE
Patient Species Description 00102201 NONE
Patient Species Code Sequence 00102202 NONE
Patient Breed Description 00102292 NONE
Patient Breed Code Sequence 00102293 NONE
Breed Registration Sequence 00102294 NONE
Responsible Person 00102297 NONE
Responsible Person Role 00102298 NONE
Responsible Organization 00102299 NONE
Patient Comments 00104000 NONE
Clinical Trial Sponsor Name 00120010 NONE
Clinical Trial Protocol ID 00120020 NONE
Clinical Trial Protocol Name 00120021 NONE
Clinical Trial Site ID 00120030 NONE
Clinical Trial Site Name 00120031 NONE
Clinical Trial Subject ID 00120040 NONE
Clinical Trial Subject Reading ID 00120042 NONE
Patient Identity Removed 00120062 NONE
Deidentification Method 00120063 NONE
Deidentification Method Code Sequence 00120064 NONE
Clinical Trial Protocol Ethics Committee Name 00120081 NONE
Clinical Trial Protocol Ethics Committee Approval Number 00120082 NONE
Special Needs 00380050 NONE
Pertinent Documents Sequence 00380100 NONE
Patient State 00380500 NONE
Patient Clinical Trial Participation Sequence 00380502 NONE
Confidentiality Constraint On Patient Data Description 00403001 NONE
Specific Character Set 00080005 NONE
Retrieve URL 00081190 NONE
Retrieve AE Title 00080054 NONE
Instance Availability 00080056 NONE

Extended Negotiation :

4.2. AE Specifications 65
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

DCM4CHEE-QIDO-SERVICE does not support the fuzzymatching query key. DCM4CHEE-QIDO-SERVICE will
perform case insensitive matching for PN VR attributes but will not perform other forms of fuzzy matching. This
applies to the following attributes:
Table 4.37 Referring Physicians Name (0008,0090).
Patients Name (0010,0010).
Physicians of Record (0008,1048).
Table 4.39 Performing Physicians Name (0008,1050).
Table 4.41 Verifying Observer Name (0040,A075).
Table 4.43 Patients Name (0010,0010).

QIDO-RS Connection Policies

General

All standard RS connection policies apply. There are no extensions for RS options.

Number Of Connections

DCM4CHEE-QIDO-SERVICE limits the number of simultaneous RS requests. Additional requests will be queued
after the HTTP connection is accepted. When an earlier request completes, a pending request will proceed.

Asynchronous Nature

DCM4CHEE-QIDO-SERVICE does not support RS asynchronous response.

Response Status

DCM4CHEE-QIDO-SERVICE shall provide a response message header containing the appropriate status code indi-
cating success, warning, or failure as shown below

Table 4.44: HTTP Standard Response Codes


Code Name Description
Suc-
cess
200 OK The query completed and any matching results are returned in the message body.
Fail-
ure
400 Bad Request This indicates that the QIDO-RS Provider was unable to fulfill it because it cannot
understand the query component.
401 Unautho- This indicates that the QIDO-RS Provider refused to fulfill it because the client is not
rized authorized.
403 Forbidden This indicates that the QIDO-RS Provider understood the request, but is refusing to fulfill
it (e.g., no single patient specified, an authorized user with insufficient privileges, etc.).
413 Request This indicates that the query was too broad and a narrower query or paging should be
entity too requested. This code will be returned for queries that do not specify PatientID.
large
503 Busy Service is unavailable.

66 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

WADO-URI Specification

WADO-URI Retrieve Imaging Document Set

Table 4.45: WADO-URI Retrieve Imaging Documents Specification


Parameter Restrictions
Transfer Syntaxes Restricted to transfer syntaxes supported by the hosting DCM4CHEE ARCHIVE
Supported
SOP Class restrictions Restricted to SOP classes supported by the hosting DCM4CHEE ARCHIVE
Size restriction Restricted to sizes supported by the hosting DCM4CHEE ARCHIVE
Anonymization Supports the DICOM Basic Application Level Confidentiality Profile plus the Retain
Patient Characteristics option.
If the URI Retrieve specifies no transfer syntax that is supported by the archive, the SOP Instance will be returned
using the Implicit VR Little Endian Transfer Syntax.

WADO-URI Retrieve Rendered Imaging Document Set

Table 4.46: WADO-URI Retrieve Rendered Imaging Documents Specification


Parameter Restrictions
Transfer Syntaxes Restricted to transfer syntaxes supported by the hosting DCM4CHEE ARCHIVE
Supported
SOP Class restrictions Restricted to SOP classes supported by the hosting DCM4CHEE ARCHIVE
Size restriction Restricted to sizes supported by the hosting DCM4CHEE ARCHIVE
Rendered formats Supports JPEG and PDF for IMAGE IODS, and PDF for non-IMAGE IODS.
available
Rows restrictions Must be in range 16 - 32767
Columns restrictions Must be in range 16 - 32767
Region restrictions None
Window Center Whole window must be in the range of image pixel values.
restrictions
Window Width Must be greater than 4 and whole window must be in the range of image pixel values.
restrictions
Image Quality None
restrictions
Anonymization Supports the DICOM Basic Application Level Confidentiality Profile plus the Retain
Patient Characteristics option.
Annotation None
Restrictions
Compression JPEG
available
Other restrictions None

WADO-URI Retrieve Imaging Document Set Metadata

Not Supported

WADO-URI Connection Policies

4.2. AE Specifications 67
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

General

All URI connections are limited to HTTP GET requests. The DCM4CHEE-WADO-SERVICE ignores all unknown
HTTP header parameters.

Number Of Connections

DCM4CHEE-WADO-SERVICE limits the number of simultaneous HTTP connections.

Asynchronous Nature

DCM4CHEE-WADO-SERVICE supports HTTP pipelined requests and responses.

WADO-RS Specifications

WADO-RS Retrieve Study

Table 4.47: WADO-RS Retrieve Study


Options Restrictions
Data Types Supported (Accept Type) Restricted to application/dicom or application/octet-stream
Transfer Syntaxes Supported (transfer-syntax Any Transfer Syntax supported by the hosting DCM4CHEE
Accept parameter) ARCHIVE
SOP Class restrictions Restricted to SOP classes supported by the hosting
DCM4CHEE ARCHIVE
Size restriction Restricted to size supported by the hosting DCM4CHEE
ARCHIVE

WADO-RS Retrieve Series

Table 4.48: WADO-RS Retrieve Series


Options Restrictions
Data Types Supported (Accept Type) Restricted to application/dicom or application/octet-stream
Transfer Syntaxes Supported (transfer-syntax Any Transfer Syntax supported by the hosting DCM4CHEE
Accept parameter) ARCHIVE
SOP Class restrictions Restricted to SOP classes supported by the hosting
DCM4CHEE ARCHIVE
Size restriction Restricted to size supported by the hosting DCM4CHEE
ARCHIVE

68 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

WADO-RS Retrieve Instance

Table 4.49: WADO-RS Retrieve Instance


Options Restrictions
Data Types Supported (Accept Type) Restricted to application/dicom or application/octet-stream
Transfer Syntaxes Supported (transfer-syntax Any Transfer Syntax supported by the hosting DCM4CHEE
Accept parameter) ARCHIVE
SOP Class restrictions Restricted to SOP classes supported by the hosting
DCM4CHEE ARCHIVE
Size restriction Restricted to size supported by the hosting DCM4CHEE
ARCHIVE

WADO-RS Retrieve Frames

Table 4.50: WADO-RS Retrieve Frames


Options Restrictions
Data Types Supported (Accept Type) Restricted to application/octet-stream
Transfer Syntaxes Supported (transfer-syntax Any Transfer Syntax supported by the hosting
Accept parameter) DCM4CHEE ARCHIVE
SOP Class restrictions Restricted to Multi-Frame Image Objects
Size restriction Restricted to size supported by the hosting DCM4CHEE
ARCHIVE

WADO-RS Retrieve Bulk Data

Table 4.51: WADO-RS Retrieve Bulk Data


Options Restrictions
Data Types Supported (Accept Type) Restricted to application/octet-stream
Transfer Syntaxes Supported (transfer-syntax Any Transfer Syntax supported by the hosting DCM4CHEE
Accept parameter) ARCHIVE
SOP Class restrictions Restricted to SOP classes supported by the hosting
DCM4CHEE ARCHIVE
Size restriction Restricted to size supported by the hosting DCM4CHEE
ARCHIVE

4.2. AE Specifications 69
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

WADO-RS Retrieve Metadata

Table 4.52: WADO-RS Retrieve Metadata


Options Restrictions
Data Types Restricted to application/dicom+xml
Supported (Accept
Type)
Accept-Encoding Restricted to gzip, deflate, or identity (the use of no transformation whatsoever). See W3C
RFC 2616 Protocol Parameters Section 3.5 for more information
(http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html).
SOP Class Restricted to SOP classes supported by the hosting DCM4CHEE ARCHIVE
restrictions
Size restriction Restricted to size supported by the hosting DCM4CHEE ARCHIVE

WADO-RS Connection Policies

General

All standard RS connection policies apply. There are no extensions for RS options.

Number Of Connections

DCM4CHEE-WADO-SERVICE limits the number of simultaneous RS requests. Additional requests will be queued
after the HTTP connection is accepted. When an earlier request completes, a pending request will proceed.

Asynchronous Nature

DCM4CHEE-WADO-SERVICE does not support RS asynchronous response.

Network Interfaces

Physical Network Interface

The application is indifferent to the physical medium over which TCP/IP executes, which is dependent on the under-
lying operating system and hardware

Additional Protocols

When host names rather than IP addresses are used in the configuration properties to specify presentation addresses
for remote AEs, the application is dependent on the name resolution mechanism of the underlying operating system.

IPv4 and IPv6 Support

This product supports both IPv4 and IPv6. It does not utilize any of the optional configuration identification or security
features of IPv6.

70 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Configuration

AE Title/Presentation Address Mapping

Local AE Titles

The mapping from AE Title to TCP/IP addresses and ports is configurable and set at the time of installation by
Installation Personnel.

Table 4.53: Default Application Entity Characteristics


Application Entity Role Default AE Title Default TCP/IP Port
STORAGE-SCU SCU EX_STORE_SCU None
STORAGE-SCP SCP EX_STORE_SCP 4000
QUERY-RETRIEVE-SCP SCP EX_QUERY_SCP 5000
The STORAGE-SCU and DCM4CHEE SCP Application Entities can be configured to have the same AE Title. The
STORAGE-SCP Application Entity must not have the same AE Title as the other two.

Remote AE Title/Presentation Address Mapping

The mapping of external AE Titles to TCP/IP addresses and ports is configurable and set at the time of installation
by Installation Personnel. This mapping is necessary for resolving the IP address and port of C-MOVE Destination
Application Entities and must be correctly configured for the DCM4CHEE SCP AE to correctly function as a C-MOVE
SCP.

Parameters

Device

DICOM Device related information

Table 4.54: Device Attributes (LDAP Object: dcmDevice)

Name Type Description LDAP Attribute


Device Name string A unique name for this device dicomDeviceName
Device Description string Unconstrained text description of the device dicomDescription
Vendor Device Data boolean Device specific vendor configuration information dicomVendorData
Device UID string Unique identifier of the device dicomDeviceUID
Manufacturer string Should be the same as the value of Manufacturer dicomManufacturer
(0008,0070) in SOP instances created by this device
Manufacturer Model Name string Should be the same as the value of Manufacturer Model dicomManufacturerModelNam
Name (0008,1090) in SOP instances created by this de-
vice
Software Version(s) string Should be the same as the values of Software Versions dicomSoftwareVersion
(0018,1020) in SOP instances created by this device
Station Name string Should be the same as the value of Station Name dicomStationName
(0008,1010) in SOP instances created by this device
Device Serial Number string Should be the same as the value of Device Serial Number dicomDeviceSerialNumber
(0018,1000) in SOP instances created by this device
Continued on

4.4. Configuration 71
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.54 continued from previous page


Name Type Description LDAP Attribute
Primary Device Type(s) string Represents the kind of device and is most applicable for dicomPrimaryDeviceType
acquisition modalities
Institution Name(s) string Should be the same as the value of Institution Name dicomInstitutionName
(0008,0080) in SOP Instances created by this device
Institution Code(s) string Institution Code(s) in format (CV, CSD, CM) dicomInstitutionCode
Institution Address(s) string Should be the same as the value of Institution Address dicomInstitutionAddress
(0008,0081) attribute in SOP Instances created by this de-
vice
Institution Department string Should be the same as the value of Institutional Depart- dicomInstitutionDepartmentNa
Name(s) ment Name (0008,1040) in SOP Instances created by this
device
Issuer of Patient ID string Default value for the Issuer of Patient ID (0010,0021), dicomIssuerOfPatientID
and optionally also default values for the Universal En-
tity ID (0040,0032) and the Universal Entity ID Type
(0040,0033) of the Item of the Issuer of Patient ID Qual-
ifiers Sequence (0010,0024) for SOP Instances created
or queried by this device. Format: <Issuer of Patient
ID>[&<Universal Entity ID>&<Universal Entity ID
Type>]
Issuer of Accession Number string Default values for the Local Namespace Entity ID dicomIssuerOfAccessionNumbe
(0040,0031), the Universal Entity ID (0040,0032) and the
Universal Entity ID Type (0040,0033) of the Item of the
Issuer of Accession Number Sequence (0008,0051) for
SOP Instances created or queried by this device. For-
mat: <Local Namespace Entity ID>[&<Universal En-
tity ID>&<Universal Entity ID Type>]
Order Placer Identifier string Default values for the Local Namespace Entity ID dicomOrderPlacerIdentifier
(0040,0031), the Universal Entity ID (0040,0032) and
the Universal Entity ID Type (0040,0033) of the Item
of the Order Placer Identifier Sequence (0040,0026) for
SOP Instances created or queried by this device. For-
mat: <Local Namespace Entity ID>[&<Universal En-
tity ID>&<Universal Entity ID Type>]
Order Filler Identifier string Default values for the Local Namespace Entity ID dicomOrderFillerIdentifier
(0040,0031), the Universal Entity ID (0040,0032) and
the Universal Entity ID Type (0040,0033) of the Item
of the Order Filler Identifier Sequence (0040,0027) for
SOP Instances created or queried by this device. For-
mat: <Local Namespace Entity ID>[&<Universal En-
tity ID>&<Universal Entity ID Type>]
Issuer of Admission ID string Default values for the Local Namespace Entity ID dicomIssuerOfAdmissionID
(0040,0031), the Universal Entity ID (0040,0032) and
the Universal Entity ID Type (0040,0033) of the Item
of the Issuer of Admission ID Sequence (0038,0014) for
SOP Instances created or queried by this device. For-
mat: <Local Namespace Entity ID>[&<Universal En-
tity ID>&<Universal Entity ID Type>]
Continued on

72 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.54 continued from previous page


Name Type Description LDAP Attribute
Issuer of Service Episode ID string Default values for the Local Namespace Entity ID dicomIssuerOfServiceEpisodeI
(0040,0031), the Universal Entity ID (0040,0032) and the
Universal Entity ID Type (0040,0033) of the Item of the
Issuer of Service Episode ID Sequence (0038,0064) for
SOP Instances created or queried by this device. For-
mat: <Local Namespace Entity ID>[&<Universal En-
tity ID>&<Universal Entity ID Type>]
Issuer of Container Identi- string Default values for the Local Namespace Entity ID dicomIssuerOfContainerIdentifi
fier (0040,0031), the Universal Entity ID (0040,0032) and the
Universal Entity ID Type (0040,0033) of the Item of the
Issuer of Container Identifier Sequence (0040,0513) for
SOP Instances created or queried by this device. For-
mat: <Local Namespace Entity ID>[&<Universal En-
tity ID>&<Universal Entity ID Type>]
Issuer of Specimen Identi- string Default values for the Local Namespace Entity ID dicomIssuerOfSpecimenIdentifi
fier (0040,0031), the Universal Entity ID (0040,0032) and the
Universal Entity ID Type (0040,0033) of the Item of the
Issuer of Specimen Identifier Sequence (0040,0562) for
SOP Instances created or queried by this device. For-
mat: <Local Namespace Entity ID>[&<Universal En-
tity ID>&<Universal Entity ID Type>]
Authorized Node Certificate string The DNs for the certificates of nodes that are authorized dicomAuthorizedNodeCertifica
Reference(s) to connect to this device
This Node Certificate Refer- string The DNs of the public certificate(s) for this node dicomThisNodeCertificateRefer
ence(s)
installed boolean Boolean to indicate whether this device is presently in- dicomInstalled
stalled on the network
Network Connection (s) object network connections of the device dicomNetworkConnection
Network AE (s) object Application entity provided by the device dicomNetworkAE
dcm4che Device Attributes object dcm4che proprietary Device Attributes dcmDevice
HL7 Application (s) object HL7 Applications provided by the Device hl7Application
Image Writer (s) object Specifies Java Image IO Image Writers with Write Pa- dcmImageWriter
rameters used for compressing DICOM images
Image Reader (s) object Specifies Java Image IO Image Readers used for decom- dcmImageReader
pressing compressed DICOM images
Audit Logger (s) object Audit Logger related information dcmAuditLogger
Audit Record Repository object Audit Record Repository related information dcmAuditRecordRepository
Archive Device object DICOM Archive Device related information dcmArchiveDevice

Network Connection

Describes one TCP/UDP port on one network device.

4.4. Configuration 73
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.55: Network Connection Attributes (LDAP Object: dcmNetworkConnection)


Name Type Description LDAP Attribute
Name string Arbitrary/Meaningful name for the Network Connection cn
object
Hostname string DNS name for this particular connection dicomHostname
Port integer TCP/UDP port that a service is listening on. May be dicomPort
missing if this network connection is only used for out-
bound connections
TLS CipherSuites(s) string The TLS CipherSuites that are supported on this par- dicomTLSCipherSuite
ticular connection. If not present TLS is disabled
Enumerated values: SSL_RSA_WITH_NULL_SHA,
TLS_RSA_WITH_AES_128_CBC_SHA or
SSL_RSA_WITH_3DES_EDE_CBC_SHA
installed boolean True if the Network Connection is installed on the net- dicomInstalled
work. If not present, information about the installed sta-
tus of the Network Connection is inherited from the de-
vice
dcm4che Network Connec- object dcm4che proprietary Network Connection Attributes dcmNetworkConnection
tion Attributes

dcm4che Network Connection Attributes

dcm4che proprietary Network Connection Attributes

74 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.56: dcm4che Network Connection Attributes Attributes (LDAP Object: dcmDcmNetworkConnection)
Name Type Description LDAP Attribute
Protocol string Protocol of Network Connection. Enumerated values: dcmProtocol
DICOM, HL7, SYSLOG_TLS or SYSLOG_UDP
HTTP Proxy string HTTP Proxy: [user:password@]host:port dcmHTTPProxy
TLS Need Client Auth boolean Indicates if TLS client authentication is required. dcmTLSNeedClientAuth
TLS Protocol(s) string The Supported TLS Protocols. Enumerated values: dcmTLSProtocol
TLSv1.2, TLSv1.1, TLSv1 or SSLv3
TCP Backlog integer Maximum queue length for incoming TCP connections. dcmTCPBacklog
0 = unlimited
TCP Connect Timeout integer TCP connect timeout in ms; no timeout if absent dcmTCPConnectTimeout
TCP Close Delay integer TCP socket close delay in ms after send of A- dcmTCPCloseDelay
ASSOCIATE-RJ, A-RELEASE-RP or A-ABORT PDU.
TCP Send Buffer Size integer TCP send buffer size; use system defaults if absent dcmTCPSendBufferSize
TCP Receive Buffer Size integer TCP receive buffer size; use system defaults if absent dcmTCPReceiveBufferSize
TCP No Delay boolean Enable/disable TCP_NODELAY (disable/enable Nagle dcmTCPNoDelay
algorithm).
Bind Address string Bind address of listening socket; use hostname of the dcmBindAddress
connection if absent
Client Bind Address string Bind address of outgoing connections; use hostname of dcmClientBindAddress
the connection if absent
Blacklisted Hostname(s) string blacklisted DNS hostnames dcmBlacklistedHostname
Send PDU Length integer Maximal length of emitted PDUs. dcmSendPDULength
Receive PDU Length integer Maximal length of received PDUs. dcmReceivePDULength
Max Ops Performed integer Maximal number of operations to perform asyn- dcmMaxOpsPerformed
chronously; 0 = infinite.
Max Ops Invoked integer Maximal number of operations to invoke asyn- dcmMaxOpsInvoked
chronously; 0 = infinite.
Pack PDV boolean Enable/disable packing of command and data PDVs into dcmPackPDV
one P-DATA-TF PDU.
AA-RQ Timeout integer Timeout in ms for receive of A-ASSOCIATE-RQ PDU dcmAARQTimeout
after TCP connect; no timeout if absent
AA-AC Timeout integer Timeout in ms for receive of A-ASSOCIATE-AC PDU dcmAAACTimeout
after send of A-ASSOCIATE-RQ PDU; no timeout if ab-
sent
AR-RP Timeout integer Timeout in ms for receive of A-RELEASE-RP PDU after dcmARRPTimeout
send of A-RELEASE-RQ PDU; no timeout if absent
Response Timeout integer Timeout in ms for receive of response message; no time- dcmResponseTimeout
out if absent
Retrieve Timeout integer Timeout in ms for receive of C-GET-RSP or C-MOVE- dcmRetrieveTimeout
RSP; no timeout if absent
Idle Timeout integer Indicates aborting of idle Associations after specified dcmIdleTimeout
timeout in ms; no timeout if absent

Network AE

Application entity that provides services on a network

4.4. Configuration 75
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.57: Network AE Attributes (LDAP Object: dcmNetworkAE)


Name Type Description LDAP Attribute
AE Title string Unique AE title for this Network AE dicomAETitle
Network Connection Refer- string JSON Pointers to the Network Connection objects for this dicomNetworkConnectionRefer
ence(s) AE
Association Initiator boolean True if the Network AE can initiate associations. dicomAssociationInitiator
Association Acceptor boolean True if the Network AE can accept associations. dicomAssociationAcceptor
AE Description string Unconstrained text description of the application entity dicomDescription
Application Cluster(s) string Locally defined names for a subset of related applications dicomApplicationCluster
Preferred Called AE Title(s) string AE Title(s) that are preferred for initiating associations dicomPreferredCalledAETitle
Preferred Calling AE Ti- string AE Title(s) that are preferred for accepting associations dicomPreferredCallingAETitle
tle(s)
Supported Character Set(s) string Character Set(s) supported by the Network AE for data dicomSupportedCharacterSet
sets it receives
installed boolean True if the AE is installed on network. If not present, in- dicomInstalled
formation about the installed status of the AE is inherited
from the device
Transfer Capability (s) object transfer capabilities provided by the application entity dicomTransferCapability
dcm4che Network AE At- object dcm4che proprietary Attributes of Network AE dcmNetworkAE
tributes
Archive Network AE object DICOM Archive Network AE related information dcmArchiveNetworkAE

Transfer Capability

Each transfer capability specifies the SOP class that the Network AE can support, the mode that it can utilize (SCP or
SCU), and the Transfer Syntax(es) that it can utilize

Table 4.58: Transfer Capability Attributes (LDAP Object: dcmTransferCapability)


Name Type Description LDAP Attribute
Name string Arbitrary/Meaningful name for the Transfer Capability cn
object
SOP Class string SOP Class UID dicomSOPClass
DICOM Transfer Role string DICOM Transfer Role. Enumerated values: SCP or SCU dicomTransferRole
Transfer Syntax(s) string Transfer syntax(es) that may be requested as an SCU or dicomTransferSyntax
that are offered as an SCP.
dcm4che Transfer Capabil- object dcm4che proprietary Transfer Capability Attributes dcmTransferCapability
ity

dcm4che Transfer Capability

dcm4che proprietary Transfer Capability Attributes

76 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.59: dcm4che Transfer Capability Attributes (LDAP Object: dcmDcmTransferCapability)


Name Type Description LDAP Attribute
Relational Queries boolean Enable/disable relational queries. dcmRelationalQueries
Combined Date Time boolean Enable/disable combined date time matching. dcmCombinedDateTimeMatchi
Matching
Fuzzy Semantic Matching boolean Enable/disable fuzzy semantic matching of person dcmFuzzySemanticMatching
names.
Timezone Query Adjust- boolean Enable/disable timezone query adjustment dcmTimezoneQueryAdjustment
ment
Storage Conformance integer Indicates level of Conformance of a Storage SCP Enu- dcmStorageConformance
merated values: 0, 1, 2 or 3
Digital Signature Support integer Indicates level of Digital Signature Support of a Storage dcmDigitalSignatureSupport
SCP Enumerated values: 0, 1, 2 or 3
Data Element Coercion integer Indicates coercion of Data Elements of a Storage SCP dcmDataElementCoercion
Enumerated values: 0, 1 or 2

dcm4che Network AE Attributes

dcm4che proprietary Attributes of Network AE

Table 4.60: dcm4che Network AE Attributes Attributes (LDAP Object: dcmDcmNetworkAE)


Name Type Description LDAP Attribute
Accepted Calling AE Ti- string Prohibit accepting associations from unlisted AE. If not dcmAcceptedCallingAETitle
tle(s) present, any AE will be accepted
Other AE Title(s) string Additional AE Title of Network AE - will also accept dcmOtherAETitle
Association RQs with such Called AE Title
Masquerade Calling AE Ti- string AE Title used for initiating network associations, mas- dcmMasqueradeCallingAETitle
tle(s) querading the actual AE Title for this Network AE - op-
tional prefix [<Called AE Title>] limits the masquerading
to association to a particular AE Title

Archive Network AE

DICOM Archive Network AE related information

Table 4.61: Archive Network AE Attributes (LDAP Object: dc-


mArchiveNetworkAE)

Name Type Description LDAP Attribute


Object Storage ID(s) string ID of Storage System on which received DICOM com- dcmObjectStorageID
posite objects are stored. Multiple Storage Systems may
be configured.
Object Storage Count integer Number of Storage Systems which are filled in parallel. dcmObjectStorageCount
Metadata Storage ID(s) string ID of Storage on which Metadata is stored in JSON for- dcmMetadataStorageID
mat - additionally to the complete DICOM composite ob-
ject. Multiple Storage Systems may be configured. If
absent, metadata is not stored additionally.
Co

4.4. Configuration 77
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.61 continued from previous page


Name Type Description LDAP Attribute
Aggregate Series Metadata string Delay in ISO-8601 duration format PnDTnHnMn.nS for dcmSeriesMetadataDelay
Delay storing aggregated Series Metadata on storage of objects
received by this AE. Overwrites value specified on De-
vice level.
Purge Instance Records De- string Delay in ISO-8601 duration format PnDTnHnMn.nS for dcmPurgeInstanceRecordsDela
lay purging Instance Records from the DB received by this
AE. Overwrites value specified on Device level.
Store Access Control ID string Access Control ID assigned to Studies received by this dcmStoreAccessControlID
AE
Store Access Control ID object Store Access Control Rules applied to Studies received dcmStoreAccessControlIDRule
Rule (s) by this AE
Access Control ID(s) string Access Control IDs assigned to Query/Retrieve requests dcmAccessControlID
received by this AE
Accepted Move Destina- string Accepted Move Destination in C-MOVE requests; any if dcmAcceptedMoveDestination
tion(s) absent.
Overwrite Policy string Overwrite Policy for Objects received by this AE. dcmOverwritePolicy
Overwrites value specified on Device level. Enumer-
ated values: NEVER, ALWAYS, SAME_SOURCE,
SAME_SERIES or SAME_SOURCE_AND_SERIES
Accept Missing Patient ID string Indicates if objects without Patient IDs shall be accepted dcmAcceptMissingPatientID
and if a Patient ID shall be created. Overwrites value
specified on Device level. Enumerated values: YES, NO
or CREATE
Accept Conflicting Patient string Indicates if objects with a Patient IDs which differs from dcmAcceptConflictingPatientID
ID the Patient ID in previous received objects of the Study
shall be accepted. Overwrites value specified on Device
level. Enumerated values: YES, NO or MERGED
Query/Retrieve View ID string Query/Retrieve View Identifier dcmQueryRetrieveViewID
Bulk Data Spool Directory string Path to Bulk Data Spool Directory. Overwrites value dcmBulkDataSpoolDirectory
specified on Device level.
Hide SPS with Status(s) string Scheduled Procedure Step Status codes of MWL items dcmHideSPSWithStatusFromM
which shall not be returned by the MWL SCP Enu-
merated values: SCHEDULED, ARRIVED, READY,
STARTED, DEPARTED, CANCELLED, DISCONTIN-
UED or COMPLETED
Validate Calling AE Host- boolean Validate Calling AE Hostname or IP Address of Associa- dcmValidateCallingAEHostnam
name tion requestors for this AE. Overwrites value specified on
Device level.
Person Name Component boolean Indicates if name component order insensitive match- dcmPersonNameComponentOr
Order Insensitive Matching ing is performed on fuzzy semantic matching of person
names by this AE. Overwrites value specified on Device
level.
Send Pending C-Get boolean Enables pending C-GET responses. Overwrites value dcmSendPendingCGet
specified on Device level.
Send Pending C-Move Inter- string Interval of pending C-MOVE responses in ISO-8601 du- dcmSendPendingCMoveInterva
val ration format PnDTnHnMn.nS; disabled if absent
Wado SR2 Html Template string Specifies URI for the style sheet used to render structured dcmWadoSR2HtmlTemplateUR
URI reports to html
Wado SR2 Text Template string Specifies URI for the style sheet used to render structured dcmWadoSR2TextTemplateURI
URI reports to plain text
Co

78 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.61 continued from previous page


Name Type Description LDAP Attribute
Query Max Number Of Re- integer Maximal number of return results by C-FIND SCP. If the dcmQueryMaxNumberOfResul
sults number of matches extends the limit, the C-FIND request
will be refused. 0 = no limitation. Overwrites value spec-
ified on Device level.
Qido Max Number Of Re- integer Maximal number of return results by QIDO-RS Service. dcmQidoMaxNumberOfResults
sults 0 = unlimited. Overwrites value specified on Device
level.
Mpps Forward Destina- string Destination to forward MPPS N-CREATE RQ and N- dcmFwdMppsDestination
tion(s) SET RQ
Ian Destination(s) string Destination to send IAN N-CREATE RQ dcmIanDestination
IAN Delay string Delay in ISO-8601 duration format PnDTnHnMn.nS af- dcmIanDelay
ter which an IAN for a received study is sent to config-
ured IAN destinations. If absent, IANs are triggered by
received MPPS
IAN Timeout string Timeout in ISO-8601 duration format PnDTnHnMn.nS dcmIanTimeout
for waiting on receive of instances referenced in MPPS;
check for completeness forever if absent
IAN On Timeout boolean Specifies if the IAN is sent if the timeout for waiting on dcmIanOnTimeout
receive of instances referenced is exceeded. Overwrites
value specified on Device level.
Fallback C-Move SCP string AE Title of external C-MOVE SCP to forward C-MOVE dcmFallbackCMoveSCP
RQs if the requested Entities are not managed by this
archive
Fallback C-Move SCP string Specifies threshold for Study Date in format YYYYM- dcmFallbackCMoveSCPStudyO
Study Older Than MDD for marking received Studies as (potential) incom-
plete to enforce the retrieve from configured dcmFall-
backCMoveSCP
Fallback C-Move SCP Des- string AE Title of local C-STORE-SCP to be set as Move Des- dcmFallbackCMoveSCPDestin
tination tination in C-MOVE RQs forwarded to the external C-
MOVE SCP specified by dcmFallbackCMoveSCP
Fallback C-Move SCP string AE Title of external C-FIND SCP for Verification of dcmFallbackCMoveSCPLeadin
Leading C-Find SCP Number of Instances retrieved from external C-MOVE
SCP specified by dcmFallbackCMoveSCP.
Fallback C-Move SCP Re- integer Maximal number of retries to retrieve not available ob- dcmFallbackCMoveSCPRetries
tries jects from C-MOVE SCP configured by dcmFallbackC-
MoveSCP. -1 = forever. Use value configured on Device
level, if absent
Alternative C-Move SCP string AE Title of alternative C-MOVE SCP to forward C- dcmAltCMoveSCP
MOVE RQs if the requested Entities are not located on
a local attached Storage
Diff Studies Attributes(s) string DICOM Tag as hex string of Attributes being compared dcmDiffStudiesIncludefieldAll
by the DIFF-RS service with Query Parameter include-
field=all. Use value configured on Device level, if absent.
Store Permission Service string URL of Store Permission Service which will be invoked dcmStorePermissionServiceUR
URL on receive of the first object of a study. {<dicom-
Tag>} will be replaced by the value of the attribute in
the object. E.g. http://host.name/storage-permission/
study/{0020000D}?patientId={00100020}&patientIdIssuer={00100021}&studyDescription
Overwrites value specified on Device level.
Co

4.4. Configuration 79
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.61 continued from previous page


Name Type Description LDAP Attribute
Store Permission Service string Regular Expression applied to responses from Store Per- dcmStorePermissionServiceRes
Response Pattern mission Service to determine agreement for storage. E.g.
validations*:s*true. Overwrites value specified on
Device level.
Store Permission Service string Regular Expression applied to responses from Store Per- dcmStorePermissionServiceExp
Expiration Date Pattern mission Service to extract the initial Study Expiration
Date. E.g. expirationdates*:s*([0-9]{8}). Over-
writes value specified on Device level.
Store Permission Service string Regular Expression applied to responses from Store Per- dcmStorePermissionServiceErr
Error Comment Pattern mission Service to extract Error Comment. E.g. error-
comments*:s*(.*). Overwrites value specified on De-
vice level.
Store Permission Service string Regular Expression applied to responses from Store Per- dcmStorePermissionServiceErr
Error Code Pattern mission Service to extract Error Code in hexadecimal.
E.g. errorcodes*:s*(p{XDigit}{4}). Overwrites
value specified on Device level.
Allow Rejection For Data string Allow Rejection For Data Retention Policy Ex- dcmAllowRejectionForDataRet
Retention Policy Expired pired. Overwrites value specified on Device
level. Enumerated values: NEVER, ALWAYS or
STUDY_RETENTION_POLICY
Accepted User Role(s) string Roles of users from which web requests are accepted; any dcmAcceptedUserRole
if absent.
Allow Delete Study perma- string Allow to delete Study permanently. REJECTED = only dcmAllowDeleteStudyPermane
nently already rejected Studies. Overwrites value specified on
Device level. Enumerated values: ALWAYS or RE-
JECTED
Default Character Set string Value of Specific Character Set (0008,0005) added to dcmDefaultCharacterSet
Data Sets without Specific Character Set (0008,0005) at-
tribute received by this Network AE. Overwrites value
specified on Device level.
Retrieve AE Title(s) string Specifies Retrieve AE Titles associated with DICOM dcmRetrieveAET
objects received by this Network AE. Overwrites value
specified on Device level.
External Retrieve AE Desti- string AE Title of local C-STORE-SCP to be set as Move Des- dcmExternalRetrieveAEDestina
nation tination in C-MOVE RQs forwarded to external retrieve
AE. Overwrites value specified on Device level.
Invoke Image Display Pa- string URL to launch external Image Display for a Pa- dcmInvokeImageDisplayPatien
tient URL tient. {} will be replaced by the Patient ID format-
ted as HL7 CX data type. E.g.: http://display:8080/
IHEInvokeImageDisplay?requestType=PATIENT&patientID={}.
Overwrites value specified on Device level.
Invoke Image Display Study string URL to launch external Image Display for dcmInvokeImageDisplayStudyU
URL a Study. {} will be replaced by the Study
Instance UID. E.g.: http://display:8080/
IHEInvokeImageDisplay?requestType=STUDY&studyUID={}.
Overwrites value specified on Device level.
Co

80 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.61 continued from previous page


Name Type Description LDAP Attribute
Copy Move Update Policy string Specifies update policy for attributes of the destination dcmCopyMoveUpdatePolicy
Study on Copy/Move of Instances from another Study.
If absent, the attributes will not be updated. Over-
writes value specified on Device level. Enumerated val-
ues: SUPPLEMENT, OVERWRITE, MERGED or RE-
PLACE
HL7 Procedure Status Up- string Application|Facility name of Sending Application for hl7PSUSendingApplication
date Sending Application HL7 Procedure Status Update. Overwrites value speci-
fied on Device level.
HL7 Procedure Status string Application|Facility name of Receiving Application for hl7PSUReceivingApplication
Update Receiving Applica- HL7 Procedure Status Update. Overwrites value speci-
tion(s) fied on Device level.
HL7 Procedure Status Up- string Delay in ISO-8601 duration format PnDTnHnMn.nS af- hl7PSUDelay
date Delay ter which an HL7 Procedure Status Update for a received
study is sent to configured HL7 receivers. If absent, HL7
Procedure Status Update is triggered by received MPPS.
Overwrites value specified on Device level.
HL7 Procedure Status Up- boolean Specifies if the Status of MWL Items in the DB is updated hl7PSUMWL
date MWL to COMPLETED for a received study after the configured
HL7 Procedure Status Update Delay. Overwrites value
specified on Device level.
HL7 Procedure Status Up- string Timeout in ISO-8601 duration format PnDTnHnMn.nS hl7PSUTimeout
date Timeout for waiting on receive of instances referenced in MPPS.
Overwrites value specified on Device level.
HL7 Procedure Status Up- boolean Specifies if the HL7 Procedure Status Update is sent if hl7PSUOnTimeout
date On Timeout the timeout for waiting on receive of instances referenced
is exceeded. Overwrites value specified on Device level.
Export Rule (s) object Export Rules. Supplements Export Rules specified on dcmExportRule
Device level.
RESTful Forward Rule (s) object RESTful Forward Rules. Supplements RESTful Forward dcmRSForwardRule
rules specified on Device level.
Archive Compression rule object Compression rules. Supplements Compression rules dcmArchiveCompressionRule
(s) specified on Device level.
Archive Attribute Coercion object Attribute Coercion of received/sent DIMSE. Supple- dcmArchiveAttributeCoercion
(s) ments Attribute Coercions specified on Device level.
Study Retention Policy (s) object Study Retention Policies. Supplements Study Retention dcmStudyRetentionPolicy
Policies specified on Device level.

dcm4che Device Attributes

dcm4che proprietary Device Attributes

4.4. Configuration 81
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.62: dcm4che Device Attributes Attributes (LDAP Object: dcmDcmDevice)


Name Type Description LDAP Attribute
Limit Open Associations integer Limit open DICOM connections; rejects Association re- dcmLimitOpenAssociations
quests if the limit is exceeded. 0 = unlimited.
Trust Store URL string URL of Trust Store with Certificates for DICOM nodes dcmTrustStoreURL
that are authorized to connect to this node; overrides di-
comAuthorizedNodeCertificateReference
Trust Store Type string Key Store Type of Trust Store specified by dcmTrust- dcmTrustStoreType
StoreURL. Enumerated values: JKS or PKCS12
Trust Store Pin string Key Store Password of Trust Store specified by Trust dcmTrustStorePin
Store URL
Trust Store Pin Property string System property of Key Store Password of Trust Store dcmTrustStorePinProperty
specified by Trust Store URL
Key Store URL string URL of Key Store with private Key and certificate used dcmKeyStoreURL
to identify this DICOM node in TLS connections
Key Store Type string Key Store Type of Key Store specified by Key Store URL. dcmKeyStoreType
Enumerated values: JKS or PKCS12
Key Store Pin string Key Store Password of Key Store specified by Key Store dcmKeyStorePin
URL
Key Store Pin Property string System property of Key Store Password of Key Store dcmKeyStorePinProperty
specified by Key Store URL
Key Store Key Pin string Key Password of Key Store specified by Key Store URL dcmKeyStoreKeyPin
Key Store Key Pin Property string System property of Key Password of Key Store specified dcmKeyStoreKeyPinProperty
by Key Store URL
Time Zone of Device string Time Zone ID of the Device; matches Java TimeZone ID dcmTimeZoneOfDevice

HL7 Application

HL7 Application information

Table 4.63: HL7 Application Attributes (LDAP Object: hl7Application)


Name Type Description LDAP Attribute
HL7 Application name string HL7 Application and Facility name (Applica- hl7ApplicationName
tion|Facility)
Network Connection Refer- string The JSON Pointers to the Network Connection objects dicomNetworkConnectionRefer
ence(s) for this HL7 Application
Accepted Sending Applica- string Application|Facility name of accepted Sending Applica- hl7AcceptedSendingApplicatio
tion(s) tion(s); any if absent
Other HL7 Application string Additional HL7 Application and Facility name (Applica- hl7OtherApplicationName
Name(s) tion|Facility) - will also accept HL7 messages with such
Receiving Application and Facility name
Accepted Message Type(s) string Message Type(s) (MessageType^TriggerEvent) of ac- hl7AcceptedMessageType
cepted messages
Default Character Set string Character Set used to decode received messages if not hl7DefaultCharacterSet
specified by MSH-18.
installed boolean True if the HL7 Application is installed on network. If dicomInstalled
not present, information about the installed status of the
HL7 Application is inherited from the device
Archive HL7 Application object DICOM Archive HL7 Application related information dcmArchiveHL7Application

82 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Archive HL7 Application

DICOM Archive HL7 Application related information

Table 4.64: Archive HL7 Application Attributes (LDAP Object: dcmArchiveHL7Application)


Name Type Description LDAP Attribute
AE Title string Archive AE Title associated with this HL7 Application. dicomAETitle
HL7 Patient Update Tem- string Specifies URI for the style sheet used by HL7v2 Patient hl7PatientUpdateTemplateURI
plate URI Update Service. Overwrites value specified on Device
level.
HL7 Import Report Tem- string Specifies URI for the style sheet to transcode received hl7ImportReportTemplateURI
plate URI HL7 ORU^R01 to DICOM SR. Overwrites value speci-
fied on Device level.
HL7 Schedule Procedure string Specifies URI for the style sheet to transcode received hl7ScheduleProcedureTemplateU
Template URI HL7 ORM^O01, OMI^O23, OMG^O19 to DICOM
MWL items. Overwrites value specified on Device level.
HL7 Schedule Protocol string Specifies location of Scheduled Protocol Code in re- hl7ScheduledProtocolCodeInOrd
Code in Order ceived HL7 Order message. Overwrites value speci-
fied on Device level. Enumerated values: OBR_4_1 or
OBR_4_4
HL7 Schedule Station AET string Specifies location of Scheduled Station AE Title in re- hl7ScheduledStationAETInOrder
in Order ceived HL7 Order message. Not effective for HL7 v2.5.1
OMI^O23 with IPC segment. Overwrites value specified
on Device level. Enumerated values: ORC_18
HL7 Log File Pattern string Path to HL7 messages which will be captured exactly as hl7LogFilePattern
received. If absent, there is no logging. Overwrites value
specified on Device level.
HL7 Error Log File Pattern string Path to HL7 messages which will be captured exactly as hl7ErrorLogFilePattern
received, when processing of HL7 messages fails. If ab-
sent, there is no logging. Overwrites value specified on
Device level.
HL7 No Patient Create Mes- string Message Type(s) (MessageType^TriggerEvent) of HL7 hl7NoPatientCreateMessageType
sage Type(s) messages which are only processed, if there is already a
Patient record in the database, which Patient ID matches
the Patient ID in the PID or MRG segment of the mes-
sage. Thus no new Patient record will be created by mes-
sages of the specified types. Overwrites value specified
on Device level.
HL7 Forward Rule (s) object HL7 Forward Rule. Supplements values specified on De- hl7ForwardRule
vice level.
Scheduled Station for HL7 object Scheduled Station selected on MWL HL7 Order Feed. hl7OrderScheduledStation
Order (s) Supplements values specified on Device level.
SPS Status for HL7 Order object Specifies SPS Status of DICOM MWL items cre- hl7OrderSPSStatus
(s) ated/updated on received HL7 ORM^O01, OMI^O23,
OMG^O19 messages. Overwrites values specified on
Device level.

Image Writer

Specifies Java Image IO Image Writer and Write Parameter used for compressing DICOM images

4.4. Configuration 83
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.65: Image Writer Attributes (LDAP Object: dcmImageWriter)


Name Type Description LDAP Attribute
Transfer Syntax string Transfer Syntax to which to compress the DICOM image dicomTransferSyntax
Image IO Writer Format string Image IO Writer Format Name dcmIIOFormatName
Name
Java Class Name string Fully qualified Java class of Image IO Writer. If absent, dcmJavaClassName
use any Image Writer found for specified Format Name
Patch JPEG-LS string Patch JPEG-LS after compressing Enumerated values: dcmPatchJPEGLS
JAI2ISO, ISO2JAI or ISO2JAI_IF_APP_OR_COM
Image Write Param(s) string Image Write Parameter(s) (name=value) set at on Image dcmImageWriteParam
Writer before compression

Image Reader

Specifies Java Image IO Image Readers used for decompressing compressed DICOM images

Table 4.66: Image Reader Attributes (LDAP Object: dcmImageReader)


Name Type Description LDAP Attribute
Transfer Syntax string Transfer Syntax of compressed DICOM image dicomTransferSyntax
Image IO Reader Format string Image IO Reader Format Name dcmIIOFormatName
Name
Java Class Name string Fully qualified Java class of Image IO Reader. If absent, dcmJavaClassName
use any Image Reader found for specified Format Name
Patch JPEG-LS string Patch JPEG-LS before decompressing Enumerated val- dcmPatchJPEGLS
ues: JAI2ISO, ISO2JAI or ISO2JAI_IF_APP_OR_COM

Audit Logger

Audit Logger related information

84 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.67: Audit Logger Attributes (LDAP Object: dcmAuditLogger)


Name Type Description LDAP Attribute
Name string Arbitrary/Meaningful name for the Audit Logger object cn
Network Connection Refer- string The JSON Pointers to the Network Connection objects dicomNetworkConnectionRefer
ence(s) used by this Audit Logger
Audit Record Repository string Device Name of Audit Record Repository to which Audit dcmAuditRecordRepositoryDev
Device Name Messages are sent
Source ID string RFC 3881 Audit Source ID; device name if absent dcmAuditSourceID
Enterprise Site ID string RFC 3881 Audit Enterprise Site ID; value dicomInsti- dcmAuditEnterpriseSiteID
tutionName is replaced by the institution name of the
DICOM device
Source Type Code(s) string RFC 3881 Audit Source Type Code; value dicomPrima- dcmAuditSourceTypeCode
ryDeviceType is replaced by the primary type of the DI-
COM device
Syslog Facility string RFC 5424 Syslog Facility string value of audit message. dcmAuditFacility
Enumerated values: kern, user, mail, daemon, auth, sys-
log, lpr, news, uucp, cron, authpriv, ftp, ntp, audit, con-
sole, cron2, local0, local1, local2, local3, local4, local5,
local6 or local7
Syslog Severity - Success string RFC 5424 Syslog Severity string value of audit message dcmAuditSuccessSeverity
with Event Outcome Indicator 0 (Success). Enumerated
values: emerg, alert, crit, err, warning, notice, info or
debug
Syslog Severity - Failure string RFC 5424 Syslog Severity string value of audit message dcmAuditMinorFailureSeverity
with Event Outcome Indicator 4 (Minor failure). Enu-
merated values: emerg, alert, crit, err, warning, notice,
info or debug
Syslog Severity - Failure string RFC 5424 Syslog Severity string value of audit message dcmAuditSeriousFailureSeverit
with Event Outcome Indicator 8 (Serious failure). Enu-
merated values: emerg, alert, crit, err, warning, notice,
info or debug
Syslog Severity - Major string RFC 5424 Syslog Severity string value of audit message dcmAuditMajorFailureSeverity
with Event Outcome Indicator 12 (Major failure). Enu-
merated values: emerg, alert, crit, err, warning, notice,
info or debug
Syslog Application Name string RFC 5424 Syslog APP-NAME of audit message; Audit dcmAuditApplicationName
Source ID if absent
Syslog Message ID string RFC 5424 Syslog MSGID of audit message. dcmAuditMessageID
Message Encoding string Character encoding of RFC 5424 Syslog MSG part of au- dcmAuditMessageEncoding
dit message.
Message BOM boolean Enable/disable Unicode BOM prefix of RFC 5424 Syslog dcmAuditMessageBOM
MSG part of audit message; include BOM if absent
Timestamp in UTC boolean Specify if RFC 5424 Syslog TIMESTAMP and the Event dcmAuditTimestampInUTC
Date/Time of the audit message are specified in Coordi-
nated Universal Time. Default indicates it will be in Lo-
cal Time zone.
Message Format XML boolean Specify whether or not the XML audit message is format- dcmAuditMessageFormatXML
ted with line feeds and indentation.
Message Schema URI string URI of DICOM Audit Message Schema referenced in au- dcmAuditMessageSchemaURI
dit message
Include Instance UIDs boolean Indicates if Audit Log Message should contain optional dcmAuditIncludeInstanceUID
Instance UIDs
Spool Directory URI string URI of spool directory used to store messages which dcmAuditLoggerSpoolDirector
could not delivered to the record repository; use system
4.4. Configuration temporary directory if absent. 85
Retry Interval integer Retry interval in s to re-sent messages which could not dcmAuditLoggerRetryInterval
delivered to the record repository; do no retry to re-sent
messages if absent
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Audit Suppress Criteria

Audit Suppress Criteria

Table 4.68: Audit Suppress Criteria Attributes (LDAP Object: dcmAuditSuppressCriteria)


Name Type Description LDAP Attribute
Name string Arbitrary/Meaningful name of the Audit Suppress Crite- cn
ria
Audit Event ID(s) string RFC 3881 Audit Event ID code and codeSystemName in dcmAuditEventID
format (CV, CSD, CM)
Audit Event Type Code(s) string RFC 3881 Audit Event Type code in format (CV, CSD, dcmAuditEventTypeCode
CM)
Event Action Code(s) string RFC 3881 Audit Event Action Type code. Enumerated dcmAuditEventActionCode
values: C, R, U, D or E
Event Outcome Indicator(s) string RFC 3881 Audit Event Outcome Indicator. Enumerated dcmAuditEventOutcomeIndicat
values: 0, 4, 8 or 12
User ID(s) string RFC 3881 Audit Active Participant User ID dcmAuditUserID
Alternative User ID(s) string RFC 3881 Audit Active Participant Alternative User ID dcmAuditAlternativeUserID
User Role ID Code(s) string RFC 3881 Audit Active Participant User Role ID code in dcmAuditUserRoleIDCode
format (CV, CSD, CM)
Network Access Point ID(s) string RFC 3881 Audit Active Participant Network Access dcmAuditNetworkAccessPointI
Point ID
User is Requestor boolean Indicates if Active Participant is initiator/requestor of the dcmAuditUserIsRequestor
Audit Event as specified by RFC 3881

Audit Record Repository

Audit Record Repository related information

Table 4.69: Audit Record Repository Attributes (LDAP Object: dcmAuditRecordRepository)


Name Type Description LDAP Attribute
Network Connection Refer- string The JSON Pointers to the Network Connection objects of dicomNetworkConnectionRefer
ence(s) this Audit Record Repository
installed boolean True if the ARR is installed on network. If not present, dicomInstalled
information about the installed status of the ARR is in-
herited from the device

Archive Device

DICOM Archive Device related information

86 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.70: Archive Device Attributes (LDAP Object: dcmArchiveDe-


vice)

Name Type Description LDAP Attribute


Fuzzy Algorithm Class string Specifies Fuzzy Algorithm Implementation Class. Enu- dcmFuzzyAlgorithmClass
merated values: org.dcm4che3.soundex.Soundex,
org.dcm4che3.soundex.ESoundex,
org.dcm4che3.soundex.ESoundex9,
org.dcm4che3.soundex.Metaphone,
org.dcm4che3.soundex.KPhonetik or
org.dcm4che3.soundex.Phonem
Series Metadata Storage string ID of Storage on which ZIP archives with aggregated dcmSeriesMetadataStorageID
ID(s) Metadata of all instances of a Series is stored. Multiple
Storage Systems may be configured. If absent, no aggre-
gated Series Metadata will be stored.
Aggregate Series Metadata string Delay in ISO-8601 duration format PnDTnHnMn.nS for dcmSeriesMetadataDelay
Delay storing aggregated Series Metadata on storage. If absent,
no aggregated Series Metadata will be stored.
Update Series Metadata string Polling Interval for Series scheduled for Metadata update dcmSeriesMetadataPollingInte
Polling Interval in ISO-8601 duration format PnDTnHnMn.nS. If absent,
no aggregated Series Metadata will be stored.
Update Series Metadata integer Maximal number of Series scheduled for Metadata up- dcmSeriesMetadataFetchSize
Fetch Size date fetched by one query.
Remove Instance Records string Delay in ISO-8601 duration format PnDTnHnMn.nS for dcmPurgeInstanceRecordsDela
Delay purging Instance Records from the DB. If absent, In-
stance Records will never be purged. May be overwrit-
ten by configured values for particular Archive Network
AEs.
Remove Instance Records string Polling Interval for Series scheduled for purging In- dcmPurgeInstanceRecordsPolli
Polling Interval stance Records from the DB in ISO-8601 duration format
PnDTnHnMn.nS. If absent, Instance Records will not be
purged.
Remove Instance Records integer Maximal number of Series scheduled for purging In- dcmPurgeInstanceRecordsFetc
Fetch Size stance Records from the DB fetched by one query.
Query/Retrieve View ID string Query/Retrieve View Identifier dcmQueryRetrieveViewID
Overwrite Policy string Overwrite Policy for the whole Archive Device. dcmOverwritePolicy
May be overwritten by configured values for par-
ticular Archive Network AEs. Enumerated values:
NEVER, ALWAYS, SAME_SOURCE, SAME_SERIES
or SAME_SOURCE_AND_SERIES
Accept Missing Patient ID string Indicates if objects without Patient IDs shall be accepted dcmAcceptMissingPatientID
and if a Patient ID shall be created. May be overwrit-
ten by configured values for particular Archive Network
AEs. Enumerated values: YES, NO or CREATE
Accept Conflicting Patient string Indicates if objects with a Patient IDs which differs from dcmAcceptConflictingPatientID
ID the Patient ID in previous received objects of the Study
shall be accepted. May be overwritten by configured val-
ues for particular Archive Network AEs. Enumerated
values: YES, NO or MERGED
Bulk Data Spool Directory string Path to Bulk Data Spool Directory. May be overwrit- dcmBulkDataSpoolDirectory
ten by configured values for particular Archive Network
AEs.
Co

4.4. Configuration 87
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.70 continued from previous page


Name Type Description LDAP Attribute
Hide SPS with Status(s) string Scheduled Procedure Step Status codes of MWL items dcmHideSPSWithStatusFromM
which shall not be returned by the MWL SCP Enu-
merated values: SCHEDULED, ARRIVED, READY,
STARTED, DEPARTED, CANCELLED, DISCONTIN-
UED or COMPLETED
Validate Calling AE Host- boolean Validate Calling AE Hostname or IP Address of Associa- dcmValidateCallingAEHostnam
name tion requestors. May be overwritten by configured values
for particular Archive Network AEs.
Person Name Component boolean Indicates if name component order insensitive match- dcmPersonNameComponentOr
Order Insensitive Matching ing is performed on fuzzy semantic matching of person
names. May be overwritten by configured values for par-
ticular Archive Network AEs.
Send Pending C-Get boolean Enables pending C-GET responses. May be overwrit- dcmSendPendingCGet
ten by configured values for particular Archive Network
AEs.
Send Pending C-Move Inter- string Interval of pending C-MOVE responses in ISO-8601 du- dcmSendPendingCMoveInterva
val ration format PnDTnHnMn.nS; disabled if absent
Wado Supported SR string Supported SR SOP classes for WADO retrieval dcmWadoSupportedSRClasses
Classes(s)
Wado SR2 Html Template string Specifies URI for the style sheet used to render structured dcmWadoSR2HtmlTemplateUR
URI reports to html
Wado SR2 Text Template string Specifies URI for the style sheet used to render structured dcmWadoSR2TextTemplateURI
URI reports to plain text
Query Fetch Size integer Number of rows fetched from the database at once by the dcmQueryFetchSize
Query Service.
Query Max Number Of Re- integer Maximal number of return results by C-FIND SCP. If the dcmQueryMaxNumberOfResul
sults number of matches extends the limit, the C-FIND request
will be refused. 0 = no limitation. May be overwritten by
configured values for particular Archive Network AEs.
Qido Max Number Of Re- integer Maximal number of return results by QIDO-RS Service. dcmQidoMaxNumberOfResults
sults 0 = no limitation. May be overwritten by configured val-
ues for particular Archive Network AEs.
Mpps Forward Destina- string Destination to forward MPPS N-CREATE RQ and N- dcmFwdMppsDestination
tion(s) SET RQ
Ian Destination(s) string Destination to send IAN N-CREATE RQ dcmIanDestination
IAN Delay string Delay in ISO-8601 duration format PnDTnHnMn.nS af- dcmIanDelay
ter which an IAN for a received study is sent to config-
ured IAN destinations. If absent, IANs are triggered by
received MPPS
IAN Timeout string Timeout in ISO-8601 duration format PnDTnHnMn.nS dcmIanTimeout
for waiting on receive of instances referenced in MPPS;
check for completeness forever if absent
IAN On Timeout boolean Specifies if the IAN is sent if the timeout for waiting on dcmIanOnTimeout
receive of instances referenced is exceeded. May be over-
written by configured values for particular Archive Net-
work AEs.
IAN Task Polling Interval string Polling Interval for IAN Tasks in ISO-8601 duration for- dcmIanTaskPollingInterval
mat PnDTnHnMn.nS. IAN disabled, if absent
IAN Task Fetch Size integer Maximal number of IAN Tasks scheduled in one transac- dcmIanTaskFetchSize
tion.
Co

88 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.70 continued from previous page


Name Type Description LDAP Attribute
Fallback C-Move SCP string AE Title of external C-MOVE SCP to forward C-MOVE dcmFallbackCMoveSCP
RQs if the requested Entities are not managed by this
archive
Fallback C-Move SCP Des- string AE Title of local C-STORE-SCP to be set as Move Des- dcmFallbackCMoveSCPDestin
tination tination in C-MOVE RQs forwarded to the external C-
MOVE SCP specified by dcmFallbackCMoveSCP
Fallback C-Move SCP string Specifies threshold for Study Date in format YYYYM- dcmFallbackCMoveSCPStudyO
Study Older Than MDD for marking received Studies as (potential) incom-
plete to enforce the retrieve from configured dcmFall-
backCMoveSCP
Fallback C-Move SCP string AE Title of external C-FIND SCP for Verification of dcmFallbackCMoveSCPLeadin
Leading C-Find SCP Number of Instances retrieved from external C-MOVE
SCP specified by dcmFallbackCMoveSCP.
Fallback C-Move SCP Re- integer Maximal number of retries to retrieve not available ob- dcmFallbackCMoveSCPRetries
tries jects from C-MOVE SCP configured by dcmFallbackC-
MoveSCP. -1 = forever.
Alternative C-Move SCP string AE Title of alternative C-MOVE SCP to forward C- dcmAltCMoveSCP
MOVE RQs if the requested Entities are not located on
a local attached Storage
Diff Studies Attributes(s) string DICOM Tag as hex string of Attributes being compared dcmDiffStudiesIncludefieldAll
by the DIFF-RS service with Query Parameter include-
field=all. Use QIDO-RS STUDY Returned Attributes, if
absent.
Export Task Polling Interval string Export Task Polling Interval in ISO-8601 duration format dcmExportTaskPollingInterval
PnDTnHnMn.nS
Export Task Fetch Size integer Maximal number of Export Tasks scheduled in one trans- dcmExportTaskFetchSize
action.
Purge Storage Polling Inter- string Polling Interval for deleting objects in ISO-8601 duration dcmPurgeStoragePollingInterv
val format PnDTnHnMn.nS
Purge Storage Fetch Size integer Maximal number of objects to delete in one task. dcmPurgeStorageFetchSize
Delete Study Batch Size integer number of studies to delete from the Storage System, if dcmDeleteStudyBatchSize
the usable space fall below configured Usable Space, be-
fore checking the usable space again.
Delete Patient On Delete boolean Specifies if a Patient shall be deleted on deletion of its dcmDeletePatientOnDeleteLas
Last Study last study.
Delete Rejected Polling In- string Polling Interval for deleting rejected instances from the dcmDeleteRejectedPollingInter
terval DB in ISO-8601 duration format PnDTnHnMn.nS
Delete Rejected Fetch Size integer Maximal number of rejected instances to delete from the dcmDeleteRejectedFetchSize
DB in one task.
Maximum Access Time string Maximal staleness of recorded study accession time in dcmMaxAccessTimeStaleness
Staleness ISO-8601 duration format PnDTnHnMn.nS. Update of
the access time disabled, if absent.
AE Cache Stale Timeout string Maximal staleness of cached AE in ISO-8601 duration dcmAECacheStaleTimeout
format PnDTnHnMn.nS. If absent, cached AE entries
will not be refetched from LDAP.
Leading C-Find SCP Query string Maximal staleness of cached Patient and Study attributes dcmLeadingCFindSCPQueryC
Cache Stale Timeout fetched from leading C-Find SCP in ISO-8601 duration
format PnDTnHnMn.nS. If absent, cache Study attributes
are only removed on reaching the maximal cache size.
Co

4.4. Configuration 89
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.70 continued from previous page


Name Type Description LDAP Attribute
Leading C-Find SCP Query integer Maximum number of cached Patient and Study attributes dcmLeadingCFindSCPQueryC
Cache Size fetched from leading C-Find SCP.
Audit Spool Directory string Path to Audit Service Spool Directory. dcmAuditSpoolDirectory
Audit Polling Interval string Polling Interval for aggregating Audit Messages in ISO- dcmAuditPollingInterval
8601 duration format PnDTnHnMn.nS. Audit Message
aggregation disabled, if absent.
Audit Aggregate Duration string Audit Message Aggregation Duration in ISO-8601 dura- dcmAuditAggregateDuration
tion format PnDTnHnMn.nS. Audit Message aggregation
disabled, if absent.
Audit Unknown Study In- string Indicates study instance uid value to be sent in audit mes- dcmAuditUnknownStudyInstan
stance UID sage when not known.
Audit Unknown Patient ID string Indicates patient id value to be sent in audit message dcmAuditUnknownPatientID
when not known.
Show Patient Info In System string Specifies if Patient Information is shown as dcmShowPatientInfoInSystemL
Log plain text or hashed in system logs. Enumer-
ated values: PLAIN_TEXT, HASH_NAME or
HASH_NAME_AND_ID
Show Patient Info In Audit string Specifies if Patient Information is shown as plain dcmShowPatientInfoInAuditLog
Log text or hashed in emitted audit messages. Enu-
merated values: PLAIN_TEXT, HASH_NAME or
HASH_NAME_AND_ID
STOW-RS Spool Directory string Path to Directory used by STOW-RS Service to spool dcmStowSpoolDirectory
Bulkdata of XML/JSON Metadata and Bulk Data Re-
quest Messages.
HL7 Patient Update Tem- string Specifies URI for the style sheet used by HL7v2 Patient hl7PatientUpdateTemplateURI
plate URI Update Service. May be overwritten by configured values
for particular Archive HL7 Application.
HL7 Import Report Tem- string Specifies URI for the style sheet to transcode received hl7ImportReportTemplateURI
plate URI HL7 ORU^R01 to DICOM SR. May be overwritten by
configured values for particular Archive HL7 Applica-
tion.
HL7 Schedule Procedure string Specifies URI for the style sheet to transcode received hl7ScheduleProcedureTemplate
Template URI HL7 ORM^O01, OMI^O23, OMG^O19 to DICOM
MWL items. May be overwritten by configured values
for particular Archive HL7 Application.
HL7 Schedule Protocol string Specifies location of Scheduled Protocol Code in re- hl7ScheduledProtocolCodeInO
Code in Order ceived HL7 Order message. May be overwritten by con-
figured values for particular Archive HL7 Application.
Enumerated values: OBR_4_1 or OBR_4_4
HL7 Schedule Station AET string Specifies location of Scheduled Station AE Title in re- hl7ScheduledStationAETInOrd
in Order ceived HL7 Order message. Not effective for HL7 v2.5.1
OMI^O23 with IPC segment. If absent or no value is
provided in the configured field, the Scheduled Station
AE Title is selected according configured rules. May be
overwritten by configured values for particular Archive
HL7 Application. Enumerated values: ORC_18
HL7 Log File Pattern string Path to HL7 messages which will be captured exactly as hl7LogFilePattern
received. If absent, there is no logging. May be over-
written by configured values for particular Archive HL7
Application.
Co

90 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.70 continued from previous page


Name Type Description LDAP Attribute
HL7 Error Log File Pattern string Path to HL7 messages which will be captured exactly as hl7ErrorLogFilePattern
received, when processing of HL7 messages fails. If ab-
sent, there is no logging. May be overwritten by config-
ured values for particular Archive HL7 Application.
HL7 No Patient Create Mes- string Message Type(s) (MessageType^TriggerEvent) of HL7 hl7NoPatientCreateMessageTy
sage Type(s) messages which are only processed, if there is already a
Patient record in the database, which Patient ID matches
the Patient ID in the PID or MRG segment of the mes-
sage. Thus no new Patient record will be created by mes-
sages of the specified types. May be overwritten by con-
figured values for particular Archive HL7 Application.
Unzip Vendor Data To URI string Specifies URI of directory into which ZIP stream in De- dcmUnzipVendorDataToURI
vice Vendor Data attribute will be extracted
Purge Queue Messages string Polling Interval for purging queue messages in ISO-8601 dcmPurgeQueueMessagePollin
Polling Interval duration format PnDTnHnMn.nS. If absent, there is no
deletion
Wado-RS Spool Directory string Path to Wado-RS spool directory used to aggregate un- dcmWadoSpoolDirectory
compressed frames.
Reject Expired Studies string Polling Interval for rejecting expired Studies and Series dcmRejectExpiredStudiesPollin
Polling Interval in ISO-8601 duration format PnDTnHnMn.nS. If absent,
neither expired Studies nor Series will be rejected auto-
matically
Reject Expired Studies string Time when the polling interval for rejecting expired dcmRejectExpiredStudiesPollin
Polling Start Time Studies and Series starts in ISO-8601 time format
[hh][mm][ss]. Archive start time if absent.
Reject Expired Studies integer Maximal number of expired Studies fetched in one query; dcmRejectExpiredStudiesFetch
Fetch Size If absent, expired Studies will not be rejected automati-
cally
Reject Expired Series Fetch integer Maximal number of expired Series fetched in one query; dcmRejectExpiredSeriesFetchS
Size If absent, expired Series will not be rejected automati-
cally
Reject Expired Studies AE string AE Title of Local Application Entity performing the au- dcmRejectExpiredStudiesAETit
Title tomatic rejection of expired Studies and Series. If absent,
neither expired Studies nor Series will be rejected auto-
matically.
Store Permission Service string URL of Store Permission Service which will be invoked dcmStorePermissionServiceUR
URL on receive of the first object of a study by any AE. {<di-
comTag>} will be replaced by the value of the attribute
in the object. E.g. http://host.name/storage-permission/
study/{0020000D}?patientId={00100020}&patientIdIssuer={00100021}&studyDescription
May be overwritten by configured value for particular
Archive Network AEs.
Store Permission Service string Regular Expression applied to responses from Store Per- dcmStorePermissionServiceRes
Response Pattern mission Service to determine agreement for storage. E.g.
validations*:s*true . If absent, every success re-
sponse will be treated as agreement for storage. May
be overwritten by configured value for particular Archive
Network AEs.
Co

4.4. Configuration 91
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.70 continued from previous page


Name Type Description LDAP Attribute
Store Permission Cache string Maximal staleness of cached responses from Stor- dcmStorePermissionCacheStale
Stale Timeout age Permission Service in ISO-8601 duration format
PnDTnHnMn.nS. If absent, cached responses are only re-
moved on reaching the maximal cache size.
Store Permission Cache Size integer Maximum number of cached responses from Storage Per- dcmStorePermissionCacheSize
mission Service.
Merge MWL Cache Stale string Maximal staleness of Request Attributes extracted from dcmMergeMWLCacheStaleTim
Timeout matching DICOM MWL items in ISO-8601 duration
format PnDTnHnMn.nS. If absent, cached Request At-
tributes are only removed on reaching the maximal cache
size.
Merge MWL Cache Size integer Maximum number of cached Request Attributes ex- dcmMergeMWLCacheSize
tracted from matching DICOM MWL items.
Store Update DB Maximum integer Maximum number of retries to update the database on dcmStoreUpdateDBMaxRetries
Number of Retries storage.
Store Update DB Maximum integer Maximum delay in ms of retry to update the database on dcmStoreUpdateDBMaxRetryD
Delay of Retry storage.
Allow Rejection For Data string Allow Rejection For Data Retention Policy Expired. dcmAllowRejectionForDataRet
Retention Policy Expired May be overwritten by configured values for particular
Archive Network AEs. Enumerated values: NEVER,
ALWAYS or STUDY_RETENTION_POLICY
Allow Delete Study perma- string Allow to delete Study permanently. REJECTED = only dcmAllowDeleteStudyPermane
nently already rejected Studies. May be overwritten by config-
ured values for particular Archive Network AEs. Enu-
merated values: ALWAYS or REJECTED
Store Permission Service string Regular Expression applied to responses from Store Per- dcmStorePermissionServiceExp
Expiration Date Pattern mission Service to extract the initial Study Expiration
Date. E.g. expirationdates*:s*([0-9]{8}). If absent,
locally configured Study Retention Policy Rules will be
applied. May be overwritten by configured values for par-
ticular Archive Network AEs.
Purge Storage Commitment string Delay in ISO-8601 duration format PnDTnHnMn.nS af- dcmPurgeStgCmtCompletedDe
Completed Delay ter which results of completed Storage Commitment re-
quests are purged. If absent, there is no deletion.
Purge Storage Commitment string Polling Interval for purging Storage Commitment Results dcmPurgeStgCmtPollingInterva
Polling Interval in ISO-8601 duration format PnDTnHnMn.nS. If absent,
there is no deletion
Default Character Set string Value of Specific Character Set (0008,0005) added to dcmDefaultCharacterSet
Data Sets without Specific Character Set (0008,0005) at-
tribute received by any AE. May be overwritten by con-
figured values for particular Archive Network AEs.
Store Permission Service string Regular Expression applied to responses from Store Per- dcmStorePermissionServiceErr
Error Comment Pattern mission Service to extract Error Comment. E.g. error-
comments*:s*(.*). If absent, Storage denied. will
be used as Error Comment. May be overwritten by con-
figured values for particular Archive Network AEs.
Co

92 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.70 continued from previous page


Name Type Description LDAP Attribute
Store Permission Service string Regular Expression applied to responses from Store Per- dcmStorePermissionServiceErr
Error Code Pattern mission Service to extract Error Code in hexadecimal.
E.g. errorcodes*:s*(p{XDigit}{4}). If absent, the
Error Code will be 0124H (Not Authorized). May be
overwritten by configured values for particular Archive
Network AEs.
Retrieve AE Title(s) string Specifies Retrieve AE Titles associated with received DI- dcmRetrieveAET
COM objects. If absent, the Called AE Title of the receiv-
ing AE will be used. May be overwritten by configured
values for particular Archive Network AEs.
External Retrieve AE Desti- string AE Title of local C-STORE-SCP to be set as Move Des- dcmExternalRetrieveAEDestina
nation tination in C-MOVE RQs forwarded to external retrieve
AE. May be overwritten by configured values for partic-
ular Archive Network AEs.
XDS-I Imaging Document string AE Title of local Application Entity associated with dcmXDSiImagingDocumentSou
Source AE Title XDS-I Imaging Document Source.
Attribute Filter (s) object Specifies Attributes stored in the database dcmAttributeFilter
Attribute Set (s) object Named Attribute Set for Query Parameter compare- dcmAttributeSet
field of DIFF-RS and Query Parameter includefields
of WADO-RS Metadata requests.
Remap Retrieve URL string Remap Retrieve URL used in QIDO-RS and WADO- dcmRemapRetrieveURL
RS Metadata responses. Optionally prefixed with
[<http-client-host>]. E.g.: [cache-proxy]http://cache-
proxy:8080. If absent or if the specified <http-client-
host> does not match, scheme and server authority of the
QIDO-RS or WADO-RS request URL are used.
Audit Record Repository string Access URL of Audit Record Repository. E.g. http:// dcmAuditRecordRepositoryUR
URL kibana:5601
Elastic Search URL string Access URL of Elastic Search. E.g. http://elasticsearch: dcmElasticSearchURL
9200
Audit to json+fhir Template string Specifies URI for the style sheet to transcode Audit Mes- dcmAudit2JsonFhirTemplateUR
URI sage to a FHIR JSON Resource Audit Event
Audit to xml+fhir Template string Specifies URI for the style sheet to transcode Audit Mes- dcmAudit2XmlFhirTemplateUR
URI sage to a FHIR XML Resource Audit Event
Invoke Image Display Pa- string URL to launch external Image Display for a Pa- dcmInvokeImageDisplayPatien
tient URL tient. {} will be replaced by the Patient ID format-
ted as HL7 CX data type. E.g.: http://display:8080/
IHEInvokeImageDisplay?requestType=PATIENT&patientID={}.
May be overwritten by configured value for particular
Archive Network AEs.
Invoke Image Display Study string URL to launch external Image Display for dcmInvokeImageDisplayStudyU
URL a Study. {} will be replaced by the Study
Instance UID. E.g.: http://display:8080/
IHEInvokeImageDisplay?requestType=STUDY&studyUID={}.
May be overwritten by configured value for particular
Archive Network AEs.
Co

4.4. Configuration 93
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.70 continued from previous page


Name Type Description LDAP Attribute
Copy Move Update Policy string Specifies update policy for attributes of the destination dcmCopyMoveUpdatePolicy
Study on Copy/Move of Instances from another Study. If
absent, the attributes will not be updated. May be over-
written by configured values for particular Archive Net-
work AEs. Enumerated values: SUPPLEMENT, OVER-
WRITE, MERGED or REPLACE
HL7 ADT Sending Applica- string Application|Facility name of Sending Application for hl7ADTSendingApplication
tion HL7 ADT messages to synchronize external systems
about performed Patient Information updates. If absent,
synchronization of external systems by HL7 ADT mes-
sages is disabled.
HL7 ADT Receiving Appli- string Application|Facility name of Receiving Application for hl7ADTReceivingApplication
cation(s) HL7 ADT messages to synchronize external systems
about performed Patient Information updates. If absent,
synchronization of external systems by HL7 ADT mes-
sages is disabled.
HL7 Procedure Status Up- string Application|Facility name of Sending Application for hl7PSUSendingApplication
date Sending Application HL7 Procedure Status Update. HL7 Procedure Status
Update disabled, if absent. May be overwritten by con-
figured values for particular Archive Network AEs.
HL7 Procedure Status string Application|Facility name of Receiving Application for hl7PSUReceivingApplication
Update Receiving Applica- HL7 Procedure Status Update. May be overwritten by
tion(s) configured values for particular Archive Network AEs.
HL7 Procedure Status Up- string Delay in ISO-8601 duration format PnDTnHnMn.nS af- hl7PSUDelay
date Delay ter which an HL7 Procedure Status Update for a received
study is sent to configured HL7 receivers. If absent, HL7
Procedure Status Update is triggered by received MPPS.
May be overwritten by configured values for particular
Archive Network AEs.
HL7 Procedure Status Up- boolean Specifies if the Status of MWL Items in the DB is updated hl7PSUMWL
date MWL to COMPLETED for a received study after the configured
HL7 Procedure Status Update Delay. May be overwrit-
ten by configured values for particular Archive Network
AEs.
HL7 Procedure Status Up- string Timeout in ISO-8601 duration format PnDTnHnMn.nS hl7PSUTimeout
date Timeout for waiting on receive of instances referenced in MPPS;
check for completeness forever if absent. May be over-
written by configured values for particular Archive Net-
work AEs.
HL7 Procedure Status Up- boolean Specifies if the HL7 Procedure Status Update is sent if hl7PSUOnTimeout
date On Timeout the timeout for waiting on receive of instances referenced
is exceeded. May be overwritten by configured values for
particular Archive Network AEs.
HL7 Procedure Status Up- string Polling Interval for HL7 Procedure Status Update Tasks hl7PSUTaskPollingInterval
date Task Polling Interval in ISO-8601 duration format PnDTnHnMn.nS. Disabled,
if absent.
HL7 Procedure Status Up- integer Maximal number of HL7 Procedure Status Update Tasks hl7PSUTaskFetchSize
date Tasks Fetch Size fetched in one query.
Co

94 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.70 continued from previous page


Name Type Description LDAP Attribute
HL7 Track Changed Patient boolean Enable to keep track of the prior Patient ID on a change hl7TrackChangedPatientID
ID of the Patient ID by HL7 ADT^A47 or by the RESTful
Patient Update Service.
Storage (s) object Specifies Storage System dcmStorage
Query Retrieve View (s) object Specifies behavior on Rejection Note Stored dcmQueryRetrieveView
Queue (s) object Managed JMS Queue dcmQueue
Exporter Descriptor (s) object Exporter Descriptor dcmExporter
Export Rule (s) object Export Rules applied to DICOM objects received by any dcmExportRule
AE. May be supplemented by configured Export Rules
for particular Archive Network AEs.
RESTful Forward Rule (s) object RESTful Forward Rules. May be supplemented by con- dcmRSForwardRule
figured RESTful Forward Rules for particular Archive
Network AEs.
Archive Compression rule object Compression rules applied to DICOM objects received dcmArchiveCompressionRule
(s) by any AE. May be supplemented by configured Com-
pression Rules for particular Archive Network AEs.
Archive Attribute Coercion object Attribute Coercion applied to DIMSE received/sent by dcmArchiveAttributeCoercion
(s) any AE. May be supplemented by configured Attribute
Coercions for particular Archive Network AEs.
Rejection Note (s) object Specifies behavior on Rejection Note Stored dcmRejectionNote
Study Retention Policy (s) object Study Retention Policies applied to Studies received by dcmStudyRetentionPolicy
any AE. May be supplemented by configured Study Re-
tention Policies for particular Archive Network AEs.
Store Access Control ID object Store Access Control Rules applied to Studies received dcmStoreAccessControlIDRule
Rule (s) by any AE. May be supplemented by configured Store
Access Control Rules for particular Archive Network
AEs.
ID Generator (s) object ID Generator dcmIDGenerator
HL7 Forward Rule (s) object HL7 Forward Rules for HL7 messages received by any hl7ForwardRule
HL7 Application. May be supplemented by configured
HL7 Forward Rules for particular HL7 Applications.
Scheduled Station for HL7 object Scheduled Station selected on MWL HL7 Order Feed re- hl7OrderScheduledStation
Order (s) ceived by any HL7 Application. May be supplemented
by configured values for particular HL7 Applications.
SPS Status for HL7 Order object Specifies SPS Status of DICOM MWL items cre- hl7OrderSPSStatus
(s) ated/updated on received HL7 ORM^O01, OMI^O23,
OMG^O19 messages. May be overwritten by configured
values for particular Archive HL7 Application.

Attribute Filter

Attributes stored in the database

4.4. Configuration 95
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.71: Attribute Filter Attributes (LDAP Object: dcmAttributeFilter)


Name Type Description LDAP Attribute
Attribute Entity string Entity of the Attribute Filter or Export Rule (Patient, dcmEntity
Study, Series, Instance, MPPS, MWL). Enumer-
ated values: Patient, Study, Series, Instance, MPPS or
MWL
Attribute Tag(s) string DICOM Tag as hex string dcmTag
Custom Attribute 1 string Custom Attribute 1 dcmCustomAttribute1
Custom Attribute 2 string Custom Attribute 2 dcmCustomAttribute2
Custom Attribute 3 string Custom Attribute 3 dcmCustomAttribute3
Attribute Update Policy string Specifies update policy for extracted attributes into the dcmAttributeUpdatePolicy
DB on Series, Study & Patient level on receive of further
instance of the entity. If absent, the attributes will not be
updated Enumerated values: SUPPLEMENT, MERGE
or OVERWRITE

Attribute Set

Named Attribute Set for Query Parameter comparefield of DIFF-RS and Query Parameter includefields of WADO-
RS Metadata requests.

Table 4.72: Attribute Set Attributes (LDAP Object: dcmAttributeSet)


Name Type Description LDAP Attribute
Attribute Set Description string Unconstrained text description of this Attribute Set dicomDescription
Attribute Set Type string Specifies if this Attribute Set is used by Query Parameter dcmAttributeSetType
comparefield of DIFF-RS or by Query Parameter in-
cludefields of WADO-RS requests. Enumerated values:
DIFF_RS or WADO_RS
Attribute Set ID string ID used by Query Parameter comparefield of DIFF- dcmAttributeSetID
RS requests and by Query Parameter includefields of
WADO-RS Metadata requests to refer this Attribute Set.
Attribute Set Title string Title of this Attribute Set. dcmAttributeSetTitle
Attribute Set Number integer Number used to order Attribute Sets. dcmAttributeSetNumber
installed boolean Boolean to indicate whether this Attribute Set is presently dicomInstalled
installed on the archive device
Attribute Tag(s) string DICOM Tag as hex string dcmTag

Storage

Storage Descriptor

96 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.73: Storage Attributes (LDAP Object: dcmStorage)


Name Type Description LDAP Attribute
Storage ID string Storage ID dcmStorageID
Storage URI string RFC2079: Uniform Resource Identifier dcmURI
Digest Algorithm string Algorithm for generation of check sums. Enumerated dcmDigestAlgorithm
values: MD5 or SHA-1
Instance Availability string Instance Availability. Enumerated values: ONLINE, dcmInstanceAvailability
NEARLINE or OFFLINE
Read Only boolean Indicates if a Storage System is read only. dcmReadOnly
Storage Threshold string Minimal Usable Space on Storage System. If the usable dcmStorageThreshold
space fall below that value the Storage System will be
removed from the list of configured Storage Systems of
the Network AE requesting that Storage System. Format
nnn(MB|GB|MiB|GiB)
Deleter Threshold(s) string Minimal Usable Space on Storage System to trigger dele- dcmDeleterThreshold
tion. If present, studies are deleted from the Storage Sys-
tem, if the usable space fall below that value. Format
[nn[<schedule>]]nnn(MB|GB|MiB|GiB)
External Retrieve AET string Constrain deletion of Studies, whose objects are retriev- dcmExternalRetrieveAET
able using this AE from an external C-MOVE SCP, if us-
able space falls below configured threshold.
Storage Property(s) string Property in format <name>=<value> dcmProperty

Query Retrieve View

Specifies behavior on Rejection Note Stored

Table 4.74: Query Retrieve View Attributes (LDAP Object: dcmQueryRetrieveView)


Name Type Description LDAP Attribute
Query/Retrieve View ID string Query/Retrieve View Identifier dcmQueryRetrieveViewID
Show Instances Rejected By string Indicates if the Q/R Services shall show instances re- dcmShowInstancesRejectedByC
Code(s) jected by the specified code in format (CV, CSD, CM)
Hide Rejection Note With string Indicates if the Q/R Services shall hide Rejection Notes dcmHideRejectionNoteWithCod
Code(s) with the specified code in format (CV, CSD, CM)
Hide Not Rejected Instances boolean Indicates if the Q/R Services shall hide instances not re- dcmHideNotRejectedInstances
jected by any reason.

Queue

Managed JMS Queue

4.4. Configuration 97
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.75: Queue Attributes (LDAP Object: dcmQueue)


Name Type Description LDAP Attribute
Queue Name string JMS Queue Name dcmQueueName
JNDI Name string JNDI Name dcmJndiName
DICOM Description string Textual description of the DICOM entity dicomDescription
Maximum Number of Re- integer Maximal number of retries to process tasks scheduled in dcmMaxRetries
tries a specific queue.
Retry Delay string Delay to retry to process tasks scheduled in a specific dcmRetryDelay
queue in ISO-8601 duration format PnDTnHnMn.nS.
Maximum Retry Delay string Maximal Delay to retry to process tasks scheduled dcmMaxRetryDelay
in a specific queue in ISO-8601 duration format
PnDTnHnMn.nS. Infinite if absent.
Retry Delay Multiplier integer Multiplier in % that will take effect on top of dcmRetry- dcmRetryDelayMultiplier
Delay with dcmMaxRetryDelay to be taken into account.
Retry on Warning boolean Enables retries to process tasks not only on failure but dcmRetryOnWarning
also on a warning outcome status in a specific queue.
Delay for purging com- string Delay in ISO-8601 duration format PnDTnHnMn.nS af- dcmPurgeQueueMessageComp
pleted queue messages ter which completed queue messages are purged. If ab-
sent, there is no deletion for that particular queue

Exporter Descriptor

Exporter Descriptor

Table 4.76: Exporter Descriptor Attributes (LDAP Object: dcmExporter)


Name Type Description LDAP Attribute
Exporter ID string Exporter ID dcmExporterID
URI string RFC2079: Uniform Resource Identifier dcmURI
Queue Name string JMS Queue Name dcmQueueName
Exporter Description string Unconstrained text description of the exporter dicomDescription
Application Entity (AE) title string Application Entity (AE) title dicomAETitle
Storage Commitment SCP string AE Title of external Storage Commitment SCP used to dcmStgCmtSCP
AE Title verify export to another archive.
Ian Destination(s) string Destination to send IAN N-CREATE RQ dcmIanDestination
Retrieve AE Title(s) string AE Title associated with Network AE dcmRetrieveAET
Retrieve Location UID string Retrieve Location UID. dcmRetrieveLocationUID
Instance Availability string Instance Availability. Enumerated values: ONLINE, dcmInstanceAvailability
NEARLINE or OFFLINE
Schedule(s) string Schedule Expression in format hour=[0-23] dcmSchedule
dayOfWeek=[0-6] (0=Sunday)
Property(s) string Property in format <name>=<value> dcmProperty

Export Rule

Export Rule

98 Chapter 4. Networking
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.77: Export Rule Attributes (LDAP Object: dcmExportRule)


Name Type Description LDAP Attribute
Name string Arbitrary/Meaningful name of the Export Rule cn
Attribute Entity string Entity of the Attribute Filter or Export Rule (Patient, dcmEntity
Study, Series, Instance, MPPS, MWL). Enumer-
ated values: Patient, Study, Series, Instance, MPPS or
MWL
Exporter ID(s) string Exporter ID dcmExporterID
Export Previous Entity boolean Specifies if the previous Entity of a replaced Instance dcmExportPreviousEntity
shall be also exported.
Property(s) string Property in format <name>=<value> dcmProperty
Schedule(s) string Schedule Expression in format hour=[0-23] dcmSchedule
dayOfWeek=[0-6] (0=Sunday)
Duration string Duration in ISO-8601 duration format PnDTnHnMn.nS dcmDuration

RESTful Forward Rule

RESTful Forward Rule

Table 4.78: RESTful Forward Rule Attributes (LDAP Object: dcmRsForwardRule)


Name Type Description LDAP Attribute
Name string Arbitrary/Meaningful name of the RESTful Forward cn
Rule
Target Base URL string Target URL without operation specific part: http: dcmURI
//<host>:<port>/dcm4chee-arc/aets/<aet>/rs/.
RESTful Operation(s) string Name of RESTful Operation which shall be forwarded to dcmRSOperation
another archive instance. Enumerated values: CreatePa-
tient, UpdatePatient, DeletePatient, ChangePatientID,
MergePatient, MergePatients, UpdateStudy, DeleteS-
tudy, CopyInstances, MoveInstances, RejectStudy, Re-
jectSeries, RejectInstance, UpdateStudyExpirationDate
or UpdateSeriesExpirationDate

Archive Compression rule

Archive Compression rule

Table 4.79: Archive Compression rule Attributes (LDAP Object: dcmArchiveCompressionRule)


Name Type Description LDAP Attribute
Name string Arbitrary/Meaningful name of the Archive Compression cn
Rule
DICOM Transfer Syntax string A Transfer Syntax UID dicomTransferSyntax
UID
Rule Priority integer Rule Priority dcmRulePriority
Property(s) string Property in format <name>=<value> dcmProperty
Image Write Param(s) string Image Write Parameter(s) (name=value) set at on Image dcmImageWriteParam
Writer before compression

4.4. Configuration 99
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Archive Attribute Coercion

Archive Attribute Coercion of received/sent DIMSE

Table 4.80: Archive Attribute Coercion Attributes (LDAP Object: dcmArchiveAttributeCoercion)


Name Type Description LDAP Attribute
Name string Arbitrary/Meaningful name of the Archive Attribute Co- cn
ercion
DIMSE string DICOM Message Element. Enumerated values: dcmDIMSE
C_STORE_RQ, C_FIND_RQ or C_FIND_RSP
DICOM Transfer Role string DICOM Transfer Role. Enumerated values: SCU or SCP dicomTransferRole
Rule Priority integer Rule Priority. dcmRulePriority
AE Title(s) string Application Entity (AE) title dcmAETitle
Host Name(s) string DNS hostname dcmHostname
SOP Class UID(s) string A SOP Class UID dcmSOPClass
URI string Specifies URI of the style sheet for Attribute Coercion dcmURI
No Keywords boolean Indicates if keywords shall be omitted in generated DI- dcmNoKeywords
COM XML or JSON presentations
Merge MWL Matching Key string Specifies attribute of received object to lookup MWL dcmMergeMWLMatchingKey
Item used to coerce request attributes. If absent, request
attributes of received objects will not be coerced. Enu-
merated values: AccessionNumber, StudyInstanceUID
or ScheduledProcedureStepID
Merge MWL Template URI string Specifies URI for the style sheet to coerce request dcmMergeMWLTemplateURI
attributes of received objects from matching DICOM
MWL items. Only effective, if dcmMergeMWLMatch-
ingKey is specified.
Leading C-FIND SCP string AE Title of external C-FIND SCP for Attribute Coercion dcmLeadingCFindSCP
with Patient and Study attributes fetched from this AE.
Leading C-FIND SCP return string DICOM Tag as hex string of attributes fetched from ex- dcmTag
keys(s) ternal C-FIND SCP for Attribute Coercion. If absent,
all Patient and Study Attributes extracted into the DB -
configured by the Patient and Study Attribute Filter - are
fetched.
Attribute Update Policy string Specifies how attributes shall be updated with attributes dcmAttributeUpdatePolicy
fetched from Leading C-FIND SCP. Enumerated values:
SUPPLEMENT, MERGE or OVERWRITE

Rejection Note

Specifies behavior on Rejection Note Stored

100 Chapter 4. Networking


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.81: Rejection Note Attributes (LDAP Object: dcmRejectionNote)


Name Type Description LDAP Attribute
Rejection Note Label string Rejection Note Label dcmRejectionNoteLabel
Rejection Note Type string Type of Rejection Note. Enumerated values: dcmRejectionNoteType
REJECTED_FOR_QUALITY_REASONS, RE-
JECTED_FOR_PATIENT_SAFETY_REASONS,
INCORRECT_MODALITY_WORKLIST_ENTRY,
DATA_RETENTION_POLICY_EXPIRED or RE-
VOKE_REJECTION
Rejection Note Code string Specifies Document Title of Rejection Note in format dcmRejectionNoteCode
(CV, CSD, CM)
Accept Previous Rejected string Specifies behavior on subsequent occurrence of instances dcmAcceptPreviousRejectedInsta
Instance rejected by a particular Rejection Note. Enumerated val-
ues: REJECT, RESTORE or IGNORE
Overwrite Previous Rejec- string Specifies Document Title of previous Rejection Note in dcmOverwritePreviousRejection
tion(s) format (CV, CSD, CM) which may be overwritten by
that Rejection Note
Delete Rejected Instance string Delay in ISO-8601 duration format PnDTnHnMn.nS af- dcmDeleteRejectedInstanceDelay
Delay ter which instances rejected by a particular Rejection
Note are deleted. Infinite if absent.
Delete Rejection Note Delay string Delay in ISO-8601 duration format PnDTnHnMn.nS af- dcmDeleteRejectionNoteDelay
ter which particular Rejection Notes are deleted. Infinite
if absent.

Study Retention Policy

Study Retention Policy

Table 4.82: Study Retention Policy Attributes (LDAP Object: dcmStudyRetentionPolicy)


Name Type Description LDAP Attribute
Name string Arbitrary/Meaningful name of the Study Retention Pol- cn
icy
Study Retention Period string Study Retention Period in ISO-8601 period format PnYn- dcmRetentionPeriod
MnD or PnW
Rule Priority integer Rule Priority. dcmRulePriority
Property(s) string Property in format <name>=<value> dcmProperty
Expire Series Individually boolean Indicates if series should be expired individually or not. dcmExpireSeriesIndividually

Store Access Control ID Rule

Store Access Control ID Rule

4.4. Configuration 101


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.83: Store Access Control ID Rule Attributes (LDAP Object: dcmStoreAccessControlIDRule)
Name Type Description LDAP Attribute
Name string Arbitrary/Meaningful name of the Store Access Control cn
ID Rule
Store Access Control ID string Access Control ID assigned to Studies which attributes dcmStoreAccessControlID
match all conditions
Rule Priority integer Rule Priority. dcmRulePriority
Conditions(s) string Conditions in format {attributeID}[!]={regEx} dcmProperty

ID Generator

ID Generator

Table 4.84: ID Generator Attributes (LDAP Object: dcmIDGenerator)


Name Type Description LDAP Attribute
ID Generator Name string ID Generator Name. Enumerated values: PatientID, Ac- dcmIDGeneratorName
cessionNumber, RequestedProcedureID or Scheduled-
ProcedureStepID
ID Generator Format string Format string used by this ID Generator. %0<width>d dcmIDGeneratorFormat
will be replaced by a sequential number with leading ze-
ros according the given width
ID Generator Initial Value integer Initial value for sequence used by this ID Generator. dcmIDGeneratorInitialValue

HL7 Forward Rule

HL7 Forward Rule

Table 4.85: HL7 Forward Rule Attributes (LDAP Object: hl7ForwardRule)


Name Type Description LDAP Attribute
Name string Arbitrary/Meaningful name of the HL7 Forward Rule cn
HL7 Forward Application string HL7 Forward Destination Application and Facility name hl7FwdApplicationName
Name(s) (Application|Facility)
Property(s) string Property in format <name>=<value> dcmProperty

Scheduled Station for HL7 Order

Scheduled Station selected on MWL HL7 Order Feed

102 Chapter 4. Networking


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 4.86: Scheduled Station for HL7 Order Attributes (LDAP Object: hl7OrderScheduledStation)
Name Type Description LDAP Attribute
Name string Arbitrary/Meaningful name for the Scheduled Station Or- cn
der Mapping
Scheduled Station Device string The DN of a dicomDeviceObject referenced by hl7OrderScheduledStationDevic
Reference hl7OrderScheduledStation
Mapping Priority integer Mapping Priority. dcmRulePriority
Conditions(s) string Conditions in format {attributeID}[!]={regEx} or MSH- dcmProperty
#[!]={regEx}

SPS Status for HL7 Order

Specifies SPS Status of DICOM MWL items created/updated on received HL7 ORM^O01, OMI^O23, OMG^O19
messages

Table 4.87: SPS Status for HL7 Order Attributes (LDAP Object: hl7OrderSPSStatus)
Name Type Description LDAP Attribute
Scheduled Procedure Step string Scheduled Procedure Step Status code Enumerated dcmSPSStatus
Status code values: SCHEDULED, ARRIVED, READY, STARTED,
DEPARTED, CANCELLED, DISCONTINUED or
COMPLETED
HL7 Order Control Status(s) string HL7 Order Control Status Code combinations. Enu- hl7OrderControlStatus
merated values: NW_SC, NW_IP, CA_CA, DC_CA,
XO_SC, XO_CM, SC_CM, SC_DC, SC_IP or SC_A

4.4. Configuration 103


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

104 Chapter 4. Networking


CHAPTER 5

Media Interchange

dcm4che DICOM Archive 5 does not support Media Storage

105
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

106 Chapter 5. Media Interchange


CHAPTER 6

Support of Character Sets

dcm4che DICOM Archive 5 supports all extended character sets defined in the DICOM 2017 standard, including
single-byte and multi-byte character sets as well as code extension techniques using ISO 2022 escapes in DICOM
messages.
Support extends to correctly decoding and displaying the correct symbol for all names and strings found in storage
instances received over the network, and in the local database.
In addition to the default character repertoire, the Defined Terms for Specific Character Set in Table 6.1 are supported:

Table 6.1: Supported Specific Character Set Defined Terms

Character Set Description DICOM attribute: Specific Character Set (0008,0005) HL7 field: Character Set MSH 18
Latin alphabet No. 1 ISO_IR 100 8859/1
Latin alphabet No. 2 ISO_IR 101 8859/2
Latin alphabet No. 3 ISO_IR 109 8859/3
Latin alphabet No. 4 ISO_IR 110 8859/4
Cyrillic ISO_IR 144 8859/5
Arabic ISO_IR 127 8859/6
Greek ISO_IR 126 8859/7
Hebrew ISO_IR 138 8859/8
Latin alphabet No. 5 ISO_IR 148 8859/9
Japanese ISO_IR 13 ISO IR14
Thai ISO_IR 166 CNS 11643-1992
Default repertoire ISO 2022 IR 6 not supported1
Latin alphabet No. 1 ISO 2022 IR 100 not supported1
Latin alphabet No. 2 ISO 2022 IR 101 not supported1
Latin alphabet No. 3 ISO 2022 IR 109 not supported1
Latin alphabet No. 4 ISO 2022 IR 110 not supported1
Cyrillic ISO 2022 IR 144 not supported1
Arabic ISO 2022 IR 127 not supported1
Greek ISO 2022 IR 126 not supported1
Continued on next page

107
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 6.1 continued from previous page


Character Set Description DICOM attribute: Specific Character Set (0008,0005) HL7 field: Character Set MSH 18
Hebrew ISO 2022 IR 138 not supported1
Latin alphabet No. 5 ISO 2022 IR 148 not supported1
Japanese ISO 2022 IR 13 not supported1
Thai ISO 2022 IR 166 not supported1
Japanese ISO 2022 IR 87 not supported1
Japanese ISO 2022 IR 159 not supported1
Korean ISO 2022 IR 149 not supported1
Simplified Chinese ISO 2022 IR 58 not supported1
Unicode in UTF-8 ISO_IR 192 UNICODE UTF-8
GB18030 GB18030 GB 18030-2000
GBK GBK GB 18030-2000

1 Escape sequences supporting multiple character sets in HL7 v2 messages are not supported.

108 Chapter 6. Support of Character Sets


CHAPTER 7

Security

Security Profiles

Secure Transport Connection Profiles

dcm4che DICOM Archive 5 supports the Basic TLS Secure Transport Connection Profile and the AES TLS Secure
Transport Connection Profile as specified in DICOM Standard, Part 15, Annex B.1 and Annex B.3.
By default configuration, TLS 1.0, TLS 1.1 and TLS 1.2 are enabled, use of TLS 1.2 is preferred.
Also other cyphersuite options than the two in compliance with AES TLS Secure Transport Connection Profile:
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
may be configured.
Beside DICOM DIMSE service connections, also HL7 v2 and HTTP connections can be secured by use of TLS.
IP ports on which an implementation accepts TLS connections are configurable.
The private key and the Certificate used by an instance of dcm4che DICOM Archive 5 to identify itself in the TLS
negotiation with remote applications has to be provided in a local keystore file in PKCS12 or JKS (Java Key Store)
format on the application host. Certficates of Certificate Authorities (CA) to validate Certificates received from remote
applications during the TLS negotiation can also be provided in a local keystore file in JKS format or at the central
LDAP server, used as configuration backend for all instances of dcm4che DICOM Archive 5.

Network Address Management Profiles

dcm4che DICOM Archive 5 supports the Basic Network Address Management Profile as DHCP Client and DNS Client
actor utilizing network configuration options of the underlying operating system. S. DICOM Standard, Part 15, Annex
F.1.

109
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Time Synchronization Profiles

dcm4che DICOM Archive 5 supports the Basic Time Synchronization Profile as DHCP Client and NTP Client actor
utilizing time synchronization options of the underlying operating system. S. DICOM Standard, Part 15, Annex G.1.

Application Configuration Management Profiles

dcm4che DICOM Archive 5 supports the Application Configuration Management Profile as LDAP Client actor. Any
LDAP v3 compatible LDAP server can be used as configuration backend for multiple instances of dcm4che DICOM
Archive 5 - and may also be shared with external DICOM applications which also supports the Application Configu-
ration Management Profile as LDAP Client actor. S. DICOM Standard, Part 15, Annex H.1.

Audit Trail Profiles

Audit Trail Message Format Profile

dcm4che DICOM Archive 5 supports the Audit Trail Message Format Profile as specified in DICOM Standard, Part
15, Annex A.5.

Audit Messages

General Message Format Conventions

Message Structure

Event
Active Participant (1..N)
Audit Source
Participant Object (0..N)

110 Chapter 7. Security


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 7.1: Event


Field Opt Description Additional Conditions on Field
Name Format/Value
EventID M Identifier for a specific audited event. The identifier for the family of event. E.g.,
User Authentication
EventAc- M Indicator for type of action performed during CCreate a new database object, such as
tionCode the event that generated the audit. Placing an Order
RRead/View/Print/Query Display or print
data, such as a Doctor Census
UUpdate data, such as Revise Patient
Information
DDelete items, such as a master file record
EPerform a system or application function
such as log-on, program execution, or use of
an objects method
Event- M Universal coordinated time (UTC), i.e., a The time at which the audited event occurred
DateTime date/time specification that is unambiguous
as to local time zones.
EventOut- M Indicates whether the event succeeded or 0SUCCESS, 4Minor failure
comeIndi- failed.
cator
EventOut- U In failure cases, indicates the exception or
comeDescrip- error message.
tion
Event- M Identifier for the category of event. The specific type(s) within the family
TypeCode applicable to the event, e.g., User Login.

Table 7.2: Active Participant


Field Name Opt Description
UserID M Unique identifier for the user actively participating in the event.
AlternativeUserID U Alternative unique identifier for the user.
UserName U The human-meaningful name for the user.
UserIsRequestor M Indicator that the user is or is not the requestor, or initiator, for the event being audited.
RoleIDCode U Specification of the role(s) the user plays when performing the event, as assigned in
role-based access control security.
NetworkAccess- U An identifier for the type of network access point.
PointTypeCode
NetworkAccess- M An identifier for the network access point of the user device This could be a device id,
PointID IP address, or some other identifier associated with a device.

Table 7.3: Audit Source


Field Name Opt Description
AuditEnter- U Logical source location within the healthcare enterprise network, e.g., a hospital or other
priseSiteID provider location within a multi-entity provider group.
AuditSour- M Identifier of the source.
ceID
AuditSource- M Code specifying the type of source.
TypeCode

7.1. Security Profiles 111


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 7.4: Participant Object


Field Opt Description Additional Conditions on Field Format/Value
Name
Partici- U Code for the participant object type being 1Person
pantOb- audited. This value is distinct from the
ject- users role or any user relationship to the
Type- participant object.
Code
2System Object
3Organization
4Other
Partici- U Code representing the functional application
pantOb- role of Participant Object being audited.
ject-
Type-
Code
Partici- U Identifier for the data life-cycle stage for the
pantOb- participant object. This can be used to
ject- provide an audit trail for data, over time, as
DataL- it passes through the system.
ifeCycle
Partici- M Describes the identifier that is contained in
pantOb- Participant Object ID.
jectID-
Type-
Code
Partici- U Denotes policy-defined sensitivity for the
pantOb- Participant Object ID such as VIP, HIV
jectSen- status, mental health status, or similar topics.
sitivity
Partici- M Identifies a specific instance of the
pantOb- participant object.
jectID
Partici- U An instance-specific descriptor of the
pantOb- Participant Object ID audited, such as a
ject- persons name.
Name
Partici- U The actual query for a query-type
pantOb- participant object.
ject-
Query
Partici- U Implementation-defined data about specific This element is a Type-value pair. The type
pantOb- details of the object accessed or used. attribute is an implementation-defined text
jectDe- string. The value attribute is base 64 encoded
tail data. The value is suitable for conveying binary
data.
SOP- MC The UIDs of SOP classes referred to in this
Class participant object. Required if
ParticipantObjectIDTypeCode is (110180,
DCM, Study Instance UID) and any of the
optional fields (AccessionNumber,
ContainsMPPS, NumberOfInstances,
ContainsSOPInstances,Encrypted,Anonymized)
are present in this Participant Object. May be
112 Chapter 7. Security
present if ParticipantObjectIDTypeCode is
(110180, DCM, Study Instance UID) even
though none of the optional fields are present.
Acces- U An Accession Number(s) associated with this
DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Application Activity

Trigger Events

This audit message is emitted when the archive is started or stopped using the archive user interface. Its is also emitted
during archive startup or shutdown.

Message Structure

Event: Application Activity


Active Participant: Application started (1)
Active Participant: Person who started the Application (1) - This Active Participant is present only if archive
was started/stopped using RESTful service.
Audit Source

Table 7.5: Event: Application Activity


Field Name Opt Description
EventID M EV (110100, DCM, Application Activity)
EventActionCode M Enumerated Value E = Execute
EventDateTime M The time at which the event occurred
EventOutcomeIndicator M 0SUCCESS
EventTypeCode M DT (110120, DCM, Application Start)
DT (110121, DCM, Application Stop)

Table 7.6: Active Participant: Application started


Field Name Opt Description
UserID M Application entity titles of Archive Device as ; separated values
AlternativeUserID MC Process ID of Audit logger
UserIsRequestor M false
RoleIDCode M EV (110150, DCM, Application)
NetworkAccessPointID U Hostname/IP Address of the connection referenced by Audit logger
NetworkAccessPointType- U 1NetworkAccessPointID is host name, 2NetworkAccessPointID is an
Code IP address

Table 7.7: Active Participant: Person who started the Application


Field Name Opt Description
UserID M Remote IP address for unsecured version of archive; User name for secured
version of archive
UserIsRequestor M true
RoleIDCode M EV (110151, DCM, ApplicationLauncher)
NetworkAccessPointID U Hostname/IP Address of calling host
NetworkAccessPoint- U 1NetworkAccessPointID is host name, 2NetworkAccessPointID is an IP
TypeCode address

7.1. Security Profiles 113


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Sample Message

<?xml version=1.0 encoding=UTF-8 standalone=yes?> <AuditMessage xmlns:xsi=http://www.w3.org/2001/XMLSchema-


instance xsi:noNamespaceSchemaLocation=http://www.dcm4che.org/DICOM/audit-message.rnc>
<EventIdentification EventActionCode=E EventDateTime=2017-07-10T10:30:17.651+02:00
EventOutcomeIndicator=0>
<EventID csd-code=110100 codeSystemName=DCM originalText=Application Ac-
tivity/>
<EventTypeCode csd-code=110120 codeSystemName=DCM original-
Text=Application Start/>
</EventIdentification>
<ActiveParticipant UserID=DCM4CHEE;DCM4CHEE_ADMIN;DCM4CHEE_TRASH Alterna-
tiveUserID=5289 UserIsRequestor=false NetworkAccessPointID=localhost NetworkAccess-
PointTypeCode=1>
<RoleIDCode csd-code=110150 codeSystemName=DCM original-
Text=Application/>
</ActiveParticipant>
<AuditSourceIdentification AuditSourceID=dcm4chee-arc>
<AuditSourceTypeCode csd-code=4/>
</AuditSourceIdentification>
</AuditMessage>

Audit Log Used

Trigger Events

<TODO>

Message Structure

<TODO>

Sample Message

<TODO>

Begin Transferring DICOM Instances

This message describes the event of a system beginning to transfer a set of DICOM instances from one node to
another node within control of the systems security domain. This message may only include information about a
single patient.

114 Chapter 7. Security


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Trigger Events

This message is emitted by the archive in following cases : - Q/R Move : Objects of a study are retrieved using
query/retrieve service and stored to external destination - Q/R Get : Objects of a study are retrieved using query/retrieve
service and stored to the destination which is same as source - Export : Objects of a study are exported - WADO RS :
Objects of a study are retrieved using WADO RESTful service - XDSI Retrieve Imaging Document Set RAD-69

Message Structure

Event: Begin Transferring DICOM Instances


Active Participant: Archive application (1)
Active Participant: Destination (1)
Active Participant: Other (1) - This active participant is present only in the Q/R Move case.
Participant Object Identification: Study (0..1)
Participant Object Identification: Patient (1)
Audit Source

Table 7.8: Event: Begin Transferring DICOM Instances


Field Name Opt Description
EventID M EV (110100, DCM, Begin Transferring DICOM Instances)
EventActionCode M Enumerated Value E = Execute
EventDateTime M The time at which the event occurred
EventOutcomeIndicator M 0SUCCESS, 4Minor failure
EventOutcomeDescription M Error/Exception message when EventOutcomeIndicator4

Table 7.9: Active Participant: Archive application


Field Name Opt Description
UserID M Q/R Move case Application entity title of Archive Device used in the
association
Q/R Get case Application entity title of Archive Device used in the
association
Export case dicomAETitle configured in the Exporter of archive
WADO RS case Invoked URL
XDSI Retrieve Imaging Document Set RAD-69 case Invoked URL
AlternativeUserID MC Process ID of Audit logger
UserIsRequestor M false
RoleIDCode M EV (110153, DCM, Source)
NetworkAccessPointID U Hostname/IP Address of the connection referenced by Audit logger
NetworkAccessPointType- U 1NetworkAccessPointID is host name, 2NetworkAccessPointID is an
Code IP address

7.1. Security Profiles 115


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 7.10: Active Participant: Destination


Field Name Opt Description
UserID M Q/R Move case Application entity title of destination system
Q/R Get case Application entity title of initiating system
Export case dicomAETitle of destination
WADO RS case Remote IP address or User name of logged in user
XDSI Retrieve Imaging Document Set RAD-69 case Remote IP address or
User name of logged in user
UserIsRequestor M Q/R Move case false
Q/R Get case true
Export case true
WADO RS case true
RoleIDCode M EV (110152, DCM, Destination)
NetworkAccess- U Hostname/IP Address of calling host
PointID
NetworkAccessPoint- U 1NetworkAccessPointID is host name, 2NetworkAccessPointID is an IP
TypeCode address

Table 7.11: Active Participant: Other


Field Name Opt Description
UserID M Application entity title of initiating system
UserIsRequestor M true
NetworkAccessPointID U Hostname/IP Address of initiating system
NetworkAccessPointType- U 1NetworkAccessPointID is host name, 2NetworkAccessPointID is an
Code IP address

Table 7.12: Participant Object Identification: Study


Field Name Opt Description
ParticipantObjec- M Study Instance UID
tID
ParticipantObject- M 2 System
TypeCode
ParticipantObject- M 3 Report
TypeCodeRole
ParticipantObjec- M EV (110180, DCM, Study Instance UID)
tIDTypeCode
ParticipantObject- U Base-64 encoded study date if Study has StudyDate(0008,0020) attribute
Detail
ParticipantObject- U
Description
SOPClass MC Sop Class UID and Number of instances with this sop class. eg. <SOPClass
UID=1.2.840.10008.5.1.4.1.1.88.22 NumberOfInstances=4/>
Accession U Accession Number
ParticipantObject- U
ContainsStudy
StudyIDs M Study Instance UID

116 Chapter 7. Security


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 7.13: Participant Object Identification: Patient


Field Name Opt Description
ParticipantObjectID M Patient ID
ParticipantObjectTypeCode M 1 Person
ParticipantObjectTypeCodeRole M 1 Patient
ParticipantObjectIDTypeCode M EV (2, RFC-3881, Patient Number)
ParticipantObjectName U Patient Name

Sample Message

<?xml version=1.0 encoding=UTF-8 standalone=yes?>


<AuditMessage xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xsi:noNamespaceSchemaLocation=http://www.dcm4che.org/DICOM/audit-message.rnc>
<EventIdentification EventActionCode=E EventDateTime=2016-06-
21T10:22:00.634+02:00 EventOutcomeIndicator=0>
<EventID csd-code=110102 codeSystemName=DCM originalText=Begin
Transferring DICOM Instances/>
</EventIdentification>
<ActiveParticipant UserID=DCM4CHEE AlternativeUserID=60928 UserIsRe-
questor=false NetworkAccessPointID=localhost NetworkAccessPointTypeCode=1>
<RoleIDCode csd-code=110153 codeSystemName=DCM original-
Text=Source/>
</ActiveParticipant>
<ActiveParticipant UserID=GETSCU UserIsRequestor=true NetworkAccess-
PointID=127.0.0.1 NetworkAccessPointTypeCode=2>
<RoleIDCode csd-code=110152 codeSystemName=DCM original-
Text=Destination/>
</ActiveParticipant>
<AuditSourceIdentification AuditSourceID=dcm4chee-arc>
<AuditSourceTypeCode csd-code=4/>
</AuditSourceIdentification>
<ParticipantObjectIdentification ParticipantObjectID=1.3.12.2.1107.5.2.33.37113.30000008060311320917100000013
ParticipantObjectTypeCode=2 ParticipantObjectTypeCodeRole=3>
<ParticipantObjectIDTypeCode csd-code=110180 originalText=Study Instance
UID codeSystemName=DCM/>
<ParticipantObjectDetail type=StudyDate value=MjAwODA3MTY=/>
<ParticipantObjectDescription>
<SOPClass UID=1.2.840.10008.5.1.4.1.1.88.22 NumberOfIn-
stances=4/>
<SOPClass UID=1.2.840.10008.5.1.4.1.1.4 NumberOfInstances=2/>
<ParticipantObjectContainsStudy>

7.1. Security Profiles 117


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

<StudyIDs UID=1.3.12.2.1107.5.2.33.37113.30000008060311320917100000013/>
</ParticipantObjectContainsStudy>
</ParticipantObjectDescription>
</ParticipantObjectIdentification>
<ParticipantObjectIdentification ParticipantObjectID=P5^^^ISSUER ParticipantObject-
TypeCode=1 ParticipantObjectTypeCodeRole=1>
<ParticipantObjectIDTypeCode csd-code=2 originalText=Patient Number
codeSystemName=RFC-3881/>
<ParticipantObjectName>TEST^Name</ParticipantObjectName>
</ParticipantObjectIdentification>
</AuditMessage>

Begin Transferring DICOM Instances

Trigger Events

<TODO>

Message Structure

<TODO>

Sample Message

<TODO>

DICOM Instances Accessed

Trigger Events

<TODO>

Message Structure

<TODO>

Sample Message

<TODO>

118 Chapter 7. Security


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

DICOM Instances Transferred

Trigger Events

This message is emitted by the archive in following cases : - Q/R Move : Objects of a study are retrieved using
query/retrieve service and stored to external destination - Q/R Get : Objects of a study are retrieved using query/retrieve
service and stored to the destination which is same as source - Export : Objects of a study are exported - WADO RS
: Objects of a study are retrieved using WADO RESTful service - Store : Objects of a study are being stored to the
archive - Storage Commitment of objects of study - XDSI Retrieve Imaging Document Set RAD-69

Message Structure

Event: Begin Transferring DICOM Instances


Active Participant: Archive application (1)
Active Participant: Destination (1)
Active Participant: Other (1) - This active participant is present only in the Q/R Move case.
Participant Object Identification: Study (0..1)
Participant Object Identification: Patient (1)
Audit Source

Table 7.14: Event: Begin Transferring DICOM Instances


Field Name Opt Description
EventID M EV (110104, DCM, DICOM Instances Transferred)
EventActionCode M Store case : C Create or U Update
For all other cases : R Read
EventDateTime M The time at which the event occurred
EventOutcomeIndicator M 0SUCCESS, 4Minor failure
EventOutcomeDescription M Error/Exception message when EventOutcomeIndicator4

Table 7.15: Active Participant: Archive application


Field Name Opt Description
UserID M Q/R Move case Application entity title of Archive Device used in the
association
Q/R Get case Application entity title of Archive Device used in the association
Store case Application entity title of Archive Device used in the association
Storage Commitment case Application entity title of Archive Device used in the
association or Invoked URL
Export case dicomAETitle configured in the Exporter of archive
WADO RS case Invoked URL
XDSI Retrieve Imaging Document Set RAD-69 case Invoked URL
AlternativeUserID MC Process ID of Audit logger
UserIsRequestor M false
RoleIDCode M EV (110153, DCM, Source)
NetworkAccess- U Hostname/IP Address of the connection referenced by Audit logger
PointID
NetworkAccessPoint- U 1NetworkAccessPointID is host name, 2NetworkAccessPointID is an IP
TypeCode address

7.1. Security Profiles 119


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 7.16: Active Participant: Destination


Field Name Opt Description
UserID M Q/R Move case Application entity title of destination system
Q/R Get case Application entity title of initiating system
Store case Application entity title of Device storing the study objects to archive
Storage Commitment case Remote IP address or User name of logged in user
Export case dicomAETitle of destination
WADO RS case Remote IP address or User name of logged in user
XDSI Retrieve Imaging Document Set RAD-69 case Remote IP address or
User name of logged in user
UserIsRequestor M true for all cases except Q/R Move case
RoleIDCode M EV (110152, DCM, Destination)
NetworkAccess- U Hostname/IP Address of calling host
PointID
NetworkAccessPoint- U 1NetworkAccessPointID is host name, 2NetworkAccessPointID is an IP
TypeCode address

Table 7.17: Active Participant: Other


Field Name Opt Description
UserID M Application entity title of initiating system
UserIsRequestor M true
NetworkAccessPointID U Hostname/IP Address of initiating system
NetworkAccessPointType- U 1NetworkAccessPointID is host name, 2NetworkAccessPointID is an
Code IP address

Table 7.18: Participant Object Identification: Study


Field Name Opt Description
ParticipantObjec- M Study Instance UID
tID
ParticipantObject- M 2 System
TypeCode
ParticipantObject- M 3 Report
TypeCodeRole
ParticipantObjec- M EV (110180, DCM, Study Instance UID)
tIDTypeCode
ParticipantObject- U Base-64 encoded study date if Study has StudyDate(0008,0020) attribute
Detail
ParticipantObject- U
Description
SOPClass MC Sop Class UID and Number of instances with this sop class. eg. <SOPClass
UID=1.2.840.10008.5.1.4.1.1.88.22 NumberOfInstances=4/>
Accession U Accession Number
ParticipantObject- U
ContainsStudy
StudyIDs M Study Instance UID

120 Chapter 7. Security


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Table 7.19: Participant Object Identification: Patient


Field Name Opt Description
ParticipantObjectID M Patient ID
ParticipantObjectTypeCode M 1 Person
ParticipantObjectTypeCodeRole M 1 Patient
ParticipantObjectIDTypeCode M EV (2, RFC-3881, Patient Number)
ParticipantObjectName U Patient Name

Sample Message

<?xml version=1.0 encoding=UTF-8 standalone=yes?>


<AuditMessage xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xsi:noNamespaceSchemaLocation=http://www.dcm4che.org/DICOM/audit-message.rnc>
<EventIdentification EventActionCode=E EventDateTime=2017-07-
10T12:22:29.457+02:00 EventOutcomeIndicator=0>
<EventID csd-code=110104 codeSystemName=DCM originalText=DICOM
Instances Transferred/>
</EventIdentification>
<ActiveParticipant UserID=DCM4CHEE AlternativeUserID=60928 UserIsRe-
questor=false NetworkAccessPointID=localhost NetworkAccessPointTypeCode=1>
<RoleIDCode csd-code=110153 codeSystemName=DCM original-
Text=Source/>
</ActiveParticipant>
<ActiveParticipant UserID=GETSCU UserIsRequestor=true NetworkAccess-
PointID=127.0.0.1 NetworkAccessPointTypeCode=2>
<RoleIDCode csd-code=110152 codeSystemName=DCM original-
Text=Destination/>
</ActiveParticipant>
<AuditSourceIdentification AuditSourceID=dcm4chee-arc>
<AuditSourceTypeCode csd-code=4/>
</AuditSourceIdentification>
<ParticipantObjectIdentification ParticipantObjectID=1.3.12.2.1107.5.2.33.37113.30000008060311320917100000013
ParticipantObjectTypeCode=2 ParticipantObjectTypeCodeRole=3>
<ParticipantObjectIDTypeCode csd-code=110180 originalText=Study Instance
UID codeSystemName=DCM/>
<ParticipantObjectDetail type=StudyDate value=MjAwODA3MTY=/>
<ParticipantObjectDescription>
<SOPClass UID=1.2.840.10008.5.1.4.1.1.88.22 NumberOfIn-
stances=4/>
<SOPClass UID=1.2.840.10008.5.1.4.1.1.4 NumberOfInstances=2/>
<ParticipantObjectContainsStudy>

7.1. Security Profiles 121


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

<StudyIDs UID=1.3.12.2.1107.5.2.33.37113.30000008060311320917100000013/>
</ParticipantObjectContainsStudy>
</ParticipantObjectDescription>
</ParticipantObjectIdentification>
<ParticipantObjectIdentification ParticipantObjectID=P5^^^ISSUER ParticipantObject-
TypeCode=1 ParticipantObjectTypeCodeRole=1>
<ParticipantObjectIDTypeCode csd-code=2 originalText=Patient Number
codeSystemName=RFC-3881/>
<ParticipantObjectName>TEST^Name</ParticipantObjectName>
</ParticipantObjectIdentification>
</AuditMessage>

DICOM Study Deleted

Trigger Events

<TODO>

Message Structure

<TODO>

Sample Message

<TODO>

Query

Trigger Events

<TODO>

Message Structure

<TODO>

Sample Message

<TODO>

122 Chapter 7. Security


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Security Alert

Trigger Events

<TODO>

Message Structure

<TODO>

Sample Message

<TODO>

User Authentication

Trigger Events

<TODO>

Message Structure

<TODO>

Sample Message

<TODO>

Patient Record

Trigger Events

<TODO>

Message Structure

<TODO s. ftp://medical.nema.org/medical/dicom/final/cp1323_ft_clarify_audit-codes.pdf>

Sample Message

<TODO>

7.1. Security Profiles 123


DICOM Conformance Statement dcm4che Archive 5, Release 5.10.1

Procedure Record

Trigger Events

<TODO>

Message Structure

<TODO s. ftp://medical.nema.org/medical/dicom/final/cp1323_ft_clarify_audit-codes.pdf>

Sample Message

<TODO>

Audit Trail Message Transmission Profile - SYSLOG-TLS

dcm4che DICOM Archive 5 supports the Audit Trail Message Transmission Profile - SYSLOG-TLS as specified in
DICOM Standard, Part 15, Annex A.6.

Audit Trail Message Transmission Profile - SYSLOG-UDP

dcm4che DICOM Archive 5 supports the Audit Trail Message Transmission Profile - SYSLOG-UDP as specified in
DICOM Standard, Part 15, Annex A.7.

Association Level Security

dcm4che DICOM Archive 5 checks that the Association requestor specifies the correct Called AE Title. Each AE can
be configured to accept Association Requests from only a limited list of Calling AE Titles. In addition the IP address
of the requestor can be checked. Each AE can be configured to accepted only a limited list of Move Destinations in
C-MOVE requests.
Each AE can be configured to associate a particular Access Control ID to received Studies - optionally also dependend
on the Sending AE Title or on any DICOM Attribute of the first received object of the Study. Each AE can also be
configured to hide Studies from access by Query/Retrieve services which associated Access Control ID does not match
with a list of Access Control IDs associated with that AE.
Each AE can be configured to hide objects rejected by IHE IOCM Rejection Notes from access by Query/Retrieve
services dependend on the Key Object Selection Document Title of the Rejection Note.
dcm4che DICOM Archive 5 can be configured to check the Receiving Application and Facility in received HL7 v2
messages. Each HL7 Application provided by dcm4che DICOM Archive 5 can be configured to accept HL7 v2
messages from only a limited list of Sending Application and Facility names.

Application Level Security

RESTful services and the Web UI may be secured with OpenID Connect using Keycloak as Authentication Server.

124 Chapter 7. Security


Index

A V
Abstract Syntax, 12 Value Representation (VR), 13
Application Context, 12
Application Entity (AE), 12
Application Entity Title (AET), 12
Association, 12
Attribute, 12

I
Information Object Definition (IOD), 12

J
Joint Photographic Experts Group (JPEG), 12

M
Media Application Profile, 12
Module, 12

N
Negotiation, 12

P
Presentation Context, 12
Protocol Data Unit (PDU), 12

S
Security Profile, 13
Service Class Provider (SCP), 13
Service Class User (SCU), 13
Service/Object Pair Class (SOP Class), 13
Service/Object Pair Instance (SOP Instance), 13

T
Tag, 13
Transfer Syntax, 13

U
Unique Identifier (UID), 13

125

You might also like