Data Model Libraries
    Preparing search index...

    SubscriptionChannelComponent Class

    FHIR Specification

    • Short: The channel on which to report matches to the criteria
    • Definition: Details where to send notifications when resources are received that meet the criteria.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    subscriptionChannelTypeEnum: SubscriptionChannelTypeEnum

    FHIR CodeSystem: SubscriptionChannelType

    type_: null | EnumCodeType

    Subscription.channel.type Element

    FHIR Specification

    • Short: rest-hook | websocket | email | sms | message
    • Definition: The type of channel to send notifications on.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: SubscriptionChannelTypeEnum

    endpoint?: UrlType

    Subscription.channel.endpoint Element

    FHIR Specification

    • Short: Where the channel points to
    • Definition: The url that describes the actual end-point to send messages to.
    • Comment: For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).
    • FHIR Type: url
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    payload?: CodeType

    Subscription.channel.payload Element

    FHIR Specification

    • Short: MIME type to send, or omit for no payload
    • Definition: The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.
    • Comment: Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    header?: StringType[]

    Subscription.channel.header Element

    FHIR Specification

    • Short: Usage depends on the channel type
    • Definition: Additional headers / information to send as part of the notification.
    • Comment: Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubscriptionChannelComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubscriptionChannelComponent

      SubscriptionChannelComponent data model or undefined for SubscriptionChannelComponent

      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