Data Model Libraries
    Preparing search index...

    Class SubscriptionTopicCanFilterByComponent

    SubscriptionTopicCanFilterByComponent Class

    FHIR Specification

    • Short: Properties by which a Subscription can filter notifications from the SubscriptionTopic
    • Definition: List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    description?: MarkdownType

    SubscriptionTopic.canFilterBy.description Element

    FHIR Specification

    • Short: Description of this filter parameter
    • Definition: Description of how this filtering parameter is intended to be used.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    resource?: UriType

    SubscriptionTopic.canFilterBy.resource Element

    FHIR Specification

    • Short: URL of the triggering Resource that this filter applies to
    • Definition: URL of the Resource that is the type used in this filter. This is the "focus" of the topic (or one of them if there are more than one). It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present.
    • Comment: URL of the Resource that is the type used in this filter. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see ElementDefinition.type.code.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    filterParameter: null | StringType

    SubscriptionTopic.canFilterBy.filterParameter Element

    FHIR Specification

    • Short: Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
    • Definition: Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or topic-defined parameter (like "hub.event") which is a label for the filter.
    • Comment: Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    filterDefinition?: UriType

    SubscriptionTopic.canFilterBy.filterDefinition Element

    FHIR Specification

    subscriptionSearchModifierEnum: SubscriptionSearchModifierEnum

    FHIR CodeSystem: SubscriptionSearchModifier

    modifier?: EnumCodeType[]

    SubscriptionTopic.canFilterBy.modifier Element

    FHIR Specification

    • Short: = | eq | ne | gt | lt | ge | le | sa | eb | ap | above | below | in | not-in | of-type
    • Definition: Allowable operators to apply when determining matches (Search Modifiers). If the filterParameter is a SearchParameter, this list of modifiers SHALL be a strict subset of the modifiers defined on that SearchParameter.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: SubscriptionSearchModifierEnum

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubscriptionTopicCanFilterByComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubscriptionTopicCanFilterByComponent

      SubscriptionTopicCanFilterByComponent data model or undefined for SubscriptionTopicCanFilterByComponent

      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