Data Model Libraries
    Preparing search index...

    SubscriptionFilterByComponent Class

    FHIR Specification

    • Short: Criteria for narrowing the subscription topic stream
    • Definition: The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions applicable to that resource are met; otherwise it returns false (i.e., logical AND).

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    resourceType?: UriType

    Subscription.filterBy.resourceType Element

    FHIR Specification

    • Short: Allowed Resource (reference to definition) for this Subscription filter
    • Definition: A resource listed in the SubscriptionTopic this Subscription references (SubscriptionTopic.canFilterBy.resource). This element can be used to differentiate filters for topics that include more than one resource type.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    filterParameter: null | StringType

    Subscription.filterBy.filterParameter Element

    FHIR Specification

    • Short: Filter label defined in SubscriptionTopic
    • Definition: The filter as defined in the SubscriptionTopic.canFilterBy.filterParameter element.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    searchComparatorEnum: SearchComparatorEnum

    FHIR CodeSystem: SearchComparator

    comparator?: EnumCodeType

    Subscription.filterBy.comparator Element

    FHIR Specification

    • Short: eq | ne | gt | lt | ge | le | sa | eb | ap
    • Definition: Comparator applied to this filter parameter.
    • Comment: Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: SearchComparatorEnum

    searchModifierCodeEnum: SearchModifierCodeEnum

    FHIR CodeSystem: SearchModifierCode

    modifier?: EnumCodeType

    Subscription.filterBy.modifier Element

    FHIR Specification

    • Short: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
    • Definition: Modifier applied to this filter parameter.
    • Comment: Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: SearchModifierCodeEnum

    value: null | StringType

    Subscription.filterBy.value Element

    FHIR Specification

    • Short: Literal value or resource path
    • Definition: The literal value or resource path as is legal in search - for example, Patient/123 or le1950.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubscriptionFilterByComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubscriptionFilterByComponent

      SubscriptionFilterByComponent data model or undefined for SubscriptionFilterByComponent

      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