Skip to main content


class HS.FHIR.DTL.vSTU3.Model.Datatype.TriggerDefinition extends HS.FHIR.DTL.vSTU3.Model.Base.Element

The TriggerDefinition structure defines when a knowledge artifact is expected to be evaluated. The structure can represent three main kinds of triggering events: Named Event, Scheduled Event, Data Event. A named event is an event identified by the implementation environment. This allows any event generated within the implementation environment to be used as a trigger, but it requires pre-coordination of the names involved with the consuming environments. A scheduled event occurs on a fixed or periodic schedule. And finally, a data event occurs in response to some data-related event in the integrated environment such as a record being added or updated. The data-of-interest for a data event is described using a DataRequirement. This allows for systems to automatically invoke based on data activity occurring within the system.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = TriggerDefinition;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = TriggerDefinition;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property eventData as HS.FHIR.DTL.vSTU3.Model.Datatype.DataRequirement (XMLNAME = "eventData", XMLPROJECTION = "ELEMENT");

Triggering data of the event.

Property methods: eventDataGet(), eventDataGetSwizzled(), eventDataIsValid(), eventDataNewObject(), eventDataSet()
property eventName as %String (MAXLEN = 1000000, XMLNAME = "eventName", XMLPROJECTION = "ATTRIBUTE");

Triggering event name.

Property methods: eventNameDisplayToLogical(), eventNameGet(), eventNameIsValid(), eventNameLogicalToDisplay(), eventNameLogicalToOdbc(), eventNameNormalize(), eventNameSet()
property eventTimingDate as %String (MAXLEN = 1000000, XMLNAME = "eventTimingDate", XMLPROJECTION = "ATTRIBUTE");

Timing of the event.

Property methods: eventTimingDateDisplayToLogical(), eventTimingDateGet(), eventTimingDateIsValid(), eventTimingDateLogicalToDisplay(), eventTimingDateLogicalToOdbc(), eventTimingDateNormalize(), eventTimingDateSet()
property eventTimingDateTime as %String (MAXLEN = 1000000, XMLNAME = "eventTimingDateTime", XMLPROJECTION = "ATTRIBUTE");

Timing of the event.

Property methods: eventTimingDateTimeDisplayToLogical(), eventTimingDateTimeGet(), eventTimingDateTimeIsValid(), eventTimingDateTimeLogicalToDisplay(), eventTimingDateTimeLogicalToOdbc(), eventTimingDateTimeNormalize(), eventTimingDateTimeSet()
property eventTimingReference as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "eventTimingReference", XMLPROJECTION = "ELEMENT");

Timing of the event.


Property methods: eventTimingReferenceGet(), eventTimingReferenceGetSwizzled(), eventTimingReferenceIsValid(), eventTimingReferenceNewObject(), eventTimingReferenceSet()
property eventTimingTiming as HS.FHIR.DTL.vSTU3.Model.Datatype.Timing (XMLNAME = "eventTimingTiming", XMLPROJECTION = "ELEMENT");

Timing of the event.

Property methods: eventTimingTimingGet(), eventTimingTimingGetSwizzled(), eventTimingTimingIsValid(), eventTimingTimingNewObject(), eventTimingTimingSet()
property type as %String (MAXLEN = 1000000, XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE") [ Required ];

named-event | periodic | data-added | data-modified | data-removed | data-accessed | data-access-ended

trigger-type is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend trigger-type and you may NOT use codes from other ValueSets.

Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab