Clinical Order Workflows, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-cow-ig/ and changes regularly. See the Directory of published versions

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

Resource Profile: COW Subscription Notification

Usages:

• Examples for this Profile: Bundle/cow-notification-status-only-example

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	C	0..*	BackportSubscriptionNotificationR4	Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, backport-notification-bundle-r4-1
Bundle.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Bundle.type	Σ This element is included in summaries.	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: history
Bundle.Slices for entry	Σ This element is included in summaries. C	1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:All Slices				Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:subscriptionStatus	S This element must be supported. Σ This element is included in summaries. C	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:subscriptionStatus.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:subscriptionStatus.resource	S This element must be supported.	1..1	COWSubscriptionStatus	Parameter containing subscription status information
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.type	Base	required	BundleType	📍4.0.1 → 4.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
backport-notification-bundle-r4-1	error	Bundle	A notification bundle MUST have a Parameters as the first entry	(entry.first().resource.is(Parameters))
bdl-1	error	Bundle	total only when a search or history	total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search	entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited	entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited	entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry, Bundle.entry:subscriptionStatus	must be a resource unless there's a request or response	resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)	(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry, Bundle.entry:subscriptionStatus	fullUrl cannot be a version specific reference	fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value	type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date	type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource	type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource	type = 'message' implies entry.first().resource.is(MessageHeader)
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()

This structure is derived from BackportSubscriptionNotificationR4

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle		0..*	BackportSubscriptionNotificationR4	Contains a collection of resources
Bundle.Slices for entry				Content/Rules for all slices
Bundle.Slices for entry.entry:subscriptionStatus		1..1	BackboneElement	Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:subscriptionStatus.resource		1..1	COWSubscriptionStatus	Parameter containing subscription status information
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	C	0..*	BackportSubscriptionNotificationR4	Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, backport-notification-bundle-r4-1
Bundle.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Bundle.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Bundle.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Bundle.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
Bundle.identifier	Σ This element is included in summaries.	0..1	Identifier	Persistent identifier for the bundle
Bundle.type	Σ This element is included in summaries.	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: history
Bundle.timestamp	Σ This element is included in summaries.	0..1	instant	When the bundle was assembled
Bundle.total	Σ This element is included in summaries. C	0..1	unsignedInt	If search, the total number of matches
Bundle.link	Σ This element is included in summaries.	0..*	BackboneElement	Links related to this Bundle
Bundle.link.id		0..1	string	Unique id for inter-element referencing
Bundle.link.extension		0..*	Extension	Additional content defined by implementations
Bundle.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.link.relation	Σ This element is included in summaries.	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Bundle.link.url	Σ This element is included in summaries.	1..1	uri	Reference details for the link
Bundle.Slices for entry	Σ This element is included in summaries. C	1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:All Slices				Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.link	Σ This element is included in summaries.	0..*	See link (Bundle)	Links related to this entry
Bundle.Slices for entry.entry:All Slices.fullUrl	Σ This element is included in summaries.	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:All Slices.resource	Σ This element is included in summaries.	0..1	Resource	A resource in the bundle
Bundle.Slices for entry.entry:All Slices.search	Σ This element is included in summaries. C	0..1	BackboneElement	Search related information
Bundle.Slices for entry.entry:All Slices.search.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.search.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.search.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.search.mode	Σ This element is included in summaries.	0..1	code	match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Bundle.Slices for entry.entry:All Slices.search.score	Σ This element is included in summaries.	0..1	decimal	Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:All Slices.request	Σ This element is included in summaries. C	0..1	BackboneElement	Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.request.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.request.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.request.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.request.method	Σ This element is included in summaries.	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:All Slices.request.url	Σ This element is included in summaries.	1..1	uri	URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:All Slices.request.ifNoneMatch	Σ This element is included in summaries.	0..1	string	For managing cache currency
Bundle.Slices for entry.entry:All Slices.request.ifModifiedSince	Σ This element is included in summaries.	0..1	instant	For managing cache currency
Bundle.Slices for entry.entry:All Slices.request.ifMatch	Σ This element is included in summaries.	0..1	string	For managing update contention
Bundle.Slices for entry.entry:All Slices.request.ifNoneExist	Σ This element is included in summaries.	0..1	string	For conditional creates
Bundle.Slices for entry.entry:All Slices.response	Σ This element is included in summaries. C	0..1	BackboneElement	Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.response.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.response.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.response.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.response.status	Σ This element is included in summaries.	1..1	string	Status response code (text optional)
Bundle.Slices for entry.entry:All Slices.response.location	Σ This element is included in summaries.	0..1	uri	The location (if the operation returns a location)
Bundle.Slices for entry.entry:All Slices.response.etag	Σ This element is included in summaries.	0..1	string	The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:All Slices.response.lastModified	Σ This element is included in summaries.	0..1	instant	Server's date time modified
Bundle.Slices for entry.entry:All Slices.response.outcome	Σ This element is included in summaries.	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:subscriptionStatus	S This element must be supported. Σ This element is included in summaries. C	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:subscriptionStatus.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:subscriptionStatus.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:subscriptionStatus.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:subscriptionStatus.link	Σ This element is included in summaries.	0..*	See link (Bundle)	Links related to this entry
Bundle.Slices for entry.entry:subscriptionStatus.fullUrl	Σ This element is included in summaries.	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:subscriptionStatus.resource	S This element must be supported.	1..1	COWSubscriptionStatus	Parameter containing subscription status information
Bundle.Slices for entry.entry:subscriptionStatus.search	Σ This element is included in summaries. C	0..1	BackboneElement	Search related information
Bundle.Slices for entry.entry:subscriptionStatus.search.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:subscriptionStatus.search.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:subscriptionStatus.search.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:subscriptionStatus.search.mode	Σ This element is included in summaries.	0..1	code	match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Bundle.Slices for entry.entry:subscriptionStatus.search.score	Σ This element is included in summaries.	0..1	decimal	Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:subscriptionStatus.request	Σ This element is included in summaries. C	0..1	BackboneElement	Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:subscriptionStatus.request.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:subscriptionStatus.request.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:subscriptionStatus.request.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:subscriptionStatus.request.method	Σ This element is included in summaries.	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:subscriptionStatus.request.url	Σ This element is included in summaries.	1..1	uri	URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:subscriptionStatus.request.ifNoneMatch	Σ This element is included in summaries.	0..1	string	For managing cache currency
Bundle.Slices for entry.entry:subscriptionStatus.request.ifModifiedSince	Σ This element is included in summaries.	0..1	instant	For managing cache currency
Bundle.Slices for entry.entry:subscriptionStatus.request.ifMatch	Σ This element is included in summaries.	0..1	string	For managing update contention
Bundle.Slices for entry.entry:subscriptionStatus.request.ifNoneExist	Σ This element is included in summaries.	0..1	string	For conditional creates
Bundle.Slices for entry.entry:subscriptionStatus.response	Σ This element is included in summaries. C	0..1	BackboneElement	Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:subscriptionStatus.response.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:subscriptionStatus.response.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:subscriptionStatus.response.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:subscriptionStatus.response.status	Σ This element is included in summaries.	1..1	string	Status response code (text optional)
Bundle.Slices for entry.entry:subscriptionStatus.response.location	Σ This element is included in summaries.	0..1	uri	The location (if the operation returns a location)
Bundle.Slices for entry.entry:subscriptionStatus.response.etag	Σ This element is included in summaries.	0..1	string	The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:subscriptionStatus.response.lastModified	Σ This element is included in summaries.	0..1	instant	Server's date time modified
Bundle.Slices for entry.entry:subscriptionStatus.response.outcome	Σ This element is included in summaries.	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
Bundle.signature	Σ This element is included in summaries.	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Bundle.type	Base	required	BundleType	📍4.0.1 → 4.0.0	FHIR Std.
Bundle.entry.search.​mode	Base	required	SearchEntryMode	📍4.0.1 → 4.0.0	FHIR Std.
Bundle.entry.request.​method	Base	required	HTTPVerb	📍4.0.1 → 4.0.0	FHIR Std.
Bundle.entry:subscriptionStatus.​search.mode	Base	required	SearchEntryMode	📍4.0.1 → 4.0.0	FHIR Std.
Bundle.entry:subscriptionStatus.​request.method	Base	required	HTTPVerb	📍4.0.1 → 4.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
backport-notification-bundle-r4-1	error	Bundle	A notification bundle MUST have a Parameters as the first entry	(entry.first().resource.is(Parameters))
bdl-1	error	Bundle	total only when a search or history	total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search	entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited	entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited	entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry, Bundle.entry:subscriptionStatus	must be a resource unless there's a request or response	resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)	(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry, Bundle.entry:subscriptionStatus	fullUrl cannot be a version specific reference	fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value	type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date	type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource	type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource	type = 'message' implies entry.first().resource.is(MessageHeader)
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()

This structure is derived from BackportSubscriptionNotificationR4

Summary

Structures

This structure refers to these other structures:

• COW Subscription Status (http://hl7.org/fhir/uv/cow/StructureDefinition/cow-subscription-status)

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	C	0..*	BackportSubscriptionNotificationR4	Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, backport-notification-bundle-r4-1
Bundle.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Bundle.type	Σ This element is included in summaries.	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: history
Bundle.Slices for entry	Σ This element is included in summaries. C	1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:All Slices				Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:subscriptionStatus	S This element must be supported. Σ This element is included in summaries. C	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:subscriptionStatus.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:subscriptionStatus.resource	S This element must be supported.	1..1	COWSubscriptionStatus	Parameter containing subscription status information
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.type	Base	required	BundleType	📍4.0.1 → 4.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
backport-notification-bundle-r4-1	error	Bundle	A notification bundle MUST have a Parameters as the first entry	(entry.first().resource.is(Parameters))
bdl-1	error	Bundle	total only when a search or history	total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search	entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited	entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited	entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry, Bundle.entry:subscriptionStatus	must be a resource unless there's a request or response	resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)	(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry, Bundle.entry:subscriptionStatus	fullUrl cannot be a version specific reference	fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value	type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date	type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource	type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource	type = 'message' implies entry.first().resource.is(MessageHeader)
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()

Differential View

This structure is derived from BackportSubscriptionNotificationR4

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle		0..*	BackportSubscriptionNotificationR4	Contains a collection of resources
Bundle.Slices for entry				Content/Rules for all slices
Bundle.Slices for entry.entry:subscriptionStatus		1..1	BackboneElement	Entry in the bundle - will have a resource or information
Bundle.Slices for entry.entry:subscriptionStatus.resource		1..1	COWSubscriptionStatus	Parameter containing subscription status information
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Bundle	C	0..*	BackportSubscriptionNotificationR4	Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, backport-notification-bundle-r4-1
Bundle.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Bundle.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Bundle.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Bundle.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
Bundle.identifier	Σ This element is included in summaries.	0..1	Identifier	Persistent identifier for the bundle
Bundle.type	Σ This element is included in summaries.	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: history
Bundle.timestamp	Σ This element is included in summaries.	0..1	instant	When the bundle was assembled
Bundle.total	Σ This element is included in summaries. C	0..1	unsignedInt	If search, the total number of matches
Bundle.link	Σ This element is included in summaries.	0..*	BackboneElement	Links related to this Bundle
Bundle.link.id		0..1	string	Unique id for inter-element referencing
Bundle.link.extension		0..*	Extension	Additional content defined by implementations
Bundle.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.link.relation	Σ This element is included in summaries.	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Bundle.link.url	Σ This element is included in summaries.	1..1	uri	Reference details for the link
Bundle.Slices for entry	Σ This element is included in summaries. C	1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:All Slices				Content/Rules for all slices
Bundle.Slices for entry.entry:All Slices.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.link	Σ This element is included in summaries.	0..*	See link (Bundle)	Links related to this entry
Bundle.Slices for entry.entry:All Slices.fullUrl	Σ This element is included in summaries.	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:All Slices.resource	Σ This element is included in summaries.	0..1	Resource	A resource in the bundle
Bundle.Slices for entry.entry:All Slices.search	Σ This element is included in summaries. C	0..1	BackboneElement	Search related information
Bundle.Slices for entry.entry:All Slices.search.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.search.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.search.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.search.mode	Σ This element is included in summaries.	0..1	code	match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Bundle.Slices for entry.entry:All Slices.search.score	Σ This element is included in summaries.	0..1	decimal	Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:All Slices.request	Σ This element is included in summaries. C	0..1	BackboneElement	Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.request.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.request.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.request.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.request.method	Σ This element is included in summaries.	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:All Slices.request.url	Σ This element is included in summaries.	1..1	uri	URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:All Slices.request.ifNoneMatch	Σ This element is included in summaries.	0..1	string	For managing cache currency
Bundle.Slices for entry.entry:All Slices.request.ifModifiedSince	Σ This element is included in summaries.	0..1	instant	For managing cache currency
Bundle.Slices for entry.entry:All Slices.request.ifMatch	Σ This element is included in summaries.	0..1	string	For managing update contention
Bundle.Slices for entry.entry:All Slices.request.ifNoneExist	Σ This element is included in summaries.	0..1	string	For conditional creates
Bundle.Slices for entry.entry:All Slices.response	Σ This element is included in summaries. C	0..1	BackboneElement	Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:All Slices.response.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:All Slices.response.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:All Slices.response.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:All Slices.response.status	Σ This element is included in summaries.	1..1	string	Status response code (text optional)
Bundle.Slices for entry.entry:All Slices.response.location	Σ This element is included in summaries.	0..1	uri	The location (if the operation returns a location)
Bundle.Slices for entry.entry:All Slices.response.etag	Σ This element is included in summaries.	0..1	string	The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:All Slices.response.lastModified	Σ This element is included in summaries.	0..1	instant	Server's date time modified
Bundle.Slices for entry.entry:All Slices.response.outcome	Σ This element is included in summaries.	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
Bundle.Slices for entry.entry:subscriptionStatus	S This element must be supported. Σ This element is included in summaries. C	1..1	BackboneElement	Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
Bundle.Slices for entry.entry:subscriptionStatus.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:subscriptionStatus.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:subscriptionStatus.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:subscriptionStatus.link	Σ This element is included in summaries.	0..*	See link (Bundle)	Links related to this entry
Bundle.Slices for entry.entry:subscriptionStatus.fullUrl	Σ This element is included in summaries.	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
Bundle.Slices for entry.entry:subscriptionStatus.resource	S This element must be supported.	1..1	COWSubscriptionStatus	Parameter containing subscription status information
Bundle.Slices for entry.entry:subscriptionStatus.search	Σ This element is included in summaries. C	0..1	BackboneElement	Search related information
Bundle.Slices for entry.entry:subscriptionStatus.search.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:subscriptionStatus.search.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:subscriptionStatus.search.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:subscriptionStatus.search.mode	Σ This element is included in summaries.	0..1	code	match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
Bundle.Slices for entry.entry:subscriptionStatus.search.score	Σ This element is included in summaries.	0..1	decimal	Search ranking (between 0 and 1)
Bundle.Slices for entry.entry:subscriptionStatus.request	Σ This element is included in summaries. C	0..1	BackboneElement	Additional execution information (transaction/batch/history)
Bundle.Slices for entry.entry:subscriptionStatus.request.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:subscriptionStatus.request.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:subscriptionStatus.request.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:subscriptionStatus.request.method	Σ This element is included in summaries.	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
Bundle.Slices for entry.entry:subscriptionStatus.request.url	Σ This element is included in summaries.	1..1	uri	URL for HTTP equivalent of this entry
Bundle.Slices for entry.entry:subscriptionStatus.request.ifNoneMatch	Σ This element is included in summaries.	0..1	string	For managing cache currency
Bundle.Slices for entry.entry:subscriptionStatus.request.ifModifiedSince	Σ This element is included in summaries.	0..1	instant	For managing cache currency
Bundle.Slices for entry.entry:subscriptionStatus.request.ifMatch	Σ This element is included in summaries.	0..1	string	For managing update contention
Bundle.Slices for entry.entry:subscriptionStatus.request.ifNoneExist	Σ This element is included in summaries.	0..1	string	For conditional creates
Bundle.Slices for entry.entry:subscriptionStatus.response	Σ This element is included in summaries. C	0..1	BackboneElement	Results of execution (transaction/batch/history)
Bundle.Slices for entry.entry:subscriptionStatus.response.id		0..1	string	Unique id for inter-element referencing
Bundle.Slices for entry.entry:subscriptionStatus.response.extension		0..*	Extension	Additional content defined by implementations
Bundle.Slices for entry.entry:subscriptionStatus.response.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Bundle.Slices for entry.entry:subscriptionStatus.response.status	Σ This element is included in summaries.	1..1	string	Status response code (text optional)
Bundle.Slices for entry.entry:subscriptionStatus.response.location	Σ This element is included in summaries.	0..1	uri	The location (if the operation returns a location)
Bundle.Slices for entry.entry:subscriptionStatus.response.etag	Σ This element is included in summaries.	0..1	string	The Etag for the resource (if relevant)
Bundle.Slices for entry.entry:subscriptionStatus.response.lastModified	Σ This element is included in summaries.	0..1	instant	Server's date time modified
Bundle.Slices for entry.entry:subscriptionStatus.response.outcome	Σ This element is included in summaries.	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
Bundle.signature	Σ This element is included in summaries.	0..1	Signature	Digital Signature
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Bundle.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Bundle.type	Base	required	BundleType	📍4.0.1 → 4.0.0	FHIR Std.
Bundle.entry.search.​mode	Base	required	SearchEntryMode	📍4.0.1 → 4.0.0	FHIR Std.
Bundle.entry.request.​method	Base	required	HTTPVerb	📍4.0.1 → 4.0.0	FHIR Std.
Bundle.entry:subscriptionStatus.​search.mode	Base	required	SearchEntryMode	📍4.0.1 → 4.0.0	FHIR Std.
Bundle.entry:subscriptionStatus.​request.method	Base	required	HTTPVerb	📍4.0.1 → 4.0.0	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
backport-notification-bundle-r4-1	error	Bundle	A notification bundle MUST have a Parameters as the first entry	(entry.first().resource.is(Parameters))
bdl-1	error	Bundle	total only when a search or history	total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search	entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited	entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited	entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5	error	Bundle.entry, Bundle.entry:subscriptionStatus	must be a resource unless there's a request or response	resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)	(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8	error	Bundle.entry, Bundle.entry:subscriptionStatus	fullUrl cannot be a version specific reference	fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value	type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date	type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource	type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource	type = 'message' implies entry.first().resource.is(MessageHeader)
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()

This structure is derived from BackportSubscriptionNotificationR4

Summary

Structures

This structure refers to these other structures:

• COW Subscription Status (http://hl7.org/fhir/uv/cow/StructureDefinition/cow-subscription-status)

Maturity: 1

Other representations of profile: CSV, Excel, Schematron