Skip to main content


persistent class HS.Message.AggregationNotification extends HS.Util.EnsRequest

SQL Table Name: HS_Message.AggregationNotification

Property Inventory

Method Inventory


property AGKey as %String;
the aggregation key for all of the streamlets in this patient session
Property methods: AGKeyDisplayToLogical(), AGKeyGet(), AGKeyGetStored(), AGKeyIsValid(), AGKeyLogicalToDisplay(), AGKeyLogicalToOdbc(), AGKeyNormalize(), AGKeySet()
property ActionCount as %Integer;
Records the counter of how many actions have been stored in the notification global.
Property methods: ActionCountDisplayToLogical(), ActionCountGet(), ActionCountGetStored(), ActionCountIsValid(), ActionCountLogicalToDisplay(), ActionCountNormalize(), ActionCountSet(), ActionCountXSDToLogical()
property ErrStatus as %Status;
for an abort notification, the status of the error that caused the problem
Property methods: ErrStatusGet(), ErrStatusGetStored(), ErrStatusIsValid(), ErrStatusLogicalToOdbc(), ErrStatusLogicalToXSD(), ErrStatusSet(), ErrStatusXSDToLogical()
property Token as %String;
if we're using the Trak Viewer, this is the Token that gets passed into it to construct a pseudo patient ID for this patient session
Property methods: TokenDisplayToLogical(), TokenGet(), TokenGetStored(), TokenIsValid(), TokenLogicalToDisplay(), TokenLogicalToOdbc(), TokenNormalize(), TokenSet()
property Type as %String (VALUELIST = ",Initialize,WaitTimeout,FetchNotification,FetchComplete,Abort,Purge");
Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()


method GetEnd() as %Integer
API Method
method GetInfo(pSequence, Output pAction, Output pStreamletId, Output pStreamletType, Output pReplacedId) as %Status
API Method
method GetSourceMRN(pSequence, Output pSourceMRN) as %Status
API Method
classmethod LoadSDAObject(pStreamletId, Output pSDA) as %Status
API Method - Return the SDA for a specified streamlet ID. Like the one in HS.SDA3.Container, but fails without error if streamlet isn't there (probably because replaced)
method Lock()
API Method
method UnLock()
API Method

Inherited Members

Inherited Properties

Inherited Methods


Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)


Storage Model: Storage (HS.Util.EnsRequest)


Storage Model: Storage (HS.Message.AggregationNotification)

FeedbackOpens in a new tab