This page is part of the Clinical Order Workflows (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

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

Resource Profile: COW Subscription Status

Minimum expectations for a SubscriptionStatus resource when used for Clinical Order Workflow. This profile is used to describe the use of administrative (pre-coordinated) subscription notifications for RESTful-based exchange between the Placer and the Fulfiller. The purpose of the constraints for the SubscriptionStatus resource is to make sure that additional requirements, which may be relevant to a particular implementation or national/regional implementation guides, are compatible with the RESTful-based exchange patterns.

Usage:

• Use this Resource Profile: COW Subscription Notification
• Examples for this Resource Profile: Parameters/cow-notification-status-example

Formal Views of Profile Content

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

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

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 ele-1: All FHIR elements must have a @value or children
Slices for parameter	ΣC	3..*	BackboneElement	Slices containing subscription status information Slice: Unordered, Open by value:name ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children
parameter:subscription	SΣC	1..1	BackboneElement	Parameter containing the reference to a subscription ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the reference to a subscription ele-1: All FHIR elements must have a @value or children Fixed Value: subscription
value[x]	SΣC	1..1	Reference(Subscription)	Reference to the Subscription responsible for this notification ele-1: All FHIR elements must have a @value or children
identifier	SΣ	1..1	Identifier	Reference to the Subscription responsible for this notification. Logical reference is the only one supported ele-1: All FHIR elements must have a @value or children
parameter:topic	SΣC	0..1	BackboneElement	Parameter containing the canonical reference to a subscription topic ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the canonical reference to a subscription topic ele-1: All FHIR elements must have a @value or children Fixed Value: topic
value[x]	SΣC	0..1	canonical()	Canonical reference to the SubscriptionTopic this notification relates to ele-1: All FHIR elements must have a @value or children
parameter:status	SΣC	1..1	BackboneElement	Parameter containing the subscription status ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the subscription status ele-1: All FHIR elements must have a @value or children Fixed Value: status
value[x]	SΣC	1..1	code	Status of the subscription when this notification was generated Binding: SubscriptionStatus (required) ele-1: All FHIR elements must have a @value or children
parameter:type	SΣC	1..1	BackboneElement	Parameter containing the type of event for this notification ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the type of event for this notification ele-1: All FHIR elements must have a @value or children Fixed Value: type
value[x]	SΣC	1..1	code	The type of event being conveyed with this notificaiton. Binding: Order Notification Status Type (required) ele-1: All FHIR elements must have a @value or children
parameter:eventsSinceSubscriptionStart	SΣC	0..1	BackboneElement	Parameter containing the number of events since this subscription started ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the number of events since this subscription started ele-1: All FHIR elements must have a @value or children Fixed Value: events-since-subscription-start
value[x]	SΣC	0..1	string	Events since the Subscription was created ele-1: All FHIR elements must have a @value or children
parameter:notificationEvent	SΣC	0..*	BackboneElement	Parameter containing the event notification details ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Parameter containing notification event details ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children
part:eventNumber	SΣ	1..1	BackboneElement	Parameter containing the event number ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the event number ele-1: All FHIR elements must have a @value or children Fixed Value: event-number
value[x]	SΣC	1..1	string	Event number ele-1: All FHIR elements must have a @value or children
part:eventTimestamp	SΣ	0..1	BackboneElement	Parameter containing the event timestamp ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the event timestamp ele-1: All FHIR elements must have a @value or children Fixed Value: timestamp
value[x]	SΣC	0..1	instant	The instant this event occurred ele-1: All FHIR elements must have a @value or children
part:eventFocus	SΣ	0..1	BackboneElement	Parameter pointing to the task which is the event focus ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the event focus ele-1: All FHIR elements must have a @value or children Fixed Value: focus
value[x]	SΣC	1..1	Reference(Coordination Task)	The focus of this event ele-1: All FHIR elements must have a @value or children
part:eventAdditionalContext	SΣ	0..*	BackboneElement	Parameter containing additional context for this event ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: additional context for this event ele-1: All FHIR elements must have a @value or children Fixed Value: additional-context
value[x]	SΣC	0..1	Reference()	Additional context for this event ele-1: All FHIR elements must have a @value or children
parameter:error	SΣC	0..*	BackboneElement	Parameter containing errors on the subscription ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: errors on the subscription ele-1: All FHIR elements must have a @value or children Fixed Value: error
value[x]	SΣC	0..1	CodeableConcept	An error on the subscription ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	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	OrderNotificationStatusType (a valid code from Subscription Notification Type) http://hl7.org/fhir/uv/cow/ValueSet/order-notification-status-type from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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 BackportSubscriptionStatusR4

Name	Flags	Card.	Type	Description & Constraints
Parameters			BackportSubscriptionStatusR4
Slices for parameter				Content/Rules for all slices
parameter:subscription		1..1	BackboneElement	Parameter containing the reference to a subscription
value[x]
identifier	S	1..1	Identifier	Reference to the Subscription responsible for this notification. Logical reference is the only one supported
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. Binding: Order Notification Status Type (required)
parameter:notificationEvent		0..*	BackboneElement	Parameter containing the event notification details
Slices for part				Content/Rules for all slices
part:eventFocus		0..1	BackboneElement	Parameter pointing to the task which is the event focus
value[x]		1..1	Reference(Coordination Task)	The focus of this event
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Parameters.parameter:type.value[x]	required	OrderNotificationStatusType (a valid code from Subscription Notification Type) http://hl7.org/fhir/uv/cow/ValueSet/order-notification-status-type from this IG

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	3..*	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Reference to the Subscription responsible for this notification. Logical reference is the only one supported
display	Σ	0..1	string	Text alternative for the resource
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	Parameter containing the subscription status 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: Order Notification Status Type (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 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	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 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 pointing to the task which is 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	1..1	Reference(Coordination Task)	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	URI
Parameters.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Parameters.parameter:subscription.value[x].type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types 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	OrderNotificationStatusType (a valid code from Subscription Notification Type) http://hl7.org/fhir/uv/cow/ValueSet/order-notification-status-type from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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 BackportSubscriptionStatusR4

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 1 element

Structures

This structure refers to these other structures:

• Coordination Task (http://hl7.org/fhir/uv/cow/StructureDefinition/coordination-task)

Maturity: 1

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 ele-1: All FHIR elements must have a @value or children
Slices for parameter	ΣC	3..*	BackboneElement	Slices containing subscription status information Slice: Unordered, Open by value:name ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Name from the definition ele-1: All FHIR elements must have a @value or children
parameter:subscription	SΣC	1..1	BackboneElement	Parameter containing the reference to a subscription ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the reference to a subscription ele-1: All FHIR elements must have a @value or children Fixed Value: subscription
value[x]	SΣC	1..1	Reference(Subscription)	Reference to the Subscription responsible for this notification ele-1: All FHIR elements must have a @value or children
identifier	SΣ	1..1	Identifier	Reference to the Subscription responsible for this notification. Logical reference is the only one supported ele-1: All FHIR elements must have a @value or children
parameter:topic	SΣC	0..1	BackboneElement	Parameter containing the canonical reference to a subscription topic ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the canonical reference to a subscription topic ele-1: All FHIR elements must have a @value or children Fixed Value: topic
value[x]	SΣC	0..1	canonical()	Canonical reference to the SubscriptionTopic this notification relates to ele-1: All FHIR elements must have a @value or children
parameter:status	SΣC	1..1	BackboneElement	Parameter containing the subscription status ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the subscription status ele-1: All FHIR elements must have a @value or children Fixed Value: status
value[x]	SΣC	1..1	code	Status of the subscription when this notification was generated Binding: SubscriptionStatus (required) ele-1: All FHIR elements must have a @value or children
parameter:type	SΣC	1..1	BackboneElement	Parameter containing the type of event for this notification ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the type of event for this notification ele-1: All FHIR elements must have a @value or children Fixed Value: type
value[x]	SΣC	1..1	code	The type of event being conveyed with this notificaiton. Binding: Order Notification Status Type (required) ele-1: All FHIR elements must have a @value or children
parameter:eventsSinceSubscriptionStart	SΣC	0..1	BackboneElement	Parameter containing the number of events since this subscription started ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the number of events since this subscription started ele-1: All FHIR elements must have a @value or children Fixed Value: events-since-subscription-start
value[x]	SΣC	0..1	string	Events since the Subscription was created ele-1: All FHIR elements must have a @value or children
parameter:notificationEvent	SΣC	0..*	BackboneElement	Parameter containing the event notification details ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Parameter containing notification event details ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children
part:eventNumber	SΣ	1..1	BackboneElement	Parameter containing the event number ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the event number ele-1: All FHIR elements must have a @value or children Fixed Value: event-number
value[x]	SΣC	1..1	string	Event number ele-1: All FHIR elements must have a @value or children
part:eventTimestamp	SΣ	0..1	BackboneElement	Parameter containing the event timestamp ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the event timestamp ele-1: All FHIR elements must have a @value or children Fixed Value: timestamp
value[x]	SΣC	0..1	instant	The instant this event occurred ele-1: All FHIR elements must have a @value or children
part:eventFocus	SΣ	0..1	BackboneElement	Parameter pointing to the task which is the event focus ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: the event focus ele-1: All FHIR elements must have a @value or children Fixed Value: focus
value[x]	SΣC	1..1	Reference(Coordination Task)	The focus of this event ele-1: All FHIR elements must have a @value or children
part:eventAdditionalContext	SΣ	0..*	BackboneElement	Parameter containing additional context for this event ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: additional context for this event ele-1: All FHIR elements must have a @value or children Fixed Value: additional-context
value[x]	SΣC	0..1	Reference()	Additional context for this event ele-1: All FHIR elements must have a @value or children
parameter:error	SΣC	0..*	BackboneElement	Parameter containing errors on the subscription ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	Σ	1..1	string	Slice discriminator: errors on the subscription ele-1: All FHIR elements must have a @value or children Fixed Value: error
value[x]	SΣC	0..1	CodeableConcept	An error on the subscription ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	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	OrderNotificationStatusType (a valid code from Subscription Notification Type) http://hl7.org/fhir/uv/cow/ValueSet/order-notification-status-type from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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 BackportSubscriptionStatusR4

Name	Flags	Card.	Type	Description & Constraints
Parameters			BackportSubscriptionStatusR4
Slices for parameter				Content/Rules for all slices
parameter:subscription		1..1	BackboneElement	Parameter containing the reference to a subscription
value[x]
identifier	S	1..1	Identifier	Reference to the Subscription responsible for this notification. Logical reference is the only one supported
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. Binding: Order Notification Status Type (required)
parameter:notificationEvent		0..*	BackboneElement	Parameter containing the event notification details
Slices for part				Content/Rules for all slices
part:eventFocus		0..1	BackboneElement	Parameter pointing to the task which is the event focus
value[x]		1..1	Reference(Coordination Task)	The focus of this event
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Parameters.parameter:type.value[x]	required	OrderNotificationStatusType (a valid code from Subscription Notification Type) http://hl7.org/fhir/uv/cow/ValueSet/order-notification-status-type from this IG

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	3..*	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Reference to the Subscription responsible for this notification. Logical reference is the only one supported
display	Σ	0..1	string	Text alternative for the resource
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	Parameter containing the subscription status 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: Order Notification Status Type (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 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	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 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 pointing to the task which is 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	1..1	Reference(Coordination Task)	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	URI
Parameters.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Parameters.parameter:subscription.value[x].type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types 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	OrderNotificationStatusType (a valid code from Subscription Notification Type) http://hl7.org/fhir/uv/cow/ValueSet/order-notification-status-type from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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 BackportSubscriptionStatusR4

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 1 element

Structures

This structure refers to these other structures:

• Coordination Task (http://hl7.org/fhir/uv/cow/StructureDefinition/coordination-task)

Maturity: 1