ISiK Subscription Implementierungsleitfaden
Version 6.0.0-rc - STU1

Resource Profile: R4 Backported R5 SubscriptionStatus

Official URL: https://gematik.de/fhir/isik/StructureDefinition/BackportSubscriptionStatusR4Fixed Version: 6.0.0-rc
Active as of 2023-01-11 Computable Name: BackportSubscriptionStatusR4Fixed

Profil auf der FHIR-R4-Resource Parameters zur Unterstützung themenbasierter Subscription-Benachrichtigungen in R4.

Dieses Profil ist funktional identisch mit http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription-status-r4.
Die Version 1.1.0 des offiziellen Profils weist jedoch technische Fehler auf. Daher wurde es hier als Workaround erneut implementiert. Diese lokale Definition wird durch das offizielle backport-subscription-status-r4 Profil ersetzt, sobald eine korrigierte Version veröffentlicht wurde.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Parameter containing subscription status information
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 3..* BackboneElement Slices containing subscription status information
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:subscription SΣC 1..1 BackboneElement Parameter containing the reference to a subscription
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the reference to a subscription
Fixed Value: subscription
..... value[x] SΣC 1..1 Reference(Subscription) Reference to the Subscription responsible for this notification
.... parameter:topic SΣC 0..1 BackboneElement Parameter containing the canonical reference to a subscription topic
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the canonical reference to a subscription topic
Fixed Value: topic
..... value[x] SΣC 0..1 canonical() Canonical reference to the SubscriptionTopic this notification relates to
.... parameter:status SΣC 1..1 BackboneElement Parameter containing the subscription status
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the subscription status
Fixed Value: status
..... value[x] SΣC 1..1 code Status of the subscription when this notification was generated
Binding: SubscriptionStatus (required)
.... parameter:type SΣC 1..1 BackboneElement Parameter containing the type of event for this notification
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the type of event for this notification
Fixed Value: type
..... value[x] SΣC 1..1 code The type of event being conveyed with this notificaiton.
Binding: SubscriptionNotificationTypeVS (required)
.... parameter:eventsSinceSubscriptionStart SΣC 0..1 BackboneElement Parameter containing the number of events since this subscription started
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the number of events since this subscription started
Fixed Value: events-since-subscription-start
..... value[x] SΣC 0..1 string Events since the Subscription was created
.... parameter:notificationEvent SΣC 0..* BackboneElement Parameter containing the event notification details
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Parameter 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:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
...... part:eventNumber SΣ 1..1 BackboneElement Parameter containing the event number
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: the event number
Fixed Value: event-number
....... value[x] SΣC 1..1 string Event number
...... part:eventTimestamp SΣ 0..1 BackboneElement Parameter containing the event timestamp
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: the event timestamp
Fixed Value: timestamp
....... value[x] SΣC 0..1 instant The instant this event occurred
...... part:eventFocus SΣ 0..1 BackboneElement Parameter containing the event focus
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: the event focus
Fixed Value: focus
....... value[x] SΣC 0..1 Reference() The focus of this event
...... part:eventAdditionalContext SΣ 0..* BackboneElement Parameter containing additional context for this event
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: additional context for this event
Fixed Value: additional-context
....... value[x] SΣC 0..1 Reference() Additional context for this event
.... parameter:error SΣC 0..* BackboneElement Parameter containing errors on the subscription
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: errors on the subscription
Fixed Value: error
..... value[x] SΣC 0..1 CodeableConcept An error on the subscription

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.parameter:status.​value[x] Base required SubscriptionStatus 📦4.0.1 FHIR Std.
Parameters.parameter:type.​value[x] Base required SubscriptionNotificationType 📦6.0.0-rc This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-1 error Parameters.parameter, Parameters.parameter:subscription, Parameters.parameter:topic, Parameters.parameter:status, Parameters.parameter:type, Parameters.parameter:eventsSinceSubscriptionStart, Parameters.parameter:notificationEvent, Parameters.parameter:error A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Parameter containing subscription status information
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... Slices for parameter 3..* BackboneElement Slices containing subscription status information
Slice: Unordered, Open by value:name
.... parameter:subscription S 1..1 BackboneElement Parameter containing the reference to a subscription
..... name 1..1 string Slice discriminator: the reference to a subscription
Fixed Value: subscription
..... value[x] S 1..1 Reference(Subscription) Reference to the Subscription responsible for this notification
.... parameter:topic S 0..1 BackboneElement Parameter containing the canonical reference to a subscription topic
..... name 1..1 string Slice discriminator: the canonical reference to a subscription topic
Fixed Value: topic
..... value[x] S 0..1 canonical() Canonical reference to the SubscriptionTopic this notification relates to
.... parameter:status S 1..1 BackboneElement Parameter containing the subscription status
..... name 1..1 string Slice discriminator: the subscription status
Fixed Value: status
..... value[x] S 1..1 code Status of the subscription when this notification was generated
Binding: SubscriptionStatus (required)
.... parameter:type S 1..1 BackboneElement Parameter containing the type of event for this notification
..... name 1..1 string Slice discriminator: the type of event for this notification
Fixed Value: type
..... value[x] S 1..1 code The type of event being conveyed with this notificaiton.
Binding: SubscriptionNotificationTypeVS (required)
.... parameter:eventsSinceSubscriptionStart S 0..1 BackboneElement Parameter containing the number of events since this subscription started
..... name 1..1 string Slice discriminator: the number of events since this subscription started
Fixed Value: events-since-subscription-start
..... value[x] S 0..1 string Events since the Subscription was created
.... parameter:notificationEvent S 0..* BackboneElement Parameter containing the event notification details
..... name 1..1 string Parameter containing notification event details
Fixed Value: notification-event
..... Slices for part S 1..* Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:eventNumber S 1..1 BackboneElement Parameter containing the event number
....... name 1..1 string Slice discriminator: the event number
Fixed Value: event-number
....... value[x] S 1..1 string Event number
...... part:eventTimestamp S 0..1 BackboneElement Parameter containing the event timestamp
....... name 1..1 string Slice discriminator: the event timestamp
Fixed Value: timestamp
....... value[x] S 0..1 instant The instant this event occurred
...... part:eventFocus S 0..1 BackboneElement Parameter containing the event focus
....... name 1..1 string Slice discriminator: the event focus
Fixed Value: focus
....... value[x] S 0..1 Reference() The focus of this event
...... part:eventAdditionalContext S 0..* BackboneElement Parameter containing additional context for this event
....... name 1..1 string Slice discriminator: additional context for this event
Fixed Value: additional-context
....... value[x] S 0..1 Reference() Additional context for this event
.... parameter:error S 0..* BackboneElement Parameter containing errors on the subscription
..... name 1..1 string Slice discriminator: errors on the subscription
Fixed Value: error
..... value[x] S 0..1 CodeableConcept An error on the subscription

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Parameters.parameter:status.​value[x] Base required SubscriptionStatus 📦4.0.1 FHIR Std.
Parameters.parameter:type.​value[x] Base required SubscriptionNotificationType 📦6.0.0-rc This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Parameter containing subscription status information
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 3..* BackboneElement Slices containing subscription status information
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:subscription SΣC 1..1 BackboneElement Parameter containing the reference to a subscription
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the reference to a subscription
Fixed Value: subscription
..... value[x] SΣC 1..1 Reference(Subscription) Reference to the Subscription responsible for this notification
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:topic SΣC 0..1 BackboneElement Parameter containing the canonical reference to a subscription topic
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the canonical reference to a subscription topic
Fixed Value: topic
..... value[x] SΣC 0..1 canonical() Canonical reference to the SubscriptionTopic this notification relates to
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:status SΣC 1..1 BackboneElement Parameter containing the subscription status
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the subscription status
Fixed Value: status
..... value[x] SΣC 1..1 code Status of the subscription when this notification was generated
Binding: SubscriptionStatus (required)
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:type SΣC 1..1 BackboneElement Parameter containing the type of event for this notification
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the type of event for this notification
Fixed Value: type
..... value[x] SΣC 1..1 code The type of event being conveyed with this notificaiton.
Binding: SubscriptionNotificationTypeVS (required)
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:eventsSinceSubscriptionStart SΣC 0..1 BackboneElement Parameter containing the number of events since this subscription started
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the number of events since this subscription started
Fixed Value: events-since-subscription-start
..... value[x] SΣC 0..1 string Events since the Subscription was created
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:notificationEvent SΣC 0..* BackboneElement Parameter containing the event notification details
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Parameter containing notification event details
Fixed Value: notification-event
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If 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:All Slices Content/Rules for all slices
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
....... value[x] ΣC 0..1 If parameter is a data type
........ valueBase64Binary base64Binary
........ valueBoolean boolean
........ valueCanonical canonical(Any)
........ valueCode code
........ valueDate date
........ valueDateTime dateTime
........ valueDecimal decimal
........ valueId id
........ valueInstant instant
........ valueInteger integer
........ valueMarkdown markdown
........ valueOid oid
........ valuePositiveInt positiveInt
........ valueString string
........ valueTime time
........ valueUnsignedInt unsignedInt
........ valueUri uri
........ valueUrl url
........ valueUuid uuid
........ valueAddress Address
........ valueAge Age
........ valueAnnotation Annotation
........ valueAttachment Attachment
........ valueCodeableConcept CodeableConcept
........ valueCoding Coding
........ valueContactPoint ContactPoint
........ valueCount Count
........ valueDistance Distance
........ valueDuration Duration
........ valueHumanName HumanName
........ valueIdentifier Identifier
........ valueMoney Money
........ valuePeriod Period
........ valueQuantity Quantity
........ valueRange Range
........ valueRatio Ratio
........ valueReference Reference(Any)
........ valueSampledData SampledData
........ valueSignature Signature
........ valueTiming Timing
........ valueContactDetail ContactDetail
........ valueContributor Contributor
........ valueDataRequirement DataRequirement
........ valueExpression Expression
........ valueParameterDefinition ParameterDefinition
........ valueRelatedArtifact RelatedArtifact
........ valueTriggerDefinition TriggerDefinition
........ valueUsageContext UsageContext
........ valueDosage Dosage
........ valueMeta Meta
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:eventNumber SΣ 1..1 BackboneElement Parameter containing the event number
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: the event number
Fixed Value: event-number
....... value[x] SΣC 1..1 string Event number
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:eventTimestamp SΣ 0..1 BackboneElement Parameter containing the event timestamp
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: the event timestamp
Fixed Value: timestamp
....... value[x] SΣC 0..1 instant The instant this event occurred
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:eventFocus SΣ 0..1 BackboneElement Parameter containing the event focus
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: the event focus
Fixed Value: focus
....... value[x] SΣC 0..1 Reference() The focus of this event
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:eventAdditionalContext SΣ 0..* BackboneElement Parameter containing additional context for this event
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: additional context for this event
Fixed Value: additional-context
....... value[x] SΣC 0..1 Reference() Additional context for this event
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:error SΣC 0..* BackboneElement Parameter containing errors on the subscription
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: errors on the subscription
Fixed Value: error
..... value[x] SΣC 0..1 CodeableConcept An error on the subscription
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Parameters.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Parameters.parameter:status.​value[x] Base required SubscriptionStatus 📦4.0.1 FHIR Std.
Parameters.parameter:type.​value[x] Base required SubscriptionNotificationType 📦6.0.0-rc This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-1 error Parameters.parameter, Parameters.parameter:subscription, Parameters.parameter:topic, Parameters.parameter:status, Parameters.parameter:type, Parameters.parameter:eventsSinceSubscriptionStart, Parameters.parameter:notificationEvent, Parameters.parameter:error A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
ElementShort descriptionNotes
Parameters.id serverseitige, interne ID des Datensatzes

bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine id verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine idverfügen.
Parameters.parameter:error Parameter containing errors on the subscription
Parameters.parameter:error.value[x] An error on the subscription
Parameters.parameter:eventsSinceSubscriptionStart Parameter containing the number of events since this subscription started
Parameters.parameter:eventsSinceSubscriptionStart.value[x] Events since the Subscription was created
Parameters.parameter:notificationEvent Parameter containing the event notification details
Parameters.parameter:notificationEvent.part
Parameters.parameter:notificationEvent.part:eventAdditionalContext Parameter containing additional context for this event
Parameters.parameter:notificationEvent.part:eventAdditionalContext.value[x] Additional context for this event
Parameters.parameter:notificationEvent.part:eventFocus Parameter containing the event focus
Parameters.parameter:notificationEvent.part:eventFocus.value[x] The focus of this event
Parameters.parameter:notificationEvent.part:eventNumber Parameter containing the event number
Parameters.parameter:notificationEvent.part:eventNumber.value[x] Event number
Parameters.parameter:notificationEvent.part:eventTimestamp Parameter containing the event timestamp
Parameters.parameter:notificationEvent.part:eventTimestamp.value[x] The instant this event occurred
Parameters.parameter:status Parameter containing the subscription status
Parameters.parameter:status.value[x] Status of the subscription when this notification was generated
Parameters.parameter:subscription Parameter containing the reference to a subscription
Parameters.parameter:subscription.value[x] Reference to the Subscription responsible for this notification
Parameters.parameter:topic Parameter containing the canonical reference to a subscription topic
Parameters.parameter:topic.value[x] Canonical reference to the SubscriptionTopic this notification relates to

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.
Parameters.parameter:type Parameter containing the type of event for this notification
Parameters.parameter:type.value[x] The type of event being conveyed with this notificaiton.

This structure is derived from Parameters

Summary

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

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Parameter containing subscription status information
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 3..* BackboneElement Slices containing subscription status information
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:subscription SΣC 1..1 BackboneElement Parameter containing the reference to a subscription
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the reference to a subscription
Fixed Value: subscription
..... value[x] SΣC 1..1 Reference(Subscription) Reference to the Subscription responsible for this notification
.... parameter:topic SΣC 0..1 BackboneElement Parameter containing the canonical reference to a subscription topic
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the canonical reference to a subscription topic
Fixed Value: topic
..... value[x] SΣC 0..1 canonical() Canonical reference to the SubscriptionTopic this notification relates to
.... parameter:status SΣC 1..1 BackboneElement Parameter containing the subscription status
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the subscription status
Fixed Value: status
..... value[x] SΣC 1..1 code Status of the subscription when this notification was generated
Binding: SubscriptionStatus (required)
.... parameter:type SΣC 1..1 BackboneElement Parameter containing the type of event for this notification
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the type of event for this notification
Fixed Value: type
..... value[x] SΣC 1..1 code The type of event being conveyed with this notificaiton.
Binding: SubscriptionNotificationTypeVS (required)
.... parameter:eventsSinceSubscriptionStart SΣC 0..1 BackboneElement Parameter containing the number of events since this subscription started
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the number of events since this subscription started
Fixed Value: events-since-subscription-start
..... value[x] SΣC 0..1 string Events since the Subscription was created
.... parameter:notificationEvent SΣC 0..* BackboneElement Parameter containing the event notification details
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Parameter 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:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
...... part:eventNumber SΣ 1..1 BackboneElement Parameter containing the event number
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: the event number
Fixed Value: event-number
....... value[x] SΣC 1..1 string Event number
...... part:eventTimestamp SΣ 0..1 BackboneElement Parameter containing the event timestamp
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: the event timestamp
Fixed Value: timestamp
....... value[x] SΣC 0..1 instant The instant this event occurred
...... part:eventFocus SΣ 0..1 BackboneElement Parameter containing the event focus
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: the event focus
Fixed Value: focus
....... value[x] SΣC 0..1 Reference() The focus of this event
...... part:eventAdditionalContext SΣ 0..* BackboneElement Parameter containing additional context for this event
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: additional context for this event
Fixed Value: additional-context
....... value[x] SΣC 0..1 Reference() Additional context for this event
.... parameter:error SΣC 0..* BackboneElement Parameter containing errors on the subscription
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: errors on the subscription
Fixed Value: error
..... value[x] SΣC 0..1 CodeableConcept An error on the subscription

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.parameter:status.​value[x] Base required SubscriptionStatus 📦4.0.1 FHIR Std.
Parameters.parameter:type.​value[x] Base required SubscriptionNotificationType 📦6.0.0-rc This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-1 error Parameters.parameter, Parameters.parameter:subscription, Parameters.parameter:topic, Parameters.parameter:status, Parameters.parameter:type, Parameters.parameter:eventsSinceSubscriptionStart, Parameters.parameter:notificationEvent, Parameters.parameter:error A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Parameter containing subscription status information
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... Slices for parameter 3..* BackboneElement Slices containing subscription status information
Slice: Unordered, Open by value:name
.... parameter:subscription S 1..1 BackboneElement Parameter containing the reference to a subscription
..... name 1..1 string Slice discriminator: the reference to a subscription
Fixed Value: subscription
..... value[x] S 1..1 Reference(Subscription) Reference to the Subscription responsible for this notification
.... parameter:topic S 0..1 BackboneElement Parameter containing the canonical reference to a subscription topic
..... name 1..1 string Slice discriminator: the canonical reference to a subscription topic
Fixed Value: topic
..... value[x] S 0..1 canonical() Canonical reference to the SubscriptionTopic this notification relates to
.... parameter:status S 1..1 BackboneElement Parameter containing the subscription status
..... name 1..1 string Slice discriminator: the subscription status
Fixed Value: status
..... value[x] S 1..1 code Status of the subscription when this notification was generated
Binding: SubscriptionStatus (required)
.... parameter:type S 1..1 BackboneElement Parameter containing the type of event for this notification
..... name 1..1 string Slice discriminator: the type of event for this notification
Fixed Value: type
..... value[x] S 1..1 code The type of event being conveyed with this notificaiton.
Binding: SubscriptionNotificationTypeVS (required)
.... parameter:eventsSinceSubscriptionStart S 0..1 BackboneElement Parameter containing the number of events since this subscription started
..... name 1..1 string Slice discriminator: the number of events since this subscription started
Fixed Value: events-since-subscription-start
..... value[x] S 0..1 string Events since the Subscription was created
.... parameter:notificationEvent S 0..* BackboneElement Parameter containing the event notification details
..... name 1..1 string Parameter containing notification event details
Fixed Value: notification-event
..... Slices for part S 1..* Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:eventNumber S 1..1 BackboneElement Parameter containing the event number
....... name 1..1 string Slice discriminator: the event number
Fixed Value: event-number
....... value[x] S 1..1 string Event number
...... part:eventTimestamp S 0..1 BackboneElement Parameter containing the event timestamp
....... name 1..1 string Slice discriminator: the event timestamp
Fixed Value: timestamp
....... value[x] S 0..1 instant The instant this event occurred
...... part:eventFocus S 0..1 BackboneElement Parameter containing the event focus
....... name 1..1 string Slice discriminator: the event focus
Fixed Value: focus
....... value[x] S 0..1 Reference() The focus of this event
...... part:eventAdditionalContext S 0..* BackboneElement Parameter containing additional context for this event
....... name 1..1 string Slice discriminator: additional context for this event
Fixed Value: additional-context
....... value[x] S 0..1 Reference() Additional context for this event
.... parameter:error S 0..* BackboneElement Parameter containing errors on the subscription
..... name 1..1 string Slice discriminator: errors on the subscription
Fixed Value: error
..... value[x] S 0..1 CodeableConcept An error on the subscription

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Parameters.parameter:status.​value[x] Base required SubscriptionStatus 📦4.0.1 FHIR Std.
Parameters.parameter:type.​value[x] Base required SubscriptionNotificationType 📦6.0.0-rc This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Parameter containing subscription status information
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 3..* BackboneElement Slices containing subscription status information
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:subscription SΣC 1..1 BackboneElement Parameter containing the reference to a subscription
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the reference to a subscription
Fixed Value: subscription
..... value[x] SΣC 1..1 Reference(Subscription) Reference to the Subscription responsible for this notification
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:topic SΣC 0..1 BackboneElement Parameter containing the canonical reference to a subscription topic
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the canonical reference to a subscription topic
Fixed Value: topic
..... value[x] SΣC 0..1 canonical() Canonical reference to the SubscriptionTopic this notification relates to
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:status SΣC 1..1 BackboneElement Parameter containing the subscription status
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the subscription status
Fixed Value: status
..... value[x] SΣC 1..1 code Status of the subscription when this notification was generated
Binding: SubscriptionStatus (required)
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:type SΣC 1..1 BackboneElement Parameter containing the type of event for this notification
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the type of event for this notification
Fixed Value: type
..... value[x] SΣC 1..1 code The type of event being conveyed with this notificaiton.
Binding: SubscriptionNotificationTypeVS (required)
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:eventsSinceSubscriptionStart SΣC 0..1 BackboneElement Parameter containing the number of events since this subscription started
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: the number of events since this subscription started
Fixed Value: events-since-subscription-start
..... value[x] SΣC 0..1 string Events since the Subscription was created
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:notificationEvent SΣC 0..* BackboneElement Parameter containing the event notification details
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Parameter containing notification event details
Fixed Value: notification-event
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If 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:All Slices Content/Rules for all slices
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
....... value[x] ΣC 0..1 If parameter is a data type
........ valueBase64Binary base64Binary
........ valueBoolean boolean
........ valueCanonical canonical(Any)
........ valueCode code
........ valueDate date
........ valueDateTime dateTime
........ valueDecimal decimal
........ valueId id
........ valueInstant instant
........ valueInteger integer
........ valueMarkdown markdown
........ valueOid oid
........ valuePositiveInt positiveInt
........ valueString string
........ valueTime time
........ valueUnsignedInt unsignedInt
........ valueUri uri
........ valueUrl url
........ valueUuid uuid
........ valueAddress Address
........ valueAge Age
........ valueAnnotation Annotation
........ valueAttachment Attachment
........ valueCodeableConcept CodeableConcept
........ valueCoding Coding
........ valueContactPoint ContactPoint
........ valueCount Count
........ valueDistance Distance
........ valueDuration Duration
........ valueHumanName HumanName
........ valueIdentifier Identifier
........ valueMoney Money
........ valuePeriod Period
........ valueQuantity Quantity
........ valueRange Range
........ valueRatio Ratio
........ valueReference Reference(Any)
........ valueSampledData SampledData
........ valueSignature Signature
........ valueTiming Timing
........ valueContactDetail ContactDetail
........ valueContributor Contributor
........ valueDataRequirement DataRequirement
........ valueExpression Expression
........ valueParameterDefinition ParameterDefinition
........ valueRelatedArtifact RelatedArtifact
........ valueTriggerDefinition TriggerDefinition
........ valueUsageContext UsageContext
........ valueDosage Dosage
........ valueMeta Meta
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:eventNumber SΣ 1..1 BackboneElement Parameter containing the event number
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: the event number
Fixed Value: event-number
....... value[x] SΣC 1..1 string Event number
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:eventTimestamp SΣ 0..1 BackboneElement Parameter containing the event timestamp
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: the event timestamp
Fixed Value: timestamp
....... value[x] SΣC 0..1 instant The instant this event occurred
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:eventFocus SΣ 0..1 BackboneElement Parameter containing the event focus
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: the event focus
Fixed Value: focus
....... value[x] SΣC 0..1 Reference() The focus of this event
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:eventAdditionalContext SΣ 0..* BackboneElement Parameter containing additional context for this event
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Slice discriminator: additional context for this event
Fixed Value: additional-context
....... value[x] SΣC 0..1 Reference() Additional context for this event
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:error SΣC 0..* BackboneElement Parameter containing errors on the subscription
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Slice discriminator: errors on the subscription
Fixed Value: error
..... value[x] SΣC 0..1 CodeableConcept An error on the subscription
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Parameters.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Parameters.parameter:status.​value[x] Base required SubscriptionStatus 📦4.0.1 FHIR Std.
Parameters.parameter:type.​value[x] Base required SubscriptionNotificationType 📦6.0.0-rc This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-1 error Parameters.parameter, Parameters.parameter:subscription, Parameters.parameter:topic, Parameters.parameter:status, Parameters.parameter:type, Parameters.parameter:eventsSinceSubscriptionStart, Parameters.parameter:notificationEvent, Parameters.parameter:error A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Summary

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

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron