Data Model Libraries
    Preparing search index...

    SubscriptionStatus Class

    The SubscriptionStatus resource describes the state of a Subscription during notifications.

    FHIR Specification

    • Short: Status information about a Subscription provided during event notification
    • Definition: The SubscriptionStatus resource describes the state of a Subscription during notifications.
    • FHIR Version: 4.3.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getTypeEnumType setTypeEnumType hasTypeEnumType getTypeElement setTypeElement hasTypeElement getType setType hasType getEventsSinceSubscriptionStartElement setEventsSinceSubscriptionStartElement hasEventsSinceSubscriptionStartElement getEventsSinceSubscriptionStart setEventsSinceSubscriptionStart hasEventsSinceSubscriptionStart getNotificationEvent setNotificationEvent addNotificationEvent hasNotificationEvent getSubscription setSubscription hasSubscription getTopicElement setTopicElement hasTopicElement getTopic setTopic hasTopic getError setError addError hasError fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initNotificationEvent initError

    Constructors

    Properties

    subscriptionStatusEnum: SubscriptionStatusEnum

    FHIR CodeSystem: SubscriptionStatus

    status?: EnumCodeType

    SubscriptionStatus.status Element

    FHIR Specification

    • Short: requested | active | error | off | entered-in-error
    • Definition: The status of the subscription, which marks the server state for managing the subscription.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: SubscriptionStatusEnum

    subscriptionNotificationTypeEnum: SubscriptionNotificationTypeEnum

    FHIR CodeSystem: SubscriptionNotificationType

    type_: null | EnumCodeType

    SubscriptionStatus.type Element

    FHIR Specification

    • Short: handshake | heartbeat | event-notification | query-status | query-event
    • Definition: The type of event being conveyed with this notificaiton.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: Not known why this is labelled a modifier
    • isSummary: true

    CodeSystem Enumeration: SubscriptionNotificationTypeEnum

    eventsSinceSubscriptionStart?: StringType

    SubscriptionStatus.eventsSinceSubscriptionStart Element

    FHIR Specification

    • Short: Events since the Subscription was created
    • Definition: The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubscriptionStatus.notificationEvent Element

    FHIR Specification

    • Short: Detailed information about any events relevant to this notification
    • Definition: Detailed information about events relevant to this subscription notification.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    subscription: null | Reference

    SubscriptionStatus.subscription Element

    FHIR Specification

    • Short: Reference to the Subscription responsible for this notification
    • Definition: The reference to the Subscription which generated this notification.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    SubscriptionStatus.topic Element

    FHIR Specification

    • Short: Reference to the SubscriptionTopic this notification relates to
    • Definition: The reference to the SubscriptionTopic for the Subscription which generated this notification.
    • Comment: This value SHOULD NOT be present when using empty payloads, MAY be present when using id-only payloads, and SHOULD be present when using full-resource payloads.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    error?: CodeableConcept[]

    SubscriptionStatus.error Element

    FHIR Specification

    • Short: List of errors on the subscription
    • Definition: A record of errors that occurred when the server processed a notification.
    • Comment: Recommended practice: clear errors when status is updated.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubscriptionStatus

      • OptionaloptSourceField: string

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

      Returns undefined | SubscriptionStatus

      SubscriptionStatus data model or undefined for SubscriptionStatus

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

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