Document Subscription for Mobile (DSUBm)
1.0.0 - Trial-Implementation International flag

This page is part of the Document Subscription for Mobile (DSUBm) (v1.0.0: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: SubscriptionStatus for the notification event

Official URL: https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/IHE.DSUBm.SubscriptionStatus-Event Version: 1.0.0
Active as of 2024-02-29 Computable Name: SubscriptionStatus_NotificationEvent

Profile on the SubscriptionStatus resource for the event notification

Usage:

Formal Views of Profile Content

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

This structure is derived from BackportSubscriptionStatusR4

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters BackportSubscriptionStatusR4
... parameter 5..*BackboneElementSlices containing subscription status information
... parameter:type 1..1BackboneElementParameter containing the type of event for this notification
.... value[x] 1..1codeThe type of event being conveyed with this notificaiton.
Required Pattern: event-notification
... parameter:eventsSinceSubscriptionStart 1..1BackboneElementServers SHALL include this value when sending event notifications in order to allow clients to detect missing events.
.... value[x] 1..1stringEvents since the Subscription was created
... parameter:notificationEvent 1..1BackboneElementServers SHALL include this value when sending event notifications in order to allow clients to detect missing events. This value is inclusive of this notification (e.g., the first event notification sent would include one (1) in this element).

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*BackportSubscriptionStatusR4Parameter containing subscription status information
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣC5..*BackboneElementSlices containing subscription status information
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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: SubscriptionStatus (required)
.... parameter:type SΣC1..1BackboneElementParameter containing the type of event for this notification
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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: subscription-notification-type (required)
Required Pattern: event-notification
.... parameter:eventsSinceSubscriptionStart SΣC1..1BackboneElementServers SHALL include this value when sending event notifications in order to allow clients to detect missing events.
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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ΣC1..1stringEvents since the Subscription was created
.... parameter:notificationEvent SΣC1..1BackboneElementServers SHALL include this value when sending event notifications in order to allow clients to detect missing events. This value is inclusive of this notification (e.g., the first event notification sent would include one (1) in this element).
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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 / CodeURI
Parameters.parameter:status.value[x]requiredSubscriptionStatus
http://hl7.org/fhir/ValueSet/subscription-status
from the FHIR Standard
Parameters.parameter:type.value[x]requiredPattern: event-notification
http://hl7.org/fhir/ValueSet/subscription-notification-type
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*BackportSubscriptionStatusR4Parameter 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... Slices for parameter ΣC5..*BackboneElementSlices containing subscription status information
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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: SubscriptionStatus (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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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: subscription-notification-type (required)
Required Pattern: event-notification
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:eventsSinceSubscriptionStart SΣC1..1BackboneElementServers SHALL include this value when sending event notifications in order to allow clients to detect missing events.
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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ΣC1..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ΣC1..1BackboneElementServers SHALL include this value when sending event notifications in order to allow clients to detect missing events. This value is inclusive of this notification (e.g., the first event notification sent would include one (1) in this element).
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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 / CodeURI
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Parameters.parameter:status.value[x]requiredSubscriptionStatus
http://hl7.org/fhir/ValueSet/subscription-status
from the FHIR Standard
Parameters.parameter:type.value[x]requiredPattern: event-notification
http://hl7.org/fhir/ValueSet/subscription-notification-type

This structure is derived from BackportSubscriptionStatusR4

Summary

Mandatory: 3 elements

Differential View

This structure is derived from BackportSubscriptionStatusR4

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters BackportSubscriptionStatusR4
... parameter 5..*BackboneElementSlices containing subscription status information
... parameter:type 1..1BackboneElementParameter containing the type of event for this notification
.... value[x] 1..1codeThe type of event being conveyed with this notificaiton.
Required Pattern: event-notification
... parameter:eventsSinceSubscriptionStart 1..1BackboneElementServers SHALL include this value when sending event notifications in order to allow clients to detect missing events.
.... value[x] 1..1stringEvents since the Subscription was created
... parameter:notificationEvent 1..1BackboneElementServers SHALL include this value when sending event notifications in order to allow clients to detect missing events. This value is inclusive of this notification (e.g., the first event notification sent would include one (1) in this element).

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*BackportSubscriptionStatusR4Parameter containing subscription status information
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣC5..*BackboneElementSlices containing subscription status information
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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: SubscriptionStatus (required)
.... parameter:type SΣC1..1BackboneElementParameter containing the type of event for this notification
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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: subscription-notification-type (required)
Required Pattern: event-notification
.... parameter:eventsSinceSubscriptionStart SΣC1..1BackboneElementServers SHALL include this value when sending event notifications in order to allow clients to detect missing events.
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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ΣC1..1stringEvents since the Subscription was created
.... parameter:notificationEvent SΣC1..1BackboneElementServers SHALL include this value when sending event notifications in order to allow clients to detect missing events. This value is inclusive of this notification (e.g., the first event notification sent would include one (1) in this element).
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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 / CodeURI
Parameters.parameter:status.value[x]requiredSubscriptionStatus
http://hl7.org/fhir/ValueSet/subscription-status
from the FHIR Standard
Parameters.parameter:type.value[x]requiredPattern: event-notification
http://hl7.org/fhir/ValueSet/subscription-notification-type

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*BackportSubscriptionStatusR4Parameter 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... Slices for parameter ΣC5..*BackboneElementSlices containing subscription status information
Slice: Unordered, Open by value:name
inv-1: A parameter must have one and only one of (value, resource, part)
.... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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: SubscriptionStatus (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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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: subscription-notification-type (required)
Required Pattern: event-notification
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:eventsSinceSubscriptionStart SΣC1..1BackboneElementServers SHALL include this value when sending event notifications in order to allow clients to detect missing events.
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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ΣC1..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ΣC1..1BackboneElementServers SHALL include this value when sending event notifications in order to allow clients to detect missing events. This value is inclusive of this notification (e.g., the first event notification sent would include one (1) in this element).
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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 / CodeURI
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Parameters.parameter:status.value[x]requiredSubscriptionStatus
http://hl7.org/fhir/ValueSet/subscription-status
from the FHIR Standard
Parameters.parameter:type.value[x]requiredPattern: event-notification
http://hl7.org/fhir/ValueSet/subscription-notification-type

This structure is derived from BackportSubscriptionStatusR4

Summary

Mandatory: 3 elements

 

Other representations of profile: CSV, Excel, Schematron