Package org.dcm4che.typeddicom.iods

Class InventoryIOD

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractInformationObjectDefinition

org.dcm4che.typeddicom.iods.InventoryIOD

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, AuthorizationEquipmentCertificationNumber.Holder, BarcodeValue.Holder, CodingSchemeIdentificationSequence.Holder, ContentDate.Holder, ContentQualification.Holder, ContentTime.Holder, ContextGroupIdentificationSequence.Holder, ContributingEquipmentSequence.Holder, ConversionSourceAttributesSequence.Holder, DateOfLastCalibration.Holder, DeviceSerialNumber.Holder, DeviceUID.Holder, DigitalSignaturesSequence.Holder, EncryptedAttributesSequence.Holder, GantryID.Holder, HL7StructuredDocumentReferenceSequence.Holder, IncorporatedInventoryInstanceSequence.Holder, InstanceCoercionDateTime.Holder, InstanceCreationDate.Holder, InstanceCreationTime.Holder, InstanceCreatorUID.Holder, InstanceNumber.Holder, InstanceOriginStatus.Holder, InstitutionAddress.Holder, InstitutionalDepartmentName.Holder, InstitutionalDepartmentTypeCodeSequence.Holder, InstitutionName.Holder, InventoriedStudiesSequence.Holder, InventoryAccessEndPointsSequence.Holder, InventoryCompletionStatus.Holder, InventoryContentLevel.Holder, InventoryInstanceDescription.Holder, InventoryPurpose.Holder, LongitudinalTemporalInformationModified.Holder, MACParametersSequence.Holder, Manufacturer.Holder, ManufacturerDeviceClassUID.Holder, ManufacturerModelName.Holder, MappingResourceIdentificationSequence.Holder, NumberOfStudyRecordsInInstance.Holder, OriginalAttributesSequence.Holder, OriginalSpecializedSOPClassUID.Holder, PixelPaddingValueAsSS.Holder, PixelPaddingValueAsUS.Holder, PrivateDataElementCharacteristicsSequence.Holder, QueryRetrieveView.Holder, ReferencedDefinedProtocolSequence.Holder, ReferencedPerformedProtocolSequence.Holder, RelatedGeneralSOPClassUID.Holder, ScopeOfInventorySequence.Holder, SoftwareVersions.Holder, SOPAuthorizationComment.Holder, SOPAuthorizationDateTime.Holder, SOPClassUID.Holder, SOPInstanceStatus.Holder, SOPInstanceUID.Holder, SpatialResolution.Holder, SpecificCharacterSet.Holder, StationName.Holder, StudyAccessEndPointsSequence.Holder, TimeOfLastCalibration.Holder, TimezoneOffsetFromUTC.Holder, TotalNumberOfStudyRecords.Holder, TransactionUID.Holder, UDISequence.Holder, GeneralEquipmentModule, InventoryModule, SOPCommonModule

public class InventoryIOD
extends org.dcm4che.typeddicom.AbstractInformationObjectDefinition
implements GeneralEquipmentModule, InventoryModule, SOPCommonModule

Name: Inventory IOD
Description:

The Inventory IOD defines an Inventory of all Studies, Series, and SOP Instances managed by a repository, or a specified subset of those Studies, Series, and SOP Instances. It includes information about the available mechanisms to access such Studies, Series, and SOP Instances, including both DICOM and non-DICOM protocols. The Inventory provides selected Patient, Procedure, and Imaging Service Request Attribute values for the inventoried Studies.

For implementation-specific reasons, a complete Inventory may need to be divided across multiple SOP Instances. The Inventory IOD allows a SOP Instance to reference other SOP Instances whose content is logically included by such reference. A complete inventory thus consists of one root SOP Instance, with a tree of references to additional SOP Instances, the content of all of which comprises the Inventory.

Note

See additional explanatory information in PS3.17 chapterYYYY, including discussion of the use of the Repository Query SOP Class or the Inventory Creation SOP Class to produce an Inventory SOP Instance.

See Also:

DICOM Standard Part 3 - Inventory IOD

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InventoryIOD.Builder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.modules.GeneralEquipmentModule

GeneralEquipmentModule.SimpleWrapper

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.modules.InventoryModule

InventoryModule.SimpleWrapper

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.modules.SOPCommonModule

SOPCommonModule.SimpleWrapper

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Set<org.dcm4che.typeddicom.SOPClass>	STANDARD_SOP_CLASSES

Constructor Summary

Constructors

Constructor	Description
InventoryIOD()
InventoryIOD(org.dcm4che3.data.Attributes attributes)

Method Summary

Modifier and Type	Method	Description
static InventoryIOD.Builder	builder()
static InventoryIOD.Builder	builder(org.dcm4che3.data.Attributes attributes)
java.util.Set<org.dcm4che.typeddicom.SOPClass>	getStandardSOPClasses()

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

equals, getAttributes, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.dataelements.AuthorizationEquipmentCertificationNumber.Holder

containsAuthorizationEquipmentCertificationNumber, getAuthorizationEquipmentCertificationNumber, removeAuthorizationEquipmentCertificationNumber

Methods inherited from interface org.dcm4che.typeddicom.dataelements.BarcodeValue.Holder

containsBarcodeValue, getBarcodeValue, removeBarcodeValue

Methods inherited from interface org.dcm4che.typeddicom.dataelements.CodingSchemeIdentificationSequence.Holder

containsCodingSchemeIdentificationSequence, ensureCodingSchemeIdentificationSequence, ensureCodingSchemeIdentificationSequence, getCodingSchemeIdentificationSequence, newCodingSchemeIdentificationSequence, removeCodingSchemeIdentificationSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ContentDate.Holder

containsContentDate, getContentDate, removeContentDate

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ContentQualification.Holder

containsContentQualification, getContentQualification, removeContentQualification

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ContentTime.Holder

containsContentTime, getContentTime, removeContentTime

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ContextGroupIdentificationSequence.Holder

containsContextGroupIdentificationSequence, ensureContextGroupIdentificationSequence, ensureContextGroupIdentificationSequence, getContextGroupIdentificationSequence, newContextGroupIdentificationSequence, removeContextGroupIdentificationSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ContributingEquipmentSequence.Holder

containsContributingEquipmentSequence, ensureContributingEquipmentSequence, ensureContributingEquipmentSequence, getContributingEquipmentSequence, newContributingEquipmentSequence, removeContributingEquipmentSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ConversionSourceAttributesSequence.Holder

containsConversionSourceAttributesSequence, ensureConversionSourceAttributesSequence, ensureConversionSourceAttributesSequence, getConversionSourceAttributesSequence, newConversionSourceAttributesSequence, removeConversionSourceAttributesSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.DateOfLastCalibration.Holder

containsDateOfLastCalibration, getDateOfLastCalibration, removeDateOfLastCalibration

Methods inherited from interface org.dcm4che.typeddicom.dataelements.DeviceSerialNumber.Holder

containsDeviceSerialNumber, getDeviceSerialNumber, removeDeviceSerialNumber

Methods inherited from interface org.dcm4che.typeddicom.dataelements.DeviceUID.Holder

containsDeviceUID, getDeviceUID, removeDeviceUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.DigitalSignaturesSequence.Holder

containsDigitalSignaturesSequence, ensureDigitalSignaturesSequence, ensureDigitalSignaturesSequence, getDigitalSignaturesSequence, newDigitalSignaturesSequence, removeDigitalSignaturesSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.EncryptedAttributesSequence.Holder

containsEncryptedAttributesSequence, ensureEncryptedAttributesSequence, ensureEncryptedAttributesSequence, getEncryptedAttributesSequence, newEncryptedAttributesSequence, removeEncryptedAttributesSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.GantryID.Holder

containsGantryID, getGantryID, removeGantryID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.HL7StructuredDocumentReferenceSequence.Holder

containsHL7StructuredDocumentReferenceSequence, ensureHL7StructuredDocumentReferenceSequence, ensureHL7StructuredDocumentReferenceSequence, getHL7StructuredDocumentReferenceSequence, newHL7StructuredDocumentReferenceSequence, removeHL7StructuredDocumentReferenceSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.IncorporatedInventoryInstanceSequence.Holder

containsIncorporatedInventoryInstanceSequence, ensureIncorporatedInventoryInstanceSequence, ensureIncorporatedInventoryInstanceSequence, getIncorporatedInventoryInstanceSequence, newIncorporatedInventoryInstanceSequence, removeIncorporatedInventoryInstanceSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstanceCoercionDateTime.Holder

containsInstanceCoercionDateTime, getInstanceCoercionDateTime, removeInstanceCoercionDateTime

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstanceCreationDate.Holder

containsInstanceCreationDate, getInstanceCreationDate, removeInstanceCreationDate

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstanceCreationTime.Holder

containsInstanceCreationTime, getInstanceCreationTime, removeInstanceCreationTime

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstanceCreatorUID.Holder

containsInstanceCreatorUID, getInstanceCreatorUID, removeInstanceCreatorUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstanceNumber.Holder

containsInstanceNumber, getInstanceNumber, removeInstanceNumber

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstanceOriginStatus.Holder

containsInstanceOriginStatus, getInstanceOriginStatus, removeInstanceOriginStatus

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstitutionAddress.Holder

containsInstitutionAddress, getInstitutionAddress, removeInstitutionAddress

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstitutionalDepartmentName.Holder

containsInstitutionalDepartmentName, getInstitutionalDepartmentName, removeInstitutionalDepartmentName

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstitutionalDepartmentTypeCodeSequence.Holder

containsInstitutionalDepartmentTypeCodeSequence, ensureInstitutionalDepartmentTypeCodeSequence, ensureInstitutionalDepartmentTypeCodeSequence, getInstitutionalDepartmentTypeCodeSequence, newInstitutionalDepartmentTypeCodeSequence, removeInstitutionalDepartmentTypeCodeSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstitutionName.Holder

containsInstitutionName, getInstitutionName, removeInstitutionName

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InventoriedStudiesSequence.Holder

containsInventoriedStudiesSequence, ensureInventoriedStudiesSequence, ensureInventoriedStudiesSequence, getInventoriedStudiesSequence, newInventoriedStudiesSequence, removeInventoriedStudiesSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InventoryAccessEndPointsSequence.Holder

containsInventoryAccessEndPointsSequence, ensureInventoryAccessEndPointsSequence, ensureInventoryAccessEndPointsSequence, getInventoryAccessEndPointsSequence, newInventoryAccessEndPointsSequence, removeInventoryAccessEndPointsSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InventoryCompletionStatus.Holder

containsInventoryCompletionStatus, getInventoryCompletionStatus, removeInventoryCompletionStatus

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InventoryContentLevel.Holder

containsInventoryContentLevel, getInventoryContentLevel, removeInventoryContentLevel

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InventoryInstanceDescription.Holder

containsInventoryInstanceDescription, getInventoryInstanceDescription, removeInventoryInstanceDescription

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InventoryPurpose.Holder

containsInventoryPurpose, getInventoryPurpose, removeInventoryPurpose

Methods inherited from interface org.dcm4che.typeddicom.dataelements.LongitudinalTemporalInformationModified.Holder

containsLongitudinalTemporalInformationModified, getLongitudinalTemporalInformationModified, removeLongitudinalTemporalInformationModified

Methods inherited from interface org.dcm4che.typeddicom.dataelements.MACParametersSequence.Holder

containsMACParametersSequence, ensureMACParametersSequence, ensureMACParametersSequence, getMACParametersSequence, newMACParametersSequence, removeMACParametersSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.Manufacturer.Holder

containsManufacturer, getManufacturer, removeManufacturer

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ManufacturerDeviceClassUID.Holder

containsManufacturerDeviceClassUID, getManufacturerDeviceClassUID, removeManufacturerDeviceClassUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ManufacturerModelName.Holder

containsManufacturerModelName, getManufacturerModelName, removeManufacturerModelName

Methods inherited from interface org.dcm4che.typeddicom.dataelements.MappingResourceIdentificationSequence.Holder

containsMappingResourceIdentificationSequence, ensureMappingResourceIdentificationSequence, ensureMappingResourceIdentificationSequence, getMappingResourceIdentificationSequence, newMappingResourceIdentificationSequence, removeMappingResourceIdentificationSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.NumberOfStudyRecordsInInstance.Holder

containsNumberOfStudyRecordsInInstance, getNumberOfStudyRecordsInInstance, removeNumberOfStudyRecordsInInstance

Methods inherited from interface org.dcm4che.typeddicom.dataelements.OriginalAttributesSequence.Holder

containsOriginalAttributesSequence, ensureOriginalAttributesSequence, ensureOriginalAttributesSequence, getOriginalAttributesSequence, newOriginalAttributesSequence, removeOriginalAttributesSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.OriginalSpecializedSOPClassUID.Holder

containsOriginalSpecializedSOPClassUID, getOriginalSpecializedSOPClassUID, removeOriginalSpecializedSOPClassUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.PixelPaddingValueAsSS.Holder

containsPixelPaddingValueAsSS, getPixelPaddingValueAsSS, removePixelPaddingValueAsSS

Methods inherited from interface org.dcm4che.typeddicom.dataelements.PixelPaddingValueAsUS.Holder

containsPixelPaddingValueAsUS, getPixelPaddingValueAsUS, removePixelPaddingValueAsUS

Methods inherited from interface org.dcm4che.typeddicom.dataelements.PrivateDataElementCharacteristicsSequence.Holder

containsPrivateDataElementCharacteristicsSequence, ensurePrivateDataElementCharacteristicsSequence, ensurePrivateDataElementCharacteristicsSequence, getPrivateDataElementCharacteristicsSequence, newPrivateDataElementCharacteristicsSequence, removePrivateDataElementCharacteristicsSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.QueryRetrieveView.Holder

containsQueryRetrieveView, getQueryRetrieveView, removeQueryRetrieveView

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ReferencedDefinedProtocolSequence.Holder

containsReferencedDefinedProtocolSequence, ensureReferencedDefinedProtocolSequence, ensureReferencedDefinedProtocolSequence, getReferencedDefinedProtocolSequence, newReferencedDefinedProtocolSequence, removeReferencedDefinedProtocolSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ReferencedPerformedProtocolSequence.Holder

containsReferencedPerformedProtocolSequence, ensureReferencedPerformedProtocolSequence, ensureReferencedPerformedProtocolSequence, getReferencedPerformedProtocolSequence, newReferencedPerformedProtocolSequence, removeReferencedPerformedProtocolSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.RelatedGeneralSOPClassUID.Holder

containsRelatedGeneralSOPClassUID, getRelatedGeneralSOPClassUID, removeRelatedGeneralSOPClassUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ScopeOfInventorySequence.Holder

containsScopeOfInventorySequence, ensureScopeOfInventorySequence, ensureScopeOfInventorySequence, getScopeOfInventorySequence, newScopeOfInventorySequence, removeScopeOfInventorySequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SoftwareVersions.Holder

containsSoftwareVersions, getSoftwareVersions, removeSoftwareVersions

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SOPAuthorizationComment.Holder

containsSOPAuthorizationComment, getSOPAuthorizationComment, removeSOPAuthorizationComment

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SOPAuthorizationDateTime.Holder

containsSOPAuthorizationDateTime, getSOPAuthorizationDateTime, removeSOPAuthorizationDateTime

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SOPClassUID.Holder

containsSOPClassUID, getSOPClassUID, removeSOPClassUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SOPInstanceStatus.Holder

containsSOPInstanceStatus, getSOPInstanceStatus, removeSOPInstanceStatus

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SOPInstanceUID.Holder

containsSOPInstanceUID, getSOPInstanceUID, removeSOPInstanceUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SpatialResolution.Holder

containsSpatialResolution, getSpatialResolution, removeSpatialResolution

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SpecificCharacterSet.Holder

containsSpecificCharacterSet, getSpecificCharacterSet, removeSpecificCharacterSet

Methods inherited from interface org.dcm4che.typeddicom.dataelements.StationName.Holder

containsStationName, getStationName, removeStationName

Methods inherited from interface org.dcm4che.typeddicom.dataelements.StudyAccessEndPointsSequence.Holder

containsStudyAccessEndPointsSequence, ensureStudyAccessEndPointsSequence, ensureStudyAccessEndPointsSequence, getStudyAccessEndPointsSequence, newStudyAccessEndPointsSequence, removeStudyAccessEndPointsSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.TimeOfLastCalibration.Holder

containsTimeOfLastCalibration, getTimeOfLastCalibration, removeTimeOfLastCalibration

Methods inherited from interface org.dcm4che.typeddicom.dataelements.TimezoneOffsetFromUTC.Holder

containsTimezoneOffsetFromUTC, getTimezoneOffsetFromUTC, removeTimezoneOffsetFromUTC

Methods inherited from interface org.dcm4che.typeddicom.dataelements.TotalNumberOfStudyRecords.Holder

containsTotalNumberOfStudyRecords, getTotalNumberOfStudyRecords, removeTotalNumberOfStudyRecords

Methods inherited from interface org.dcm4che.typeddicom.dataelements.TransactionUID.Holder

containsTransactionUID, getTransactionUID, removeTransactionUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.UDISequence.Holder

containsUDISequence, ensureUDISequence, ensureUDISequence, getUDISequence, newUDISequence, removeUDISequence

Field Detail

STANDARD_SOP_CLASSES

public static final java.util.Set<org.dcm4che.typeddicom.SOPClass> STANDARD_SOP_CLASSES

Constructor Detail

InventoryIOD

public InventoryIOD(org.dcm4che3.data.Attributes attributes)

InventoryIOD

public InventoryIOD()

Method Detail

builder

public static InventoryIOD.Builder builder()

Returns:

a InventoryIOD.Builder to create Inventory IODs with a fluent API.

builder

public static InventoryIOD.Builder builder(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - the Attributes to be wrapped by the InventoryIOD.Builder.

Returns:

a InventoryIOD.Builder to create Inventory IOD Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getStandardSOPClasses

public java.util.Set<org.dcm4che.typeddicom.SOPClass> getStandardSOPClasses()

Specified by:

getStandardSOPClasses in class org.dcm4che.typeddicom.AbstractInformationObjectDefinition