rtlsSubscriptionStatus
type: StructureDefinition
node role: treeRoot
id:
  v: rtlsSubscriptionStatus
text:
  status:
    v: extensions
  div: Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> SubscriptionStatus 0..* SubscriptionStatus Status information about a Subscription provided during event notification status S 0..1 code requested | active | error | off | entered-in-error type S 1..1 code Set to "event-notification" notificationEvent timestamp S 1..1 instant The instant this event occurred focus S 0..1 Reference(RTLS Tag Device Profile) Reference to the primary resource or information of this event subscription S 1..1 Reference(Subscription) Reference to the rtlsSubscription resource responsible for this notification (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscription). topic S 0..1 canonical(SubscriptionTopic) Reference to the rtlsSbuscriptionTopic resource this notification relates to (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic). <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: informative
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
      value:
        v: http://hl7.org/fhir/uv/rtls/ImplementationGuide/hl7.fhir.uv.rtls
        link: http://hl7.org/fhir/uv/rtls/ImplementationGuide/hl7.fhir.uv.rtls
url:
  v: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionStatus
version:
  v: 1.0.0-ballot
name:
  v: RTLSSubscriptionStatus
title:
  v: RTLS Subscription Status Profile
status:
  v: draft
experimental:
  v: true
date:
  v: 2023-05-10T16:46:10+00:00
publisher:
  v: HL7 International - Patient Administration Work Group
contact:
  telecom:
    system:
      v: url
    value:
      v: http://hl7.org/Special/committees/pafm
description:
  v: SubscriptionStatus resource used in RTLS workflows.
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
    code:
      v: 001
purpose:
  v: This profile defines minimum expectations for a subscription status resource used in RTLS workflows.
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
  name:
    v: FiveWs Pattern Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: resource
abstract:
  v: false
type:
  v: SubscriptionStatus
base definition:
  v: http://hl7.org/fhir/StructureDefinition/SubscriptionStatus
  link: http://hl7.org/fhir/StructureDefinition/SubscriptionStatus
derivation:
  v: constraint
snapshot:
  element:
    id:
      v: SubscriptionStatus
    path:
      v: SubscriptionStatus
    short:
      v: Status information about a Subscription provided during event notification
    definition:
      v: The SubscriptionStatus resource describes the state of a Subscription during notifications.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: SubscriptionStatus
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
      expression:
        v: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-5
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a security label
      expression:
        v: contained.meta.security.empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-6
      severity:
        v: warning
      human:
        v: A resource should have narrative for robust management
      expression:
        v: text.`div`.exists()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: sst-1
      severity:
        v: error
      human:
        v: Event notifications must contain events
      expression:
        v: (type = 'event-notification' or type = 'query-event') implies notificationEvent.exists()
      source:
        v: http://hl7.org/fhir/StructureDefinition/SubscriptionStatus
        link: http://hl7.org/fhir/StructureDefinition/SubscriptionStatus
    constraint:
      key:
        v: sst-2
      severity:
        v: error
      human:
        v: Status messages must contain status
      expression:
        v: type = 'query-status' implies status.exists()
      source:
        v: http://hl7.org/fhir/StructureDefinition/SubscriptionStatus
        link: http://hl7.org/fhir/StructureDefinition/SubscriptionStatus
    must support:
      v: false
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: Entity, Role, or Act,N/A
    mapping:
      identity:
        v: w5
      map:
        v: infrastructure.exchange
  element:
    id:
      v: SubscriptionStatus.id

v: true

v: When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

v: SubscriptionStatus.id

v: Logical id of this artifact

v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

v: Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

v: 0

v: 1

path:
  v: Resource.id
min:
  v: 0
max:
  v: 1

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
  value:
    v: id
code:
  v: http://hl7.org/fhirpath/System.String

v: false

v: false

v: true

id:
  v: SubscriptionStatus.meta
path:
  v: SubscriptionStatus.meta
short:
  v: Metadata about the resource
definition:
  v: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: SubscriptionStatus.implicitRules
path:
  v: SubscriptionStatus.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
comment:
  v: Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
is summary:
  v: true

id:
  v: SubscriptionStatus.language
path:
  v: SubscriptionStatus.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: Language
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding
    value:
      v: true
  strength:
    v: required
  description:
    v: IETF language tag for a human language
  value set:
    v: http://hl7.org/fhir/ValueSet/all-languages|5.0.0
    link: 5.0
    link: .0
  additional:
    purpose:
      v: starter
    value set:
      v: http://hl7.org/fhir/ValueSet/languages
      link: http://hl7.org/fhir/ValueSet/languages

id:
  v: SubscriptionStatus.text
path:
  v: SubscriptionStatus.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
comment:
  v: Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
condition:
  v: dom-6
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: SubscriptionStatus.contained
path:
  v: SubscriptionStatus.contained
short:
  v: Contained, inline Resources
definition:
  v: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
comment:
  v: This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
condition:
  v: dom-2
condition:
  v: dom-4
condition:
  v: dom-3
condition:
  v: dom-5
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: SubscriptionStatus.extension
path:
  v: SubscriptionStatus.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: SubscriptionStatus.modifierExtension
path:
  v: SubscriptionStatus.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: false
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: SubscriptionStatus.status
path:
  v: SubscriptionStatus.status
short:
  v: requested | active | error | off | entered-in-error
definition:
  v: The status of the subscription, which marks the server state for managing the subscription.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubscriptionStatus.status
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
condition:
  v: sst-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: SubscriptionStatus
  strength:
    v: required
  description:
    v: The status of a subscription at the time this notification was generated.
  value set:
    v: http://hl7.org/fhir/ValueSet/subscription-status|5.0.0
    link: 5.0
    link: .0
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.status

id:
  v: SubscriptionStatus.type
path:
  v: SubscriptionStatus.type
short:
  v: Set to "event-notification"
definition:
  v: The type of event being conveyed with this notification.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: SubscriptionStatus.type
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
condition:
  v: sst-1
condition:
  v: sst-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: true
is modifier reason:
  v: Not known why this is labelled a modifier
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: SubscriptionNotificationType
  strength:
    v: required
  description:
    v: The type of notification represented by the status message.
  value set:
    v: http://hl7.org/fhir/ValueSet/subscription-notification-type|5.0.0
    link: 5.0
    link: .0
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.what[x]

id:
  v: SubscriptionStatus.eventsSinceSubscriptionStart
path:
  v: SubscriptionStatus.eventsSinceSubscriptionStart
short:
  v: Events since the Subscription was created
definition:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubscriptionStatus.eventsSinceSubscriptionStart
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: integer64
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: SubscriptionStatus.notificationEvent
path:
  v: SubscriptionStatus.notificationEvent
short:
  v: Detailed information about any events relevant to this notification
definition:
  v: Detailed information about events relevant to this subscription notification.
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubscriptionStatus.notificationEvent
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
condition:
  v: sst-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false

id:
  v: SubscriptionStatus.notificationEvent.id
path:
  v: SubscriptionStatus.notificationEvent.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: SubscriptionStatus.notificationEvent.extension
path:
  v: SubscriptionStatus.notificationEvent.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: SubscriptionStatus.notificationEvent.modifierExtension
path:
  v: SubscriptionStatus.notificationEvent.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: SubscriptionStatus.notificationEvent.eventNumber
path:
  v: SubscriptionStatus.notificationEvent.eventNumber
short:
  v: Sequencing index of this event
definition:
  v: Either the sequential number of this event in this subscription context or a relative event number for this notification.
comment:
  v: 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.).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: SubscriptionStatus.notificationEvent.eventNumber
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: integer64
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false

id:
  v: SubscriptionStatus.notificationEvent.timestamp
path:
  v: SubscriptionStatus.notificationEvent.timestamp
short:
  v: The instant this event occurred
definition:
  v: The actual time this event occurred on the server.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: SubscriptionStatus.notificationEvent.timestamp
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: instant
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false

id:
  v: SubscriptionStatus.notificationEvent.focus
path:
  v: SubscriptionStatus.notificationEvent.focus
short:
  v: Reference to the primary resource or information of this event
definition:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubscriptionStatus.notificationEvent.focus
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsDevice
    link: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsDevice
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false

id:
  v: SubscriptionStatus.notificationEvent.additionalContext
path:
  v: SubscriptionStatus.notificationEvent.additionalContext
short:
  v: References related to the focus resource and/or context of this event
definition:
  v: 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.
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubscriptionStatus.notificationEvent.additionalContext
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    link: http://hl7.org/fhir/StructureDefinition/Resource
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false

id:
  v: SubscriptionStatus.subscription
path:
  v: SubscriptionStatus.subscription
short:
  v: Reference to the rtlsSubscription resource responsible for this notification (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscription).
definition:
  v: The reference to the Subscription which generated this notification.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: SubscriptionStatus.subscription
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Subscription
    link: http://hl7.org/fhir/StructureDefinition/Subscription
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.why[x]

id:
  v: SubscriptionStatus.topic
path:
  v: SubscriptionStatus.topic
short:
  v: Reference to the rtlsSbuscriptionTopic resource this notification relates to (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic).
definition:
  v: The reference to the SubscriptionTopic for the Subscription which generated this notification.
comment:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: SubscriptionStatus.topic
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: canonical
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/SubscriptionTopic
    link: http://hl7.org/fhir/StructureDefinition/SubscriptionTopic
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true

id:
  v: SubscriptionStatus.error
path:
  v: SubscriptionStatus.error
short:
  v: List of errors on the subscription
definition:
  v: A record of errors that occurred when the server processed a notification.
comment:
  v: Recommended practice: clear errors when status is updated.
min:
  v: 0
max:
  v: *
base:
  path:
    v: SubscriptionStatus.error
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: SubscriptionError
  strength:
    v: example
  description:
    v: Codes to represent subscription error details.
  value set:
    v: http://hl7.org/fhir/ValueSet/subscription-error
    link: http://hl7.org/fhir/ValueSet/subscription-error

element:
  id:
    v: SubscriptionStatus
  path:
    v: SubscriptionStatus
element:
  id:
    v: SubscriptionStatus.status
  path:
    v: SubscriptionStatus.status
  must support:
    v: true
element:
  id:
    v: SubscriptionStatus.type
  path:
    v: SubscriptionStatus.type
  short:
    v: Set to "event-notification"
  must support:
    v: true
element:
  id:
    v: SubscriptionStatus.notificationEvent.timestamp
  path:
    v: SubscriptionStatus.notificationEvent.timestamp
  min:
    v: 1
  must support:
    v: true
element:
  id:
    v: SubscriptionStatus.notificationEvent.focus
  path:
    v: SubscriptionStatus.notificationEvent.focus
  type:
    code:
      v: Reference
    target profile:
      v: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsDevice
      link: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsDevice
  must support:
    v: true
element:
  id:
    v: SubscriptionStatus.subscription
  path:
    v: SubscriptionStatus.subscription
  short:
    v: Reference to the rtlsSubscription resource responsible for this notification (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscription).
  must support:
    v: true
element:
  id:
    v: SubscriptionStatus.topic
  path:
    v: SubscriptionStatus.topic
  short:
    v: Reference to the rtlsSbuscriptionTopic resource this notification relates to (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic).
  must support:
    v: true