Subscriptions R5 Backport
0.1.0 - ballot

Subscriptions R5 Backport, published by HL7 FHIR Infrastructure WG. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/fhir-subscription-backport-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Backported R5 Subscription Notification Status

Defining URL:http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscriptionstatus
Version:0.1.0
Name:BackportSubscriptionStatus
Title:Backported R5 Subscription Notification Status
Status:Active as of 2021-07-26T20:50:10+00:00
Definition:

Profile on the Parameters resource to enable R5-style topic-based subscription notifications in FHIR R4.

Publisher:HL7 FHIR Infrastructure WG
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscriptionstatus

Formal Views of Profile Content

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

This structure is derived from Parameters

Summary

Mandatory: 5 elements (3 nested mandatory elements)
Must-Support: 14 elements
Fixed Value: 7 elements

Slices

This structure defines the following Slices:

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

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter 3..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:subscription S1..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: subscription
..... value[x] S1..1Reference(Subscription)If parameter is a data type
.... parameter:topic S1..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: topic
..... value[x] S0..1canonical()If parameter is a data type
.... parameter:status S0..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: status
..... value[x] S1..1codeIf parameter is a data type
Binding: SubscriptionStatus (required)
.... parameter:type S1..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: type
..... value[x] S1..1codeIf parameter is a data type
Binding: R5 Subscription Notification Type Value Set (required)
.... parameter:eventsSinceSubscriptionStart S0..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: events-since-subscription-start
..... value[x] S1..1unsignedIntIf parameter is a data type
.... parameter:eventsInNotification S0..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: events-in-notification
..... value[x] S0..1unsignedIntIf parameter is a data type
.... parameter:error S0..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: error
..... value[x] S1..1CodeableConceptIf parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣI3..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
..... value[x] ΣI0..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 ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:subscription SΣI1..1BackboneElementOperation Parameter
..... 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
Fixed Value: subscription
..... value[x] SΣI1..1Reference(Subscription)If parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:topic SΣI1..1BackboneElementOperation Parameter
..... 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
Fixed Value: topic
..... value[x] SΣI0..1canonical()If parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:status SΣI0..1BackboneElementOperation Parameter
..... 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
Fixed Value: status
..... value[x] SΣI1..1codeIf parameter is a data type
Binding: SubscriptionStatus (required)
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:type SΣI1..1BackboneElementOperation Parameter
..... 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
Fixed Value: type
..... value[x] SΣI1..1codeIf parameter is a data type
Binding: R5 Subscription Notification Type Value Set (required)
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:eventsSinceSubscriptionStart SΣI0..1BackboneElementOperation Parameter
..... 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
Fixed Value: events-since-subscription-start
..... value[x] SΣI1..1unsignedIntIf parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:eventsInNotification SΣI0..1BackboneElementOperation Parameter
..... 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
Fixed Value: events-in-notification
..... value[x] SΣI0..1unsignedIntIf parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:error SΣI0..1BackboneElementOperation Parameter
..... 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
Fixed Value: error
..... value[x] SΣI1..1CodeableConceptIf parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... parameter:subscription ΣI1..1BackboneElementOperation Parameter
.... value[x] ΣI1..1Reference(Subscription)If parameter is a data type
... parameter:topic ΣI1..1BackboneElementOperation Parameter
.... value[x] ΣI0..1canonical()If parameter is a data type
... parameter:status ΣI0..1BackboneElementOperation Parameter
.... value[x] ΣI1..1codeIf parameter is a data type
Binding: SubscriptionStatus (required)
.... value[x] ΣI1..1codeIf parameter is a data type
Binding: R5 Subscription Notification Type Value Set (required)
... parameter:eventsSinceSubscriptionStart ΣI0..1BackboneElementOperation Parameter
.... value[x] ΣI1..1unsignedIntIf parameter is a data type
... parameter:eventsInNotification ΣI0..1BackboneElementOperation Parameter
.... value[x] ΣI0..1unsignedIntIf parameter is a data type
... parameter:error ΣI0..1BackboneElementOperation Parameter
.... value[x] ΣI1..1CodeableConceptIf parameter is a data type

doco Documentation for this format

This structure is derived from Parameters

Summary

Mandatory: 5 elements (3 nested mandatory elements)
Must-Support: 14 elements
Fixed Value: 7 elements

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter 3..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:subscription S1..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: subscription
..... value[x] S1..1Reference(Subscription)If parameter is a data type
.... parameter:topic S1..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: topic
..... value[x] S0..1canonical()If parameter is a data type
.... parameter:status S0..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: status
..... value[x] S1..1codeIf parameter is a data type
Binding: SubscriptionStatus (required)
.... parameter:type S1..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: type
..... value[x] S1..1codeIf parameter is a data type
Binding: R5 Subscription Notification Type Value Set (required)
.... parameter:eventsSinceSubscriptionStart S0..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: events-since-subscription-start
..... value[x] S1..1unsignedIntIf parameter is a data type
.... parameter:eventsInNotification S0..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: events-in-notification
..... value[x] S0..1unsignedIntIf parameter is a data type
.... parameter:error S0..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: error
..... value[x] S1..1CodeableConceptIf parameter is a data type

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣI3..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
..... value[x] ΣI0..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 ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:subscription SΣI1..1BackboneElementOperation Parameter
..... 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
Fixed Value: subscription
..... value[x] SΣI1..1Reference(Subscription)If parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:topic SΣI1..1BackboneElementOperation Parameter
..... 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
Fixed Value: topic
..... value[x] SΣI0..1canonical()If parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:status SΣI0..1BackboneElementOperation Parameter
..... 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
Fixed Value: status
..... value[x] SΣI1..1codeIf parameter is a data type
Binding: SubscriptionStatus (required)
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:type SΣI1..1BackboneElementOperation Parameter
..... 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
Fixed Value: type
..... value[x] SΣI1..1codeIf parameter is a data type
Binding: R5 Subscription Notification Type Value Set (required)
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:eventsSinceSubscriptionStart SΣI0..1BackboneElementOperation Parameter
..... 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
Fixed Value: events-since-subscription-start
..... value[x] SΣI1..1unsignedIntIf parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:eventsInNotification SΣI0..1BackboneElementOperation Parameter
..... 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
Fixed Value: events-in-notification
..... value[x] SΣI0..1unsignedIntIf parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:error SΣI0..1BackboneElementOperation Parameter
..... 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
Fixed Value: error
..... value[x] SΣI1..1CodeableConceptIf parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Max Binding: AllLanguages
Parameters.parameter:status.value[x]requiredSubscriptionStatus
Parameters.parameter:type.value[x]requiredBackportNotificationTypeValueSet