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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: SubscriptionStatus for the $events operation

Profile on the SubscriptionStatus resource for the $events operation

Usage:

• Use this Resource Profile: Bundle response for $events
• Examples for this Resource Profile: Parameters/ex-SubscriptionStatus-EventsOperation

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from BackportSubscriptionStatusR4

Name	Flags	Card.	Type	Description & Constraints
Parameters			BackportSubscriptionStatusR4
parameter		4..*	BackboneElement	Slices containing subscription status information
parameter:status		1..1	BackboneElement	recommended. SHOULD be valued with the current status of the relevant subscription
parameter:type		1..1	BackboneElement	Parameter containing the type of event for this notification
value[x]		1..1	code	The type of event being conveyed with this notificaiton. Required Pattern: query-event
parameter:eventsSinceSubscriptionStart		0..1	BackboneElement	Parameter containing the number of events since this subscription started
value[x]		0..1	string	recommended. This value is allows clients to know if they are missing notifications. Note: this value SHALL NOT be incremented by sending a query-event bundle.
parameter:notificationEvent		1..*	BackboneElement	Parameter containing the event notification details
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	BackportSubscriptionStatusR4	Parameter containing subscription status information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for parameter	ΣC	4..*	BackboneElement	Slices 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..*	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 inv-1: A parameter must have one and only one of (value, resource, part)
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 inv-1: A parameter must have one and only one of (value, resource, part)
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	recommended. SHOULD be valued with the current status of the relevant subscription inv-1: A parameter must have one and only one of (value, resource, part)
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 inv-1: A parameter must have one and only one of (value, resource, part)
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: subscription-notification-type (required) Required Pattern: query-event
parameter:eventsSinceSubscriptionStart	SΣC	0..1	BackboneElement	Parameter containing the number of events since this subscription started inv-1: A parameter must have one and only one of (value, resource, part)
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	recommended. This value is allows clients to know if they are missing notifications. Note: this value SHALL NOT be incremented by sending a query-event bundle.
parameter:notificationEvent	SΣC	1..*	BackboneElement	Parameter containing the event notification details inv-1: A parameter must have one and only one of (value, resource, part)
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: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 inv-1: A parameter must have one and only one of (value, resource, part)
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Parameters.parameter:status.value[x]	required	SubscriptionStatus http://hl7.org/fhir/ValueSet/subscription-status from the FHIR Standard
Parameters.parameter:type.value[x]	required	Pattern: query-event http://hl7.org/fhir/ValueSet/subscription-notification-type

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	BackportSubscriptionStatusR4	Parameter containing subscription status information
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
Slices for parameter	ΣC	4..*	BackboneElement	Slices 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..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 inv-1: A parameter must have one and only one of (value, resource, part)
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 inv-1: A parameter must have one and only one of (value, resource, part)
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	recommended. SHOULD be valued with the current status of the relevant subscription inv-1: A parameter must have one and only one of (value, resource, part)
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 inv-1: A parameter must have one and only one of (value, resource, part)
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: subscription-notification-type (required) Required Pattern: query-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:eventsSinceSubscriptionStart	SΣC	0..1	BackboneElement	Parameter containing the number of events since this subscription started inv-1: A parameter must have one and only one of (value, resource, part)
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	recommended. This value is allows clients to know if they are missing notifications. Note: this value SHALL NOT be incremented by sending a query-event bundle.
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	1..*	BackboneElement	Parameter containing the event notification details inv-1: A parameter must have one and only one of (value, resource, part)
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: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 inv-1: A parameter must have one and only one of (value, resource, part)
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Parameters.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Parameters.parameter:status.value[x]	required	SubscriptionStatus http://hl7.org/fhir/ValueSet/subscription-status from the FHIR Standard
Parameters.parameter:type.value[x]	required	Pattern: query-event http://hl7.org/fhir/ValueSet/subscription-notification-type

This structure is derived from BackportSubscriptionStatusR4

Summary

Mandatory: 1 element

Differential View

This structure is derived from BackportSubscriptionStatusR4

Name	Flags	Card.	Type	Description & Constraints
Parameters			BackportSubscriptionStatusR4
parameter		4..*	BackboneElement	Slices containing subscription status information
parameter:status		1..1	BackboneElement	recommended. SHOULD be valued with the current status of the relevant subscription
parameter:type		1..1	BackboneElement	Parameter containing the type of event for this notification
value[x]		1..1	code	The type of event being conveyed with this notificaiton. Required Pattern: query-event
parameter:eventsSinceSubscriptionStart		0..1	BackboneElement	Parameter containing the number of events since this subscription started
value[x]		0..1	string	recommended. This value is allows clients to know if they are missing notifications. Note: this value SHALL NOT be incremented by sending a query-event bundle.
parameter:notificationEvent		1..*	BackboneElement	Parameter containing the event notification details
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	BackportSubscriptionStatusR4	Parameter containing subscription status information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for parameter	ΣC	4..*	BackboneElement	Slices 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..*	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 inv-1: A parameter must have one and only one of (value, resource, part)
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 inv-1: A parameter must have one and only one of (value, resource, part)
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	recommended. SHOULD be valued with the current status of the relevant subscription inv-1: A parameter must have one and only one of (value, resource, part)
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 inv-1: A parameter must have one and only one of (value, resource, part)
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: subscription-notification-type (required) Required Pattern: query-event
parameter:eventsSinceSubscriptionStart	SΣC	0..1	BackboneElement	Parameter containing the number of events since this subscription started inv-1: A parameter must have one and only one of (value, resource, part)
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	recommended. This value is allows clients to know if they are missing notifications. Note: this value SHALL NOT be incremented by sending a query-event bundle.
parameter:notificationEvent	SΣC	1..*	BackboneElement	Parameter containing the event notification details inv-1: A parameter must have one and only one of (value, resource, part)
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: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 inv-1: A parameter must have one and only one of (value, resource, part)
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Parameters.parameter:status.value[x]	required	SubscriptionStatus http://hl7.org/fhir/ValueSet/subscription-status from the FHIR Standard
Parameters.parameter:type.value[x]	required	Pattern: query-event http://hl7.org/fhir/ValueSet/subscription-notification-type

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	BackportSubscriptionStatusR4	Parameter containing subscription status information
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
Slices for parameter	ΣC	4..*	BackboneElement	Slices 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..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 inv-1: A parameter must have one and only one of (value, resource, part)
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 inv-1: A parameter must have one and only one of (value, resource, part)
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	recommended. SHOULD be valued with the current status of the relevant subscription inv-1: A parameter must have one and only one of (value, resource, part)
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 inv-1: A parameter must have one and only one of (value, resource, part)
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: subscription-notification-type (required) Required Pattern: query-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:eventsSinceSubscriptionStart	SΣC	0..1	BackboneElement	Parameter containing the number of events since this subscription started inv-1: A parameter must have one and only one of (value, resource, part)
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	recommended. This value is allows clients to know if they are missing notifications. Note: this value SHALL NOT be incremented by sending a query-event bundle.
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	1..*	BackboneElement	Parameter containing the event notification details inv-1: A parameter must have one and only one of (value, resource, part)
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: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 inv-1: A parameter must have one and only one of (value, resource, part)
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Parameters.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Parameters.parameter:status.value[x]	required	SubscriptionStatus http://hl7.org/fhir/ValueSet/subscription-status from the FHIR Standard
Parameters.parameter:type.value[x]	required	Pattern: query-event http://hl7.org/fhir/ValueSet/subscription-notification-type

This structure is derived from BackportSubscriptionStatusR4

Summary

Mandatory: 1 element