description: The status of an AidboxTopicDestination during notifications.
package_name: io.health-samurai.core.r5
derivation: specialization
name: AidboxSubscriptionStatus
type: AidboxSubscriptionStatus
elements:
  type:
    constraint:
      enum-1670: {human: 'type shall be one of: handshake, heartbeat, event-notification, query-status, query-event', severity: error, expression: '%context.subsetOf(''handshake'' | ''heartbeat'' | ''event-notification'' | ''query-status'' | ''query-event'')'}
    isModifier: true
    short: handshake | heartbeat | event-notification | query-status | query-event.
    type: string
    isModifierReason: Not known why this is labelled a modifier
    isSummary: true
    index: 0
  topic-destination:
    type: Reference
    short: Reference to the AidboxTopicDestination responsible for this notification.
    isSummary: true
    refers: ['http://health-samurai.io/fhir/core/StructureDefinition/AidboxTopicDestination']
    index: 1
  status:
    type: code
    short: requested | active | error | off | entered-in-error.
    isSummary: true
    constraint:
      enum-1671: {human: 'status shall be one of: requested, active, error, off, entered-in-error', severity: error, expression: '%context.subsetOf(''requested'' | ''active'' | ''error'' | ''off'' | ''entered-in-error'')'}
    index: 2
  topic: {type: canonical, short: Reference to the AidboxSubscriptionTopic this notification relates to., isSummary: true, index: 3}
  error: {type: CodeableConcept, short: List of errors on the subscription., isSummary: true, array: true, index: 4}
  eventsSinceSubscriptionStart: {type: decimal, short: Events since the AidboxTopicDestination was created., isSummary: true, index: 5}
  notificationEvent:
    type: BackboneElement
    short: Detailed information about any events relevant to this notification.
    array: true
    index: 6
    elements:
      eventNumber: {type: decimal, short: Sequencing index of this event., index: 7}
      timestamp: {type: instant, short: The instant this event occurred., index: 8}
      focus:
        type: Reference
        short: Reference to the primary resource or information of this event.
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        index: 9
      additionalContext:
        type: Reference
        short: References related to the focus resource and/or context of this event.
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        array: true
        index: 10
    required: [eventNumber]
package_version: 0.2601.0
class: resource
kind: resource
url: http://health-samurai.io/fhir/core/StructureDefinition/AidboxSubscriptionStatus
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 0.2601.0
required: [type, topic-destination]