Subscriptions R5 Backport
1.1.0 - Standard for Trial Use International flag

This page is part of the Subscriptions R5 Backport (v1.1.0: STU 1.1) based on FHIR v4.3.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: R4 Backported R5 SubscriptionStatus

Official URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-status-r4 Version: 1.1.0
Active as of 2023-01-11 Computable Name: BackportSubscriptionStatusR4

Profile on Parameters for topic-based subscription notifications in R4.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersParameter containing subscription status information
... Slices for parameter 3..*BackboneElementSlices containing subscription status information
Slice: Unordered, Open by value:name
.... parameter:subscription S1..1BackboneElementParameter containing the reference to a subscription
..... name 1..1stringSlice discriminator: the reference to a subscription
Fixed Value: subscription
..... value[x] S1..1Reference(Subscription)Reference to the Subscription responsible for this notification
.... parameter:topic S0..1BackboneElementParameter containing the canonical reference to a subscription topic
..... name 1..1stringSlice discriminator: the canonical reference to a subscription topic
Fixed Value: topic
..... value[x] S0..1canonical()Canonical reference to the SubscriptionTopic this notification relates to
.... parameter:status S1..1BackboneElementParameter containing the subscription status
..... name 1..1stringSlice discriminator: the subscription status
Fixed Value: status
..... value[x] S1..1codeStatus of the subscription when this notification was generated
Binding: SubscriptionStatusCodes (required)
.... parameter:type S1..1BackboneElementParameter containing the type of event for this notification
..... name 1..1stringSlice discriminator: the type of event for this notification
Fixed Value: type
..... value[x] S1..1codeThe type of event being conveyed with this notificaiton.
Binding: SubscriptionNotificationType (required)
.... parameter:eventsSinceSubscriptionStart S0..1BackboneElementParameter containing the number of events since this subscription started
..... name 1..1stringSlice discriminator: the number of events since this subscription started
Fixed Value: events-since-subscription-start
..... value[x] S0..1stringEvents since the Subscription was created
.... parameter:notificationEvent S0..*BackboneElementParameter containing the event notification details
..... name 1..1stringParameter containing notification event details
Fixed Value: notification-event
..... Slices for part S1..*Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:eventNumber S1..1BackboneElementParameter containing the event number
....... name 1..1stringSlice discriminator: the event number
Fixed Value: event-number
....... value[x] S1..1stringEvent number
...... part:eventTimestamp S0..1BackboneElementParameter containing the event timestamp
....... name 1..1stringSlice discriminator: the event timestamp
Fixed Value: timestamp
....... value[x] S0..1instantThe instant this event occurred
...... part:eventFocus S0..1BackboneElementParameter containing the event focus
....... name 1..1stringSlice discriminator: the event focus
Fixed Value: focus
....... value[x] S0..1Reference()The focus of this event
...... part:eventAdditionalContext S0..*BackboneElementParameter containing additional context for this event
....... name 1..1stringSlice discriminator: additional context for this event
Fixed Value: additional-context
....... value[x] S0..1Reference()Additional context for this event
.... parameter:error S0..*BackboneElementParameter containing errors on the subscription
..... name 1..1stringSlice discriminator: errors on the subscription
Fixed Value: error
..... value[x] S0..1CodeableConceptAn error on the subscription

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Parameters.parameter:status.value[x]requiredSubscriptionStatusCodes
Parameters.parameter:type.value[x]requiredSubscriptionNotificationType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersParameter containing subscription status information
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣC3..*BackboneElementSlices containing subscription status information
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
.... parameter:subscription SΣC1..1BackboneElementParameter containing the reference to a subscription
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the reference to a subscription
Fixed Value: subscription
..... value[x] SΣC1..1Reference(Subscription)Reference to the Subscription responsible for this notification
.... parameter:topic SΣC0..1BackboneElementParameter containing the canonical reference to a subscription topic
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the canonical reference to a subscription topic
Fixed Value: topic
..... value[x] SΣC0..1canonical()Canonical reference to the SubscriptionTopic this notification relates to
.... parameter:status SΣC1..1BackboneElementParameter containing the subscription status
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the subscription status
Fixed Value: status
..... value[x] SΣC1..1codeStatus of the subscription when this notification was generated
Binding: SubscriptionStatusCodes (required)
.... parameter:type SΣC1..1BackboneElementParameter containing the type of event for this notification
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the type of event for this notification
Fixed Value: type
..... value[x] SΣC1..1codeThe type of event being conveyed with this notificaiton.
Binding: SubscriptionNotificationType (required)
.... parameter:eventsSinceSubscriptionStart SΣC0..1BackboneElementParameter containing the number of events since this subscription started
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the number of events since this subscription started
Fixed Value: events-since-subscription-start
..... value[x] SΣC0..1stringEvents since the Subscription was created
.... parameter:notificationEvent SΣC0..*BackboneElementParameter containing the event notification details
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringParameter containing notification event details
Fixed Value: notification-event
..... Slices for part SΣ1..*See parameter (Parameters)Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:eventNumber SΣ1..1BackboneElementParameter containing the event number
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: the event number
Fixed Value: event-number
....... value[x] SΣC1..1stringEvent number
...... part:eventTimestamp SΣ0..1BackboneElementParameter containing the event timestamp
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: the event timestamp
Fixed Value: timestamp
....... value[x] SΣC0..1instantThe instant this event occurred
...... part:eventFocus SΣ0..1BackboneElementParameter containing the event focus
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: the event focus
Fixed Value: focus
....... value[x] SΣC0..1Reference()The focus of this event
...... part:eventAdditionalContext SΣ0..*BackboneElementParameter containing additional context for this event
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: additional context for this event
Fixed Value: additional-context
....... value[x] SΣC0..1Reference()Additional context for this event
.... parameter:error SΣC0..*BackboneElementParameter containing errors on the subscription
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: errors on the subscription
Fixed Value: error
..... value[x] SΣC0..1CodeableConceptAn error on the subscription

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Parameters.parameter:status.value[x]requiredSubscriptionStatusCodes
Parameters.parameter:type.value[x]requiredSubscriptionNotificationType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersParameter containing subscription status information
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣC3..*BackboneElementSlices containing subscription status information
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
..... value[x] ΣC0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:subscription SΣC1..1BackboneElementParameter containing the reference to a subscription
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the reference to a subscription
Fixed Value: subscription
..... value[x] SΣC1..1Reference(Subscription)Reference to the Subscription responsible for this notification
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:topic SΣC0..1BackboneElementParameter containing the canonical reference to a subscription topic
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the canonical reference to a subscription topic
Fixed Value: topic
..... value[x] SΣC0..1canonical()Canonical reference to the SubscriptionTopic this notification relates to
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:status SΣC1..1BackboneElementParameter containing the subscription status
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the subscription status
Fixed Value: status
..... value[x] SΣC1..1codeStatus of the subscription when this notification was generated
Binding: SubscriptionStatusCodes (required)
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:type SΣC1..1BackboneElementParameter containing the type of event for this notification
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the type of event for this notification
Fixed Value: type
..... value[x] SΣC1..1codeThe type of event being conveyed with this notificaiton.
Binding: SubscriptionNotificationType (required)
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:eventsSinceSubscriptionStart SΣC0..1BackboneElementParameter containing the number of events since this subscription started
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the number of events since this subscription started
Fixed Value: events-since-subscription-start
..... value[x] SΣC0..1stringEvents since the Subscription was created
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:notificationEvent SΣC0..*BackboneElementParameter containing the event notification details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringParameter containing notification event details
Fixed Value: notification-event
..... value[x] ΣC0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... Slices for part SΣ1..*See parameter (Parameters)Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:eventNumber SΣ1..1BackboneElementParameter containing the event number
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: the event number
Fixed Value: event-number
....... value[x] SΣC1..1stringEvent number
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:eventTimestamp SΣ0..1BackboneElementParameter containing the event timestamp
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: the event timestamp
Fixed Value: timestamp
....... value[x] SΣC0..1instantThe instant this event occurred
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:eventFocus SΣ0..1BackboneElementParameter containing the event focus
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: the event focus
Fixed Value: focus
....... value[x] SΣC0..1Reference()The focus of this event
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:eventAdditionalContext SΣ0..*BackboneElementParameter containing additional context for this event
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: additional context for this event
Fixed Value: additional-context
....... value[x] SΣC0..1Reference()Additional context for this event
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:error SΣC0..*BackboneElementParameter containing errors on the subscription
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: errors on the subscription
Fixed Value: error
..... value[x] SΣC0..1CodeableConceptAn error on the subscription
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Parameters.parameter:status.value[x]requiredSubscriptionStatusCodes
Parameters.parameter:type.value[x]requiredSubscriptionNotificationType

This structure is derived from Parameters

Summary

Mandatory: 6 elements (3 nested mandatory elements)
Must-Support: 22 elements
Fixed Value: 11 elements

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:name
  • The element Parameters.parameter.part is sliced based on the value of value:name

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersParameter containing subscription status information
... Slices for parameter 3..*BackboneElementSlices containing subscription status information
Slice: Unordered, Open by value:name
.... parameter:subscription S1..1BackboneElementParameter containing the reference to a subscription
..... name 1..1stringSlice discriminator: the reference to a subscription
Fixed Value: subscription
..... value[x] S1..1Reference(Subscription)Reference to the Subscription responsible for this notification
.... parameter:topic S0..1BackboneElementParameter containing the canonical reference to a subscription topic
..... name 1..1stringSlice discriminator: the canonical reference to a subscription topic
Fixed Value: topic
..... value[x] S0..1canonical()Canonical reference to the SubscriptionTopic this notification relates to
.... parameter:status S1..1BackboneElementParameter containing the subscription status
..... name 1..1stringSlice discriminator: the subscription status
Fixed Value: status
..... value[x] S1..1codeStatus of the subscription when this notification was generated
Binding: SubscriptionStatusCodes (required)
.... parameter:type S1..1BackboneElementParameter containing the type of event for this notification
..... name 1..1stringSlice discriminator: the type of event for this notification
Fixed Value: type
..... value[x] S1..1codeThe type of event being conveyed with this notificaiton.
Binding: SubscriptionNotificationType (required)
.... parameter:eventsSinceSubscriptionStart S0..1BackboneElementParameter containing the number of events since this subscription started
..... name 1..1stringSlice discriminator: the number of events since this subscription started
Fixed Value: events-since-subscription-start
..... value[x] S0..1stringEvents since the Subscription was created
.... parameter:notificationEvent S0..*BackboneElementParameter containing the event notification details
..... name 1..1stringParameter containing notification event details
Fixed Value: notification-event
..... Slices for part S1..*Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:eventNumber S1..1BackboneElementParameter containing the event number
....... name 1..1stringSlice discriminator: the event number
Fixed Value: event-number
....... value[x] S1..1stringEvent number
...... part:eventTimestamp S0..1BackboneElementParameter containing the event timestamp
....... name 1..1stringSlice discriminator: the event timestamp
Fixed Value: timestamp
....... value[x] S0..1instantThe instant this event occurred
...... part:eventFocus S0..1BackboneElementParameter containing the event focus
....... name 1..1stringSlice discriminator: the event focus
Fixed Value: focus
....... value[x] S0..1Reference()The focus of this event
...... part:eventAdditionalContext S0..*BackboneElementParameter containing additional context for this event
....... name 1..1stringSlice discriminator: additional context for this event
Fixed Value: additional-context
....... value[x] S0..1Reference()Additional context for this event
.... parameter:error S0..*BackboneElementParameter containing errors on the subscription
..... name 1..1stringSlice discriminator: errors on the subscription
Fixed Value: error
..... value[x] S0..1CodeableConceptAn error on the subscription

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Parameters.parameter:status.value[x]requiredSubscriptionStatusCodes
Parameters.parameter:type.value[x]requiredSubscriptionNotificationType

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersParameter containing subscription status information
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣC3..*BackboneElementSlices containing subscription status information
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
.... parameter:subscription SΣC1..1BackboneElementParameter containing the reference to a subscription
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the reference to a subscription
Fixed Value: subscription
..... value[x] SΣC1..1Reference(Subscription)Reference to the Subscription responsible for this notification
.... parameter:topic SΣC0..1BackboneElementParameter containing the canonical reference to a subscription topic
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the canonical reference to a subscription topic
Fixed Value: topic
..... value[x] SΣC0..1canonical()Canonical reference to the SubscriptionTopic this notification relates to
.... parameter:status SΣC1..1BackboneElementParameter containing the subscription status
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the subscription status
Fixed Value: status
..... value[x] SΣC1..1codeStatus of the subscription when this notification was generated
Binding: SubscriptionStatusCodes (required)
.... parameter:type SΣC1..1BackboneElementParameter containing the type of event for this notification
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the type of event for this notification
Fixed Value: type
..... value[x] SΣC1..1codeThe type of event being conveyed with this notificaiton.
Binding: SubscriptionNotificationType (required)
.... parameter:eventsSinceSubscriptionStart SΣC0..1BackboneElementParameter containing the number of events since this subscription started
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the number of events since this subscription started
Fixed Value: events-since-subscription-start
..... value[x] SΣC0..1stringEvents since the Subscription was created
.... parameter:notificationEvent SΣC0..*BackboneElementParameter containing the event notification details
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringParameter containing notification event details
Fixed Value: notification-event
..... Slices for part SΣ1..*See parameter (Parameters)Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:eventNumber SΣ1..1BackboneElementParameter containing the event number
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: the event number
Fixed Value: event-number
....... value[x] SΣC1..1stringEvent number
...... part:eventTimestamp SΣ0..1BackboneElementParameter containing the event timestamp
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: the event timestamp
Fixed Value: timestamp
....... value[x] SΣC0..1instantThe instant this event occurred
...... part:eventFocus SΣ0..1BackboneElementParameter containing the event focus
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: the event focus
Fixed Value: focus
....... value[x] SΣC0..1Reference()The focus of this event
...... part:eventAdditionalContext SΣ0..*BackboneElementParameter containing additional context for this event
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: additional context for this event
Fixed Value: additional-context
....... value[x] SΣC0..1Reference()Additional context for this event
.... parameter:error SΣC0..*BackboneElementParameter containing errors on the subscription
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: errors on the subscription
Fixed Value: error
..... value[x] SΣC0..1CodeableConceptAn error on the subscription

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Parameters.parameter:status.value[x]requiredSubscriptionStatusCodes
Parameters.parameter:type.value[x]requiredSubscriptionNotificationType

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersParameter containing subscription status information
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣC3..*BackboneElementSlices containing subscription status information
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
..... value[x] ΣC0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:subscription SΣC1..1BackboneElementParameter containing the reference to a subscription
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the reference to a subscription
Fixed Value: subscription
..... value[x] SΣC1..1Reference(Subscription)Reference to the Subscription responsible for this notification
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:topic SΣC0..1BackboneElementParameter containing the canonical reference to a subscription topic
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the canonical reference to a subscription topic
Fixed Value: topic
..... value[x] SΣC0..1canonical()Canonical reference to the SubscriptionTopic this notification relates to
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:status SΣC1..1BackboneElementParameter containing the subscription status
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the subscription status
Fixed Value: status
..... value[x] SΣC1..1codeStatus of the subscription when this notification was generated
Binding: SubscriptionStatusCodes (required)
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:type SΣC1..1BackboneElementParameter containing the type of event for this notification
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the type of event for this notification
Fixed Value: type
..... value[x] SΣC1..1codeThe type of event being conveyed with this notificaiton.
Binding: SubscriptionNotificationType (required)
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:eventsSinceSubscriptionStart SΣC0..1BackboneElementParameter containing the number of events since this subscription started
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: the number of events since this subscription started
Fixed Value: events-since-subscription-start
..... value[x] SΣC0..1stringEvents since the Subscription was created
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:notificationEvent SΣC0..*BackboneElementParameter containing the event notification details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringParameter containing notification event details
Fixed Value: notification-event
..... value[x] ΣC0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... Slices for part SΣ1..*See parameter (Parameters)Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:eventNumber SΣ1..1BackboneElementParameter containing the event number
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: the event number
Fixed Value: event-number
....... value[x] SΣC1..1stringEvent number
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:eventTimestamp SΣ0..1BackboneElementParameter containing the event timestamp
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: the event timestamp
Fixed Value: timestamp
....... value[x] SΣC0..1instantThe instant this event occurred
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:eventFocus SΣ0..1BackboneElementParameter containing the event focus
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: the event focus
Fixed Value: focus
....... value[x] SΣC0..1Reference()The focus of this event
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:eventAdditionalContext SΣ0..*BackboneElementParameter containing additional context for this event
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name Σ1..1stringSlice discriminator: additional context for this event
Fixed Value: additional-context
....... value[x] SΣC0..1Reference()Additional context for this event
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:error SΣC0..*BackboneElementParameter containing errors on the subscription
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringSlice discriminator: errors on the subscription
Fixed Value: error
..... value[x] SΣC0..1CodeableConceptAn error on the subscription
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Parameters.parameter:status.value[x]requiredSubscriptionStatusCodes
Parameters.parameter:type.value[x]requiredSubscriptionNotificationType

This structure is derived from Parameters

Summary

Mandatory: 6 elements (3 nested mandatory elements)
Must-Support: 22 elements
Fixed Value: 11 elements

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:name
  • The element Parameters.parameter.part is sliced based on the value of value:name

 

Other representations of profile: CSV, Excel, Schematron