Query Retrieve SCP

Description

DICOM Query/Retrieve SCP. Provides the DICOM Query/Retrieve SCP.

The value of the Compression Service#MaxConcurrentCodec also effects the on-the-fly compression and decompression during the retrieve of images by the QueryRetrieveScp service

Patient Level Attributes
Study Level Attributes
Series Level Attributes
Instance Level Attributes

Dependencies

Attributes

#CalledAETitles

Accepted called AE titles, separated by \ (backslash).

Default Value: DCM4CHEE

#CallingAEtitles

Accepted calling AE titles, separated by \ (backslash).
ANY = accept any.

Default Value: ANY

#GeneratePatientID

Generate a patient ID from a hash of the patient name and birth date and/or study instance uid, if the received MPPS N-CREATE message contains no patient ID.

Use ### and/or $$$ as a placeholder for the decimal hash value of patient name and/or study instance uid.
For example, PACS-##########.
NONE = do not generate patient IDs.

Default Value: PACS-##########

#IssuerOfPatientIDGeneratedPatientID

Value for Issuer Of Patient ID if the patient ID is generated according configured #GeneratePatientID.
NONE = do not set Issuer Of Patient ID for generated patient IDs.

Default Value: DCM4CHEE

Supplement received C-FIND RQ identifier containing a Patient ID, but no Issuer Of Patient ID, with a value for Issuer Of Patient ID, if such is associated with the C-FIND SCU AE by its AE Configuration entry.

Default Value: false

#SendWithDefaultTransferSyntaxToAETitles

Move Destination AE titles to which objects are sent always with Default (=Implicit VR Little Endian) Transfer Syntax, which implies, that compressed stored images are always decompressed by this service for retrieval. Separate multiple values by (backslash).
NONE = no AE titles match this criteria.

Default Value: NONE

#SendNoPixelDataToAETitles

Move Destination AE titles to which images are sent without pixel data. Separate multiple values by (backslash).
NONE = no AE titles match this criteria. This means that the DICOM header can be registered in a database, but not pixel data is stored.

Default Value: NONE

#IgnoreUnsupportedSOPClassFailures

Move Destination AE titles to which failures, caused by unsupported SOP Classes, in transmitting objects shall NOT return a warning status "Sub-Operation fails" in the final Move Response to the Move SCU.
NONE = no AE titles match this criteria.

Default Value: NONE

#PIXQueryCallingAETitles

AE Titles of C-FIND SCUs, for which a PIX Query of the data base or an external Patient Cross-reference (PIX) Manager shall be executed, if the query request contains a matching key for the Patient ID, to return also entities of linked patients. Separate multiple values by \ (backslash).
ANY = Enable PIX Queries for all C-FIND SCUs.

Default Value: ANY

#PIXQueryIssuersOfPatientID

Comma separated list of values for Issuers of Patient IDs in C-FIND RQs, for which a PIX Query of the data base or an external Patient Cross-reference (PIX) Manager shall be executed to return also entities of linked patients.
ANY = Execute PIX Queries for any Issuer of Patient ID.

Default Value: SSN

#PIXQueryDefaultIssuerOfPatientID

Value for Issuer of Patient ID used for PIX Queries, if the query request does not contains a value for the Issuer of Patient ID. Only effective, if #PIXQueryIssuersOfPatientID = ANY.

Default Value: DCM4CHEE

#CoerceRequestPatientIds

Override PatientId and IssuerOfPatientID, and those values contained in the OtherPatientIDSequence with the values from the request (including PIX Query results).

Default Value: false

#CoerceRequestPatientIdsAETitles

AE Titles of C-FIND SCUs, for which to Override PatientId and IssuerOfPatientID, and those values contained in the OtherPatientIDSequence with the values from the request (including PIX Query results). Separate multiple values by \ (backslash).
ANY = Override Ids for all C-FIND SCUs. Only effective, if #CoerceRequestPatientIds = true.

Default Value: NONE

#UnrestrictedQueryPermissionsToAETitles

AE Titles of C-FIND SCUs with Query Permissions on all archived Studies, independent of Study Permissions to roles of the user associated to the active association. Separate multiple values by \ (backslash).
ANY = Disable restriction of queries according granted Study Permissions.

Default Value: ANY

#UnrestrictedReadPermissionsToAETitles

AE Titles of Move Destinations with Read Permissions on all archived Studies, independent of Study Permissions to roles of the user associated with the AE.
Separate multiple values by \ (backslash).
ANY = Disable restriction of retrieve to Move Destinations according granted Study Read Permissions.

Default Value: ANY

For successful Media Creation by the archive, the AE Title of the Media Creation Service (default: CDRECORD) have to be included in the configured list.

If the Move Destination differs from the AE requesting the retrieve (= C-MOVE SCU), the associated user is defined by the AE configuration entry. If the C-MOVE SCU also acts as Move Destination, the user identification may be also provided by C-MOVE SCU by User Identity Negotiation.

#UnrestrictedExportPermissionsToAETitles

AE Titles of C-MOVE SCUs with Export Permissions on all archived Studies, independent of Study Permissions to roles of the user associated to the request association. Separate multiple values by \ (backslash).
ANY = Disable restriction of queries according granted Study Permissions.

Default Value: ANY

For successful auto-forwarding of received objects as for manual DICOM export using the Web Interface, the Calling AE Title of the internal Move SCU Service (default: DCM4CHEE) have to be included in the configured list.

If the C-MOVE SCU also acts as Move Destination, no Export Permission - but still Read Permission - is needed to retrieve a Study.

#IgnorableSOPClasses

Failed transfer of instances of listed SOP Classes to move destinations caused by rejection of the SOP Class by the destination STORE SCP will NOT result in a warning status "Sub-Operation fails" in the final Move Response to the Move SCU. Use either the SOP Class UID value or the name specified in DICOM Part 6, Annex A Registry of DICOM unique identifiers, concatenating individual words without spaces.

Default Value:

BasicTextSR
EnhancedSR
ComprehensiveSR
ProcedureLogStorage
MammographyCADSR
KeyObjectSelectionDocument
ChestCADSR
XRayRadiationDoseSR
TwelveLeadECGWaveformStorage
GeneralECGWaveformStorage
AmbulatoryECGWaveformStorage
HemodynamicWaveformStorage
CardiacElectrophysiologyWaveformStorage
BasicVoiceAudioWaveformStorage
MRSpectroscopyStorage
GrayscaleSoftcopyPresentationStateStorage
ColorSoftcopyPresentationStateStorage
PseudoColorSoftcopyPresentationStateStorage
BlendingSoftcopyPresentationStateStorage
RawDataStorage
SpatialRegistrationStorage
SpatialFiducialsStorage
RealWorldValueMappingStorage
StereometricRelationshipStorage
EncapsulatedPDFStorage
RTDoseStorage
RTStructureSetStorage
RTBeamsTreatmentRecordStorage
RTPlanStorage
RTBrachyTreatmentRecordStorage
RTTreatmentSummaryRecordStorage
RTIonPlanStorage
RTIonBeamsTreatmentRecordStorage
StandaloneOverlayStorage
StandaloneCurveStorage



StandaloneModalityLUTStorage
StandaloneVOILUTStorage
StandalonePETCurveStorage
AgfaAttributePresentationState
SiemensCSANonImageStorage
StructuredReportTextStorageRetired
StructuredReportAudioStorageRetired
StructuredReportDetailStorageRetired
StructuredComprehensiveStorageRetired

#RequestStorageCommitFromAETitles

Move Destination AE titles, from which Storage Commitment for transmitted objects shall be requested.
Format: <storage scp aet> ':' <storage commitment scp aet>
The AE title of the Storage Commitment Service <storage commitment scp aet> can be omitted, if identical to the AE title of the Move Destination <storage scp aet>. Separate multiple values with a (backslash). NONE = No Move Destination from which Storage Commitment will be requested.

The use case for this value is when you have a central archive and a satellite archive. When you want the satellite archive to receive a storage commit message from the central archive, set the value to the AET of the central archive.

Default Value: NONE

#NoMatchForNoValue

Do not match entities with zero-length value for specified matching keys (= non DICOM conform matching behavior). For example, when searching for studies by accession number in the web Administration Tools, Folder tab, if this value is set to FALSE, then all studies with matching accession numbers and all studies that have no accession number defined (NULL value) are returned. The normal case, however, is to always have this value set to TRUE.

Default Value: true

#AcceptedStandardSOPClasses

List of accepted Query/Retrieve SOP Classes. Use either the SOP Class UID value, or following defined symbolic names:

PatientRootQueryRetrieveInformationModelFIND,
PatientRootQueryRetrieveInformationModelGET,
PatientRootQueryRetrieveInformationModelMOVE,
StudyRootQueryRetrieveInformationModelFIND,
StudyRootQueryRetrieveInformationModelGET,
StudyRootQueryRetrieveInformationModelMOVE,
PatientStudyOnlyQueryRetrieveInformationModelFIND,
PatientStudyOnlyQueryRetrieveInformationModelGET,
PatientStudyOnlyQueryRetrieveInformationModelMOVE,

Default Value:

PatientRootQueryRetrieveInformationModelFIND
PatientRootQueryRetrieveInformationModelGET
PatientRootQueryRetrieveInformationModelMOVE
StudyRootQueryRetrieveInformationModelFIND
StudyRootQueryRetrieveInformationModelGET
StudyRootQueryRetrieveInformationModelMOVE
PatientStudyOnlyQueryRetrieveInformationModelFIND
PatientStudyOnlyQueryRetrieveInformationModelGET
PatientStudyOnlyQueryRetrieveInformationModelMOVE

#AcceptedTransferSyntaxForStandardSOPClasses

List of accepted Transfer Syntaxes. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names:

ImplicitVRLittleEndian,
ExplicitVRLittleEndian,
DeflatedExplicitVRLittleEndian,
ExplicitVRBigEndian

Default Value:

ImplicitVRLittleEndian

#AcceptedPrivateSOPClasses

List of accepted Query/Retrieve SOP Classes. Use either the SOP Class UID value, or following defined symbolic names:

Dcm4cheStudyRootQueryRetrieveInformationModelFIND,
Dcm4cheBlockedStudyRootQueryRetrieveInformationModelFIND,
Dcm4cheVirtualMultiFrameStudyRootQueryRetrieveInformationModelFIND,

Default Value:

Dcm4cheStudyRootQueryRetrieveInformationModelFIND
Dcm4cheBlockedStudyRootQueryRetrieveInformationModelFIND
Dcm4cheVirtualMultiFrameStudyRootQueryRetrieveInformationModelFIND

#AcceptedTransferSyntaxForPrivateSOPClasses

List of accepted Transfer Syntaxes. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names:

ImplicitVRLittleEndian,
ExplicitVRLittleEndian,
DeflatedExplicitVRLittleEndian,
ExplicitVRBigEndian

Default Value:

ImplicitVRLittleEndian
ExplicitVRLittleEndian
DeflatedExplicitVRLittleEndian

#MaximumBlockedFindResponse

Maximum number of result records blocked in one Find Response by Private Blocked FIND services.

Default Value: 1000

#VirtualEnhancedCTConfigFile

Configuration file which defines included attributes in Enhanced CT Instance enities return by Private Virtual Multiframe FIND Service. A relative path name is resolved relative to dcm4chee_home/server/default/.

Default Value: conf/dcm4chee-vmf/enhanced-ct.xml

#VirtualEnhancedMRConfigFile

Configuration file which defines included attributes in Enhanced MR Instance entities return by Private Virtual Multiframe FIND Service. A relative path name is resolved relative to dcm4chee_home/server/default/.

Default Value: conf/dcm4chee-vmf/enhanced-mr.xml

#LogAETitles

List of the AE titles for the Q/R SCUs for which XMLized query and result attributes are logged into files <AET>/<timestamp>-cfindrq.xml and <AET>/<timestamp>-cfindrsp.xml in the log directory. Useful for creation of XSL stylesheets for query/result attribute coercion. Separate multiple values by (backslash). NONE = no calling AE titles.

Default Value: NONE

#CoerceConfigDirectory

Directory where configuration files for query/result attribute coercion are located: if XSL stylesheet "cfindrq.xsl" or "cfindrsp.xsl" exists in this directory or a sub-directory equal to the AE Title of a QR SCU, query/result attributes from/to this SCU will be coerced according these stylesheets. A relative path name is resolved relative to dcm4chee_home/server/default/.

Default Value: conf/dcm4chee-ae

#SendPendingRetrieveResponse

Flag indicating if optional C-Move/C-Get Response DICOM message with pending status are returned in the interval defined by attribute #PendingMoveRSPInterval.

Default Value: true

#PendingRetrieveResponseInterval

Interval in ms in which C-Move/C-Get Response DICOM message with pending status are returned. Even send (identical) response messages, if no storage sub-operation was performed during such interval, to keep the association alive. Only effective, if sending C-Move/C-Get Response DICOM message with pending status is activated by attribute #SendPendingRetrieveResponse.

Default Value: 5000

#ForwardAsMoveOriginator

Use the calling AE title of the requesting Move SCU instead of the called AE title when opening an association to another Move SCP to forward a Move Request. The use case for this value is the situation in which a study resides in a central archive, but is no longer available in a satellite archive. The satellite archive forwards these requests to the central archive. (This feature is required for routing/forwarding options.)

Default Value: true

#RecordStudyAccessTime

Record last retrieve time of instances of a study. Should be enabled, if the delete functions of the File System Management Service are activated, to delete the most infrequently accessed studies.

Default Value: true

#CheckMatchingKeySupported

Enable check if unsupported matching key(s) are used in C-FIND. In this case the C-FIND PENDING status is changed from 0xff00 (success) to 0xff01 (warning).

Default Value: true

#MaximumUIDsPerMoveRequest

Maximum number of SOP Instance UIDs in forwarded Move Requests. Larger Move Requests are split into smaller ones according to this constraint.

Default Value: 100

#MaximumPDULength

Maximum protocol data unit (PDU) package length for receiving PDUs.

This property should be set to equal values for all DICOM SCP services with same called AE Title(s). Otherwise it is non-deterministic, which configured value is effective.

Default Value: 16352

#MaximumOperationsInvoked

The maximum number of outstanding operations and/or sub-operations it allows the Association-requester to invoke asynchronously. A value of zero indicates an unlimited number of outstanding operations.

This property should be set to equal values for all DICOM SCP services with same called AE Title(s). Otherwise it is non-deterministic, which configured value is effective.

Default Value: 1

#MaximumOperationsPerformed

The maximum number of outstanding operations and/or sub-operations it allows the Association-requester to perform asynchronously. A value of zero indicates an unlimited number of outstanding operations.

This property should be set to equal values for all DICOM SCP services with same called AE Title(s). Otherwise it is non-deterministic, which configured value is effective.

Default Value: 1

#MaximumStorageOperationsInvoked

The maximum number of asynchronously invoked storage operations. A value of zero indicates an unlimited number.

Default Value: 0

#AcceptTimeout

A-Associate accept timeout in milliseconds. 0 = no timeout.

Default Value: 10000

#DIMSETimeout

DIMSE message timeout in milliseconds. 0 = no timeout.

Default Value: 60000

#SocketCloseDelay

Socket close delay in milliseconds after an A-Release response.

Default Value: 50

#TcpNoDelay

Send packets as quickly as possible (Disable Nagle's algorithmn).

Default Value: true

#SendBufferSize

Buffer size used for socket output. 0 = use platform default.

Default Value: 0

#ReceiveBufferSize

Buffer size used for socket input. 0 = use platform default.

Default Value: 0

#BufferSize

Size of byte buffer used for copying data from TCP channel to file.

Default Value: 8192

#RetrieveWithoutLeftJoins

Controls usage of LEFT JOINS in executed SQL statement triggered by retrieve requests.
Must be set to false, if the archive is configured as short-term cache, which delegates long-term storage to an external DICOM archive and therefore does not hold file records for each stored instance!

Default Value: false

#LazyFetchSeriesAttrsOnImageLevelQuery

Activates lazy fetch of Series, Study and Instance attributes stored in BLOB columns by an additional query for each series.on queries on IMAGE level.

Default Value: false

#CacheSeriesAttrsOnImageLevelQuery

Activates caching of Series attributes between IMAGE level C-FIND RSPs, which reduces the number of BLOB access from 4 x Number of matching Instances to Number of matching Instances + 3 * Number of different Series. Implicit set by #LazyFetchSeriesAttrsOnImageLevelQuery = true.

Default Value: true

#AccessBlobAsLongVarBinaryOnQuery

Change JDBC binding for Oracle BLOB's to LONGVARBINARY for accessing attributes stored in BLOB columns of DB records on query.
Only effective with Oracle as DB.

Default Value: true

#AccessSeriesBlobAsLongVarBinaryOnImageLevelQuery

Change JDBC binding for Oracle BLOB's to LONGVARBINARY for accessing Patient, Study and Series attributes stored in BLOB columns of DB records on query on IMAGE level. Only effective with Oracle as DB. Should only be enabled with #LazyFetchSeriesAttrsOnImageLevelQuery = true or #CacheSeriesAttrsOnImageLevelQuery = false.

Default Value: false

#LazyFetchSeriesAttrsOnRetrieve

Activates lazy fetch of Series, Study and Instance attributes stored in BLOB columns by an additional query for each series.on DICOM Retrieve and access by WADO with contentType=application/dicom.

Default Value: false

#CacheSeriesAttrsOnRetrieve

Activates caching of Series attributes on DICOM Retrieve, - but also for successive WADO requests for Instances of the same Series - which reduces the number of BLOB access from 4 x Number of retrieved Instances to Number of retrieved Instances + 3 * Number of different Series. Implicit set by #LazyFetchSeriesAttrsOnRetrieve = true.

Default Value: true

#CacheSeriesAttrsOnRetrieveMaxSize

Defines maximal number of Series, which attributes are cached on retrieve of Instances.
Only effective if #CacheSeriesAttrsOnRetrieve = true.

Default Value: 100

#CacheSeriesAttrsOnRetrieveCurrencyTimeLimit

Defines how long cached Series Attributes on retrieve are valid.
Format: ##s (in seconds), ##m (in minutes)
Only effective if #CacheSeriesAttrsOnRetrieve = true

Default Value: 1m

#AccessBlobAsLongVarBinaryOnRetrieve

Change JDBC binding for Oracle BLOB's to LONGVARBINARY for accessing attributes stored in BLOB columns of DB records on retrieve.
Only effective with Oracle as DB.

Default Value: true

#AccessSeriesBlobAsLongVarBinaryOnRetrieve

Change JDBC binding for Oracle BLOB's to LONGVARBINARY for accessing Patient, Study and Series attributes stored in BLOB columns of DB records on retrieve. Only effective with Oracle as DB. Should only be enabled with #LazyFetchSeriesAttrsOnRetrieve = true or #CacheSeriesAttrsOnRetrieve = false.

Description

Dependencies

Attributes

Operations

Notifications