Storage SCP

Description

DICOM Storage SCP. Provides a DICOM storage service to receive DICOM objects from remote DICOM applications. Typically these objects are images received from modalities. You can also configure what DICOM SOP classes are accepted by the StoreScp service using the #AcceptedImageSOPClasses and #AcceptedOtherSOPClasses attributes.

Attributes of received DICOM objects may be coerced with request attributes fetched by the Modality Worklist SCU from the internal Modality Worklist SCP, or from an external Application Entity providing the Modality Worklist.

Coerce Request Attributes

Dependencies

Attributes

#CalledAETitles

List of accepted called AE titles, separated by (backslash). For example, DCM4CHEE\DCM4CHEE2. This AE title is set automatically upon installation. We recommend that you do not try to change this AE title after it has been set, as it must be changed in multiple locations and globally changing the AE title for dcm4chee is difficult.

Default Value: DCM4CHEE

#CallingAETitles

List of accepted calling AE titles, separated by (backslash). ANY = accept any.

Default Value: ANY

#WarnForCoercedAETitles

List of the AE titles for the Storage SCUs for which a warning status, B000, is returned if data elements were coerced. Separate multiple values by (backslash). NONE = no calling AE titles.

Default Value: NONE

#AcceptMissingPatientID

Accept storage of objects/images without patient ID. This value is used in conjunction with the other patient ID values to replace patient IDs that, for example, come from a modality as UNKNOWN. The archive will generate a patient ID for the unknown value based on the #GeneratePatientID attribute.

Default Value: false

#AcceptMissingPatientName

Accept storage of objects/images without patient name. This value is used in conjunction with the other patient name values to replace patient names that, for example, come from a modality as UNKNOWN.

Default Value: false

#AcceptPatientID

Regular Expression for valid Patient IDs. Patient IDs which do not match the specified pattern are ignored and replaced by a Patient ID generated according to the attribute #GeneratePatientID.

Default Value: .*

#IgnorePatientID

Regular Expression for invalid Patient IDs. Patient IDs which match the specified pattern are ignored and replaced by a Patient ID generated according to the attribute #GeneratePatientID.

Default Value: UNKOWN

#IgnorePatientIDAETitles

List of the AE titles for the Storage SCUs for which the Patient ID in received objects is ignored. Usually used together with attribute #GeneratePatientID to generate a new Patient ID for such objects. Separate multiple values by (backslash). NONE = no calling AE titles.

Default Value: NONE

#GeneratePatientID

Generate a patient ID from a hash of the patient name and birth date and/or study instance uid, if

the received object has no patient ID or
the patient ID does not match the pattern defined in #AcceptPatientID or
it match the pattern defined in #IgnorePatientID or
the object is received from an AE listed in #IgnorePatientIDAETitles.

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. But, this means media creation will fail.

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

#IssuerOfPatientIDRules

List of rules used to add the Issuer Of PatientID value if not contained in the received object, if the Patient ID matches the specified regular expression. Multiple rules are separated by new lines.
Format: regExpression:issuer
Example: ^PACS-\d*:DCM4CHEE
If no regular expression is specified, the issuer is added for all patient IDs.

Note that you can set up these rules based on AE title by configuring them in the text file conf\dcm4chee-ae\<AEtitle>\c-store-rq.xsl, where AEtitle is a directory name for each AE title the rules apply to. You can create multiple directories, one for each AE title, each containing a set of issuer of patient ID rules.

Default Value: ^PACS-\d*:DCM4CHEE

#StudyDateInFilePath

Use Study Date in received objects to structure directories of the storage file system. Otherwise - or if the received object does not contain a Study Date - the current date, when receiving the object, is used. (s.a. attributes #YearInFilePath, #MonthInFilePath, #DayInFilePath, #HourInFilePath). Normally, this value is used if importing data from another archive, where you want the file path to reflect when the study actually took place, and not the date that it was imported into the archive. Otherwise, all imported files would have the same archive date, and therefore all be located in the same directory of the storage file system.

Default Value: false

#YearInFilePath

Use the year of Study or receiving Date to structure directories of the storage file system.(s.a. attributes #StudyDateInFilePath, #MonthInFilePath, #DayInFilePath, #HourInFilePath)

Default Value: true

#MonthInFilePath

Use the year of Study or receiving Date to structure directories of the storage file system. (s.a. attributes #StudyDateInFilePath, #YearInFilePath, #DayInFilePath, #HourInFilePath)

Default Value: true

#DayInFilePath

Use the year of Study or receiving Date to structure directories of the storage file system. (s.a. attributes #StudyDateInFilePath, #YearInFilePath, #MonthInFilePath, #HourInFilePath)

Default Value: true

#HourInFilePath

Use the year of Study or receiving Date to structure directories of the storage file system. (s.a. attributes #StudyDateInFilePath, #YearInFilePath, #MonthInFilePath, #DayInFilePath)

Default Value: true

#Md5sum

Generates an MD5 file check sum during storage and keeps it in the database record. Normally, this value is true, unless you are doing specific types of testing where performance is an issue.

Default Value: true

#StoreDuplicatesIfDifferentMD5

Store a duplicate object if the MD5 sum of the new object differs from the MD5 sum of the existing file. If the MD5 sum does not match, the files may be corrupted.

Default Value: true

#StoreDuplicatesIfDifferentHost

Store duplicate objects if the existing files are NOT located on this host.

Default Value: false

#CompressionRules

List of image compression rules. First matching rule for a received object defines its compression. Note that you can use this value to to set a compression method based on image type.

Syntax:
<compression rules> := (<compression rule> <EOL>)+
<compression rule> := [<conditions>] <compression>
<conditions> := '[' <condition> { ',' <condition> } ']'
<condition> := <attribute> ['!']'=' <value> {'|' <value> }
<attribute> := 'calling' | 'called' | 'pmi' | 'cuid' | 'imgtype'
<compression> := 'NONE' | 'JPLL' | 'JLSL' | 'J2KR'

Supported compression modes:

NONE - do not apply compression.
JPLL - JPEG Lossless
JLSL - JPEG-LS Lossless
J2KR - JPEG 2000 Lossless

Attributes usable to for compression conditions:

calling - called AE title. Apply the rule to the called AE titles listed as values.
called - called AE title. Apply the rule to the calling AE titles listed as values.
pmi - photometric interpretation.
cuid - SOP Class UID. Apply the rule for the SOP Class UIDs listed as values.
imgtype - type of image. Apply the rule to the image types listed as values, such as RGB.

The value of the attribute Compression Service#MaxConcurrentCodec also effects the on-the-fly compression and decompression during the store of images by the StoreSCP service.

Default Value:

[calling=SAMPLE_SCU1|SAMPLE_SCU2,pmi!=RGB,imgtype!=LOCALIZER]JLSL
NONE

#CheckPendingSeriesStoredInterval

Interval in days (#d), hours (#h) or minutes (#m) of check for pending Series Stored Notifications, which were not emitted caused by a crash of the Storage Service during an open association.
NEVER = disable check.

Default Value: 1h

#PendingSeriesStoredTimeout

Timeout in hours (#h) or minutes (#m) for emission of Series Stored Notifications after an object of this Series, before the emission of the Notification is triggered by the check for pending Series Stored Notifications.

Default Value: 10m

#SerializeDBUpdate

Serialize updates of DB records for received objects in one association. May decreases Storage Performance!

Default Value: false

#UpdateDatabaseMaximumRetries

Maximum number of retries to update the database records for new received objects, before a processing failure is returned to the Storage SCU.

Default Value: 2

#UpdateDatabasePerformedRetries

Maximum number of retries actually performed to update the database records for new received objects.

#UpdateDatabaseRetryInterval

Delay in milliseconds between retries to update the database records for new received objects.

Default Value: 0

#AcceptedImageSOPClasses

List of image SOP Classes that the Store SCP service accepts. 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:

ComputedRadiographyImageStorage
DigitalXRayImageStorageForPresentation
DigitalXRayImageStorageForProcessing
DigitalMammographyXRayImageStorageForPresentation
DigitalMammographyXRayImageStorageForProcessing
DigitalIntraoralXRayImageStorageForPresentation
DigitalIntraoralXRayImageStorageForProcessing
CTImageStorage
EnhancedCTImageStorage
UltrasoundMultiframeImageStorage
MRImageStorage
EnhancedMRImageStorage
UltrasoundImageStorage
SecondaryCaptureImageStorage
MultiframeSingleBitSecondaryCaptureImageStorage
MultiframeGrayscaleByteSecondaryCaptureImageStorage            MultiframeGrayscaleWordSecondaryCaptureImageStorage
MultiframeTrueColorSecondaryCaptureImageStorage
XRayAngiographicImageStorage
EnhancedXRayAngiographicImageStorage
XRayRadiofluoroscopicImageStorage
EnhancedXRayRadiofluoroscopicImageStorage
NuclearMedicineImageStorage
VLEndoscopicImageStorage
VLMicroscopicImageStorage
VLSlideCoordinatesMicroscopicImageStorage
VLPhotographicImageStorage
OphthalmicPhotography8BitImageStorage
OphthalmicPhotography16BitImageStorage
PositronEmissionTomographyImageStorage
RTImageStorage
HardcopyGrayscaleImageStorage
HardcopyColorImageStorage
NuclearMedicineImageStorageRetired
UltrasoundMultiframeImageStorageRetired
UltrasoundImageStorageRetired
XRayAngiographicBiPlaneImageStorageRetired

#AcceptedTransferSyntaxForImageSOPClasses

List of Transfer Syntaxes for Image SOP Classes that Store SCP service accepts. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names:

ImplicitVRLittleEndian,
ExplicitVRLittleEndian,
DeflatedExplicitVRLittleEndian,
ExplicitVRBigEndian,
JPEGBaseline,
JPEGExtended,
JPEGLossless (=Process 14 [Selection Value 1]),
JPEGLossless14,
JPEGLSLossless,
JPEGLSLossy,
JPEG2000Lossless,
JPEG2000Lossy,
RLELossless

Default Value:

JPEGLossless
JPEGLossless14
JPEGLSLossless
RLELossless
JPEG2000Lossless
JPEG2000Lossless
ExplicitVRLittleEndian
ImplicitVRLittleEndian
JPEGBaseline
JPEGExtended
JPEGLSLossy
JPEG2000Lossy

#AcceptedVideoSOPClasses

List of Video SOP Classes that the Store SCP service accepts. 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:

VideoEndoscopicImageStorage
VideoMicroscopicImageStorage
VideoPhotographicImageStorage

#AcceptedTransferSyntaxForVideoSOPClasses

List of Transfer Syntaxes for Video SOP Classes that Store SCP service accepts. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names:

MPEG2

Default Value: MPEG2

#AcceptedWaveformSOPClasses

List of Waveform SOP Classes that the Store SCP service accepts. 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:

TwelveLeadECGWaveformStorage
GeneralECGWaveformStorage
AmbulatoryECGWaveformStorage
HemodynamicWaveformStorage
CardiacElectrophysiologyWaveformStorage
BasicVoiceAudioWaveformStorage

#AcceptedTransferSyntaxForWaveformSOPClasses

List of Transfer Syntaxes for Waveform SOP Classes that Store SCP service accepts. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names:

ImplicitVRLittleEndian,
ExplicitVRLittleEndian,
DeflatedExplicitVRLittleEndian,
ExplicitVRBigEndian

Default Value:

ExplicitVRLittleEndian
ImplicitVRLittleEndian

#AcceptedSRSOPClasses

List of Structured Report Document SOP Classes that the Store SCP service accepts.
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

#AcceptedTransferSyntaxForSRSOPClasses

List of Transfer Syntaxes for Structured Report Document SOP Classes that Store SCP service accepts. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names:

ImplicitVRLittleEndian,
ExplicitVRLittleEndian,
DeflatedExplicitVRLittleEndian,
ExplicitVRBigEndian

Default Value:

DeflatedExplicitVRLittleEndian
ExplicitVRLittleEndian
ImplicitVRLittleEndian

#AcceptedOtherSOPClasses

List of other (than Image, Video, Waveform, Structured Report) SOP Classes that the Store SCP service accepts.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:

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

#AcceptedTransferSyntaxForOtherSOPClasses

List of Transfer Syntaxes for other (than Image, Video, Waveform, Structured Report) SOP Classes that Store SCP service accepts. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names:

ImplicitVRLittleEndian,
ExplicitVRLittleEndian,
DeflatedExplicitVRLittleEndian,
ExplicitVRBigEndian

Default Value:

ExplicitVRLittleEndian
ImplicitVRLittleEndian

#CheckIncorrectWorklistEntry

Check if a received instance should be ignored due to 'Incorrect Worklist Entry Selected'.

Default Value: true

#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

#BufferSize

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

Default Value: 8192

#LogAETitles

List of the AE titles for the Storage SCUs for which XMLized object attributes are logged into files <AET>/<timestamp>-cstorerq.xml in the log directory. Useful for creation of XSL stylesheets for attribute coercion. Separate multiple values by \ (backslash). NONE = no calling AE titles.

Default Value: NONE

#CoerceConfigDirectory

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

Default Value: conf/dcm4chee-ae

#EJBProviderURL

Identifies JNDI (e.g: jnp://hostname:1099) with EJBs.Use LOCAL if EJBs are deployed in same JBoss instance.

Default Value: LOCAL