Data Model Libraries
    Preparing search index...

    Class SubscriptionTopicResourceTriggerComponent

    SubscriptionTopicResourceTriggerComponent Class

    FHIR Specification

    • Short: Definition of a resource-based trigger for the subscription topic
    • Definition: A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    description?: MarkdownType

    SubscriptionTopic.resourceTrigger.description Element

    FHIR Specification

    • Short: Text representation of the resource trigger
    • Definition: The human readable description of this resource trigger for the SubscriptionTopic - for example, "An Encounter enters the 'in-progress' state".
    • Comment: Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    resource: null | UriType

    SubscriptionTopic.resourceTrigger.resource Element

    FHIR Specification

    restfulInteractionEnum: RestfulInteractionEnum

    FHIR CodeSystem: RestfulInteraction

    supportedInteraction?: EnumCodeType[]

    SubscriptionTopic.resourceTrigger.supportedInteraction Element

    FHIR Specification

    • Short: create | update | delete
    • Definition: The FHIR RESTful interaction which can be used to trigger a notification for the SubscriptionTopic. Multiple values are considered OR joined (e.g., CREATE or UPDATE). If not present, all supported interactions are assumed.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: RestfulInteractionEnum

    SubscriptionTopic.resourceTrigger.queryCriteria Element

    FHIR Specification

    • Short: Query based trigger rule
    • Definition: The FHIR query based rules that the server should use to determine when to trigger a notification for this subscription topic.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    fhirPathCriteria?: StringType

    SubscriptionTopic.resourceTrigger.fhirPathCriteria Element

    FHIR Specification

    • Short: FHIRPath based trigger rule
    • Definition: The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic.
    • Comment: FHIRPath expression with %previous and %current vars.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubscriptionTopicResourceTriggerComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubscriptionTopicResourceTriggerComponent

      SubscriptionTopicResourceTriggerComponent data model or undefined for SubscriptionTopicResourceTriggerComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • 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

    • 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 complex or primitive datatype; false otherwise