Data Model Libraries
    Preparing search index...

    Class SubscriptionStatusNotificationEventComponent

    SubscriptionStatusNotificationEventComponent Class

    FHIR Specification

    • Short: Detailed information about any events relevant to this notification
    • Definition: Detailed information about events relevant to this subscription notification.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    eventNumber: null | Integer64Type

    SubscriptionStatus.notificationEvent.eventNumber Element

    FHIR Specification

    • Short: Sequencing index of this event
    • Definition: Either the sequential number of this event in this subscription context or a relative event number for this notification.
    • Comment: In subscriptions where delivery of notifications IS NOT guaranteed (e.g., REST-Hook), this number is a unique and monotonically-increasing event number for a subscription. In channels where delivery of notifications IS guaranteed, this number is a relative index for the events present in the notification (e.g., 1, 2, etc.).
    • FHIR Type: integer64
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    timestamp?: InstantType

    SubscriptionStatus.notificationEvent.timestamp Element

    FHIR Specification

    • Short: The instant this event occurred
    • Definition: The actual time this event occurred on the server.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    focus?: Reference

    SubscriptionStatus.notificationEvent.focus Element

    FHIR Specification

    • Short: Reference to the primary resource or information of this event
    • Definition: The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    additionalContext?: Reference[]

    SubscriptionStatus.notificationEvent.additionalContext Element

    FHIR Specification

    • Short: References related to the focus resource and/or context of this event
    • Definition: Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubscriptionStatusNotificationEventComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubscriptionStatusNotificationEventComponent

      SubscriptionStatusNotificationEventComponent data model or undefined for SubscriptionStatusNotificationEventComponent

      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