Data Model Libraries
    Preparing search index...

    Class TriggerDefinition

    TriggerDefinition Class

    TriggerDefinition Type: A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.

    FHIR Specification

    • Short: Defines an expected trigger for a module
    • Definition: A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
    • Comment: If an event is a named-event, it means the event is completely pre-coordinated, and no other information can be specified for the event. If the event is one of the data- events, the data and condition elements specify the triggering criteria. The data element specifies the structured component, and the condition element provides additional optional refinement of that structured component. If the event is periodic, the timing element defines when the event is triggered. For both data- and periodic events, a name can be provided as a shorthand for the formal semantics provided by the other elements.
    • FHIR Version: 5.0.0

    FHIR TriggerDefinition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    triggerTypeEnum type_ name? code? subscriptionTopic? timing? data? condition?

    Methods

    parse getTypeEnumType setTypeEnumType hasTypeEnumType getTypeElement setTypeElement hasTypeElement getType setType hasType getNameElement setNameElement hasNameElement getName setName hasName getCode setCode hasCode getSubscriptionTopicElement setSubscriptionTopicElement hasSubscriptionTopicElement getSubscriptionTopic setSubscriptionTopic hasSubscriptionTopic getTiming setTiming hasTiming getTimingTiming hasTimingTiming getTimingReference hasTimingReference getTimingDateType hasTimingDateType getTimingDateTimeType hasTimingDateTimeType getData setData addData hasData getCondition setCondition hasCondition fhirType isEmpty isRequiredFieldsEmpty copy isComplexDataType dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initData

    Constructors

    Properties

    triggerTypeEnum: TriggerTypeEnum

    FHIR CodeSystem: TriggerType

    TriggerTypeEnum

    Privatetype_

    type_: null | EnumCodeType

    TriggerDefinition.type Element

    FHIR Specification

    • Short: named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
    • Definition: The type of triggering event.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: TriggerTypeEnum

    name?: StringType

    TriggerDefinition.name Element

    FHIR Specification

    • Short: Name or URI that identifies the event
    • Definition: A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.
    • Comment: An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    code?: CodeableConcept

    TriggerDefinition.code Element

    FHIR Specification

    • Short: Coded definition of the event
    • Definition: A code that identifies the event.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subscriptionTopic?: CanonicalType

    TriggerDefinition.subscriptionTopic Element

    FHIR Specification

    • Short: What event
    • Definition: A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    timing?: IDataType

    TriggerDefinition.timing[x] Element

    @ChoiceDataTypesMeta('TriggerDefinition.timing[x]', ['Timing','Reference','date','dateTime',]

    FHIR Specification

    • Short: Timing of the event
    • Definition: The timing of the event (if this is a periodic trigger).
    • FHIR Types: 'Timing', 'Reference', 'date', 'dateTime',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    data?: DataRequirement[]

    TriggerDefinition.data Element

    FHIR Specification

    • Short: Triggering data of the event (multiple = 'and')
    • Definition: The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
    • Comment: This element shall be present for any data type trigger.
    • FHIR Type: DataRequirement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    condition?: Expression

    TriggerDefinition.condition Element

    FHIR Specification

    • Short: Whether the event triggers (boolean expression)
    • Definition: A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.
    • Comment: This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.
    • Requirements: Need to be able to formally describe the triggering criteria.
    • FHIR Type: Expression
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided TriggerDefinition JSON to instantiate the TriggerDefinition data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR TriggerDefinition

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to TriggerDefinition

      Returns undefined | TriggerDefinition

      TriggerDefinition data model or undefined for TriggerDefinition

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetTypeEnumTypesetTypeEnumTypehasTypeEnumTypegetTypeElementsetTypeElementhasTypeElementgetTypesetTypehasTypegetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetCodesetCodehasCodegetSubscriptionTopicElementsetSubscriptionTopicElementhasSubscriptionTopicElementgetSubscriptionTopicsetSubscriptionTopichasSubscriptionTopicgetTimingsetTiminghasTiminggetTimingTiminghasTimingTiminggetTimingReferencehasTimingReferencegetTimingDateTypehasTimingDateTypegetTimingDateTimeTypehasTimingDateTimeTypegetDatasetDataaddDatahasDatagetConditionsetConditionhasConditionfhirTypeisEmptyisRequiredFieldsEmptycopyisComplexDataTypedataTypeNametoJSONisDataTypegetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisResourceisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitData