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.
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
List of accepted calling AE titles, separated by '
' (backslash). ANY = accept any.
Default Value: ANY
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
List of the AE titles for the Storage SCUs from which storage requests with Affected SOP Instance UID in the command differs from the SOP Instance UID are accepted.
Separate multiple values by '
' (backslash). NONE = no calling AE titles.
Default Value: NONE
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
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
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: .*
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
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
Generate a patient ID from a hash of the patient name and birth date and/or study instance uid, if
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-##########
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
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
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
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
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
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
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
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
Store duplicate objects if the existing files are NOT located on this host.
Default Value: false
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 LosslessJLSL
- JPEG-LS LosslessJ2KR
- JPEG 2000 LosslessAttributes 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 |
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
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
Serialize updates of DB records for received objects in one association. This may decrease storage performance! If however, you have small objects and a network delay, such as a long distance network, it could make sense to turn on this feature.
Default Value: false
Maximum number of retries to update the database records for new received objects, before a processing failure is returned to the Storage SCU. If you have many modalities sending concurrently, you will have a higher retry rate.
Default Value: 2
Maximum number of retries actually performed to update the database records for new received objects.
Delay in milliseconds between retries to update the database records for new received objects.
Default Value: 0
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 |
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:
Default Value:
JPEGLossless JPEGLossless14 JPEGLSLossless RLELossless JPEG2000Lossless JPEG2000Lossless ExplicitVRLittleEndian ImplicitVRLittleEndian JPEGBaseline JPEGExtended JPEGLSLossy JPEG2000Lossy |
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 |
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:
Default Value: MPEG2
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 |
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:
Default Value:
ExplicitVRLittleEndian ImplicitVRLittleEndian |
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 |
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:
Default Value:
DeflatedExplicitVRLittleEndian ExplicitVRLittleEndian ImplicitVRLittleEndian |
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 DeformableSpatialRegistrationStorage SegmentationStorage RealWorldValueMappingStorage StereometricRelationshipStorage EncapsulatedPDFStorage RTDoseStorage RTStructureSetStorage RTBeamsTreatmentRecordStorage RTPlanStorage RTBrachyTreatmentRecordStorage RTTreatmentSummaryRecordStorage RTIonPlanStorage RTIonBeamsTreatmentRecordStorage StandaloneOverlayStorage StandaloneCurveStorage StandaloneModalityLUTStorage StandaloneVOILUTStorage StandalonePETCurveStorage AgfaAttributePresentationState |
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:
Default Value:
ExplicitVRLittleEndian ImplicitVRLittleEndian |
Check if a received instance should be ignored due to 'Incorrect Worklist Entry Selected'. In the IHE scheduled workflow profile, if a modality sends an MPPS discontinue message, with the reason listed as "incorrect entry was selected from the worklist", and this flag is set to TRUE, the archive deletes any received instances related to the incorrect MPPS message. (Currently, we are not aware of any modalities that are actually connected to the archive that use this setting.)
Default Value: true
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
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
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
Size of byte buffer used for copying data from TCP channel to file.
Default Value: 8192
List of the AE titles for the Storage SCUs for which the object attributes are logged into filesĀ in XML format. The files are stored in the log directory in the location: <AET>/<timestamp>-cstorerq.xml. These XML files are useful for creation of XSL stylesheets for attribute coercion. Normally, you would turn this one when adding a new modality to determine if you are missing critical information that must then be substituted or "coerced" using stylesheets.
Separate multiple values by \ (backslash). NONE = no calling AE titles.
Default Value: NONE
Directory where configuration files for attribute coercion are located. If the 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 stylesheets. A relative path name is resolved relative to dcm4chee_home/server/default/.
Default Value: conf/dcm4chee-ae
Identifies JNDI (e.g: jnp://hostname:1099) with EJBs.Use LOCAL if EJBs are deployed in same JBoss instance.
Default Value: LOCAL
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=Scheduler
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=FileSystemMgt
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=MWLScu
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=DcmServer
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=AuditLogger
The timer ID for scheduler of checking pending series stored.
Default Value: CheckPendingSeriesStored
The class name of the MBean
The status of the MBean
The status of the MBean in text form
Standard MBean lifecycle method
The start lifecycle operation
The stop lifecycle operation
The destroy lifecycle operation
The detyped lifecycle operation (for internal use only)
Reset Update Database - Performed Retries to 0.
Reload Stylesheets
Import a DICOM file (internal use only)
The notification sent whenever a Series of DICOM composite object was received. It is triggered by the receive of an object belonging to a different Series than the objects received before and at the latests when the association is released.