EnsLib.DICOM.Document

persistent class EnsLib.DICOM.Document extends %Library.Persistent, Ens.Util.MessageBodyMethods, EnsLib.DICOM.Util.ULP

SQL Table Name: EnsLib_DICOM.Document

This class represents a DICOM Message. The message consists of two logical sub-structures, the CommandSet and the DataSet. The command set contains information about the message ( message meta-data ) and the data set contains the actual payload

Property Inventory

Method Inventory

Parameters

parameter DOMAIN = EnsDICOM;
Domain for Error Messages

Properties

property CommandSet as EnsLib.DICOM.CommandSet;
This holds the command-set, a collection of DICOM tags which contains the messages meta-data
Property methods: CommandSetGet(), CommandSetGetObject(), CommandSetGetObjectId(), CommandSetGetStored(), CommandSetGetSwizzled(), CommandSetIsEmpty(), CommandSetIsValid(), CommandSetNewObject(), CommandSetSet(), CommandSetSetObject(), CommandSetSetObjectId(), CommandSetUnSwizzle()
property DestinationAET as %String;
This holds the AET of the Our Application ( will only be automatically set for TCP inbound documents)
Property methods: DestinationAETDisplayToLogical(), DestinationAETGet(), DestinationAETGetStored(), DestinationAETIsValid(), DestinationAETLogicalToDisplay(), DestinationAETLogicalToOdbc(), DestinationAETNormalize(), DestinationAETSet()
property OriginalSourceAET as %String;
This holds the AET of the Originating Application prior to any transformation. ( will only be automatically set for TCP inbound documents)
Property methods: OriginalSourceAETDisplayToLogical(), OriginalSourceAETGet(), OriginalSourceAETGetStored(), OriginalSourceAETIsValid(), OriginalSourceAETLogicalToDisplay(), OriginalSourceAETLogicalToOdbc(), OriginalSourceAETNormalize(), OriginalSourceAETSet()
property SourceAET as %String;
This holds the AET of the Originating Application ( will only be automatically set for TCP inbound documents)
Property methods: SourceAETDisplayToLogical(), SourceAETGet(), SourceAETGetStored(), SourceAETIsValid(), SourceAETLogicalToDisplay(), SourceAETLogicalToOdbc(), SourceAETNormalize(), SourceAETSet()
property SourceIPAddress as %String;
This holds the IP Address of the Source ( will only be automatically set for TCP inbound documents)
Property methods: SourceIPAddressDisplayToLogical(), SourceIPAddressGet(), SourceIPAddressGetStored(), SourceIPAddressIsValid(), SourceIPAddressLogicalToDisplay(), SourceIPAddressLogicalToOdbc(), SourceIPAddressNormalize(), SourceIPAddressSet()

Methods

classmethod %OnDelete(oid As %ObjectIdentity) as %Status [ Language = objectscript ]
This callback method is invoked by the %Delete() method to provide notification that the object specified by oid is being deleted.

If this method returns an error then the object will not be deleted. [Previously private]

method %ShowContents(pZenOutput As %Boolean = 0) [ Language = objectscript ]
From 'Ens.Util.MessageBodyMethods'
classmethod CreateFromDicomFileStream(pFileBinaryStream As %FileBinaryStream, Output pDocument As EnsLib.DICOM.Document) [ Language = objectscript ]
Use this method to create a dicom document from a file binary stream containing DICOM data in DICOM format
method DataSetGet() [ Language = objectscript ]
Accessor for DataSet
method GetNextIndex(pPropertyPath As %String, pIndex As %String = "", Output pStatus As %Status = $$$OK) as %String [ Language = objectscript ]
This VDOC Compliant method gets the next index for a subscripted VDOC reference
method GetValueAt(pPropertyPath As %String, pFormat As %String, pStatus As %Status, pDummy) as %String [ Language = objectscript ]
This VDOC Compliant method gets the value of the given property.
This is implemented by the document class.
pPropertyPath contains the property name.
For this class it is only applicable to the CommandSet and DataSet properties
pFormat can be defined or not. If defined it can take the values "",0 or 1.
pFormat of "" is the same as not defined.
pFormat of 0 means return an empty string and not an error if the value does not exist.
pFormat of 1 means force an error if a value does not exist.
method HasDataGet() as %Boolean [ Language = objectscript ]
Accessor for HasData
method InitializeCommandSet(pStream) as %Status [ Language = objectscript ]
Initialize the command set from an external stream
method SetValueAt(pValue As %String, pPropertyPath As %String, pAction As %String = "set", pKey As %String = "") as %Status [ Language = objectscript ]
This VDOC Compliant method sets the value of the given property.
This is implemented by the document class.
pPropertyPath contains the property name.
pAction contains an action code: "set", etc..
pKey contains an optional key value.
For this class it is only applicable to the CommandSet and DataSet properties

Indexes

index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (EnsLib.DICOM.Document)

^EnsLib.DICOM.DocumentD(ID)
=
%%CLASSNAME
CommandSet
MutableDataSet
FixedDataSet
Modified
SourceAET
SourceIPAddress
DocType
TimeCreated
Source
IsMutable
OriginalDocId
DestinationAET
OriginalSourceAET
Feedback