Data Model Libraries
    Preparing search index...

    Class SubscriptionTopicResourceTriggerQueryCriteriaComponent

    SubscriptionTopicResourceTriggerQueryCriteriaComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    previous?: StringType

    SubscriptionTopic.resourceTrigger.queryCriteria.previous Element

    FHIR Specification

    • Short: Rule applied to previous resource state
    • Definition: The FHIR query based rules are applied to the previous resource state (e.g., state before an update).
    • Comment: The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/".
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subscriptiontopicCrBehaviorEnum: SubscriptiontopicCrBehaviorEnum

    FHIR CodeSystem: SubscriptiontopicCrBehavior

    resultForCreate?: EnumCodeType

    SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate Element

    FHIR Specification

    • Short: test-passes | test-fails
    • Definition: For "create" interactions, should the "previous" criteria count as an automatic pass or an automatic fail.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: SubscriptiontopicCrBehaviorEnum

    current?: StringType

    SubscriptionTopic.resourceTrigger.queryCriteria.current Element

    FHIR Specification

    • Short: Rule applied to current resource state
    • Definition: The FHIR query based rules are applied to the current resource state (e.g., state after an update).
    • Comment: The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/".
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    resultForDelete?: EnumCodeType

    SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete Element

    FHIR Specification

    • Short: test-passes | test-fails
    • Definition: For "delete" interactions, should the "current" criteria count as an automatic pass or an automatic fail.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: SubscriptiontopicCrBehaviorEnum

    requireBoth?: BooleanType

    SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth Element

    FHIR Specification

    • Short: Both must be true flag
    • Definition: If set to true, both current and previous criteria must evaluate true to trigger a notification for this topic. Otherwise a notification for this topic will be triggered if either one evaluates to true.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubscriptionTopicResourceTriggerQueryCriteriaComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubscriptionTopicResourceTriggerQueryCriteriaComponent

      SubscriptionTopicResourceTriggerQueryCriteriaComponent data model or undefined for SubscriptionTopicResourceTriggerQueryCriteriaComponent

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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