Subscriptions R5 Backport, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.2.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-subscription-backport-ig/ and changes regularly. See the Directory of published versions

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

Resource Profile: R4/B Topic-Based Subscription

Profile on the Subscription resource to enable R5-style topic-based subscriptions in FHIR R4 or R4B.

Usage:

• Examples for this Resource Profile: Subscription/subscription-admission, Subscription/subscription-multi-resource and Subscription/subscription-zulip

Formal Views of Profile Content

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

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

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier		0..*	Identifier	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier
criteria	S	1..1	string	Canonical URL for the topic used to generate events
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
filterCriteria	SΣ	0..*	string	Filtering critiera applied to events URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
channel
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
maxCount		0..1	positiveInt	Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
type
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
customChannelType	SΣ	0..1	Coding	Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
payload		1..1	code	MIME type to send, or omit for no payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
content	SΣ	1..1	code	Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier		0..*	Identifier	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatusCodes (required): The status of a subscription.
reason	Σ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	Canonical URL for the topic used to generate events
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
filterCriteria	SΣ	0..*	string	Filtering critiera applied to events URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
maxCount		0..1	positiveInt	Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
customChannelType	SΣ	0..1	Coding	Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
payload	Σ	1..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
content	SΣ	1..1	code	Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Subscription.status	required	SubscriptionStatusCodes http://hl7.org/fhir/ValueSet/subscription-status|4.3.0 from the FHIR Standard
Subscription.channel.type	required	SubscriptionChannelType http://hl7.org/fhir/ValueSet/subscription-channel-type|4.3.0 from the FHIR Standard
Subscription.channel.payload	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.3.0 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
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
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier		0..*	Identifier	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatusCodes (required): The status of a subscription.
contact	Σ	0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
end	Σ	0..1	instant	When to automatically delete the subscription
reason	Σ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	Canonical URL for the topic used to generate events
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
filterCriteria	SΣ	0..*	string	Filtering critiera applied to events URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
value		0..1	string	Primitive value for string Max Length: 1048576
error	Σ	0..1	string	Latest error note
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
maxCount		0..1	positiveInt	Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
customChannelType	SΣ	0..1	Coding	Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
value		0..1	code	Primitive value for code
endpoint	Σ	0..1	url	Where the channel points to
payload	Σ	1..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
content	SΣ	1..1	code	Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required)
value		0..1	code	Primitive value for code
header	Σ	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Subscription.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Subscription.status	required	SubscriptionStatusCodes http://hl7.org/fhir/ValueSet/subscription-status|4.3.0 from the FHIR Standard
Subscription.channel.type	required	SubscriptionChannelType http://hl7.org/fhir/ValueSet/subscription-channel-type|4.3.0 from the FHIR Standard
Subscription.channel.payload	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.3.0 from the FHIR Standard

This structure is derived from Subscription

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content

Differential View

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier		0..*	Identifier	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier
criteria	S	1..1	string	Canonical URL for the topic used to generate events
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
filterCriteria	SΣ	0..*	string	Filtering critiera applied to events URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
channel
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
maxCount		0..1	positiveInt	Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
type
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
customChannelType	SΣ	0..1	Coding	Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
payload		1..1	code	MIME type to send, or omit for no payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
content	SΣ	1..1	code	Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required)
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier		0..*	Identifier	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatusCodes (required): The status of a subscription.
reason	Σ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	Canonical URL for the topic used to generate events
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
filterCriteria	SΣ	0..*	string	Filtering critiera applied to events URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
maxCount		0..1	positiveInt	Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
customChannelType	SΣ	0..1	Coding	Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
payload	Σ	1..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
content	SΣ	1..1	code	Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Subscription.status	required	SubscriptionStatusCodes http://hl7.org/fhir/ValueSet/subscription-status|4.3.0 from the FHIR Standard
Subscription.channel.type	required	SubscriptionChannelType http://hl7.org/fhir/ValueSet/subscription-channel-type|4.3.0 from the FHIR Standard
Subscription.channel.payload	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.3.0 from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
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
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier		0..*	Identifier	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatusCodes (required): The status of a subscription.
contact	Σ	0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
end	Σ	0..1	instant	When to automatically delete the subscription
reason	Σ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	Canonical URL for the topic used to generate events
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
filterCriteria	SΣ	0..*	string	Filtering critiera applied to events URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
value		0..1	string	Primitive value for string Max Length: 1048576
error	Σ	0..1	string	Latest error note
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
maxCount		0..1	positiveInt	Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
customChannelType	SΣ	0..1	Coding	Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
value		0..1	code	Primitive value for code
endpoint	Σ	0..1	url	Where the channel points to
payload	Σ	1..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
content	SΣ	1..1	code	Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required)
value		0..1	code	Primitive value for code
header	Σ	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Subscription.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Subscription.status	required	SubscriptionStatusCodes http://hl7.org/fhir/ValueSet/subscription-status|4.3.0 from the FHIR Standard
Subscription.channel.type	required	SubscriptionChannelType http://hl7.org/fhir/ValueSet/subscription-channel-type|4.3.0 from the FHIR Standard
Subscription.channel.payload	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.3.0 from the FHIR Standard

This structure is derived from Subscription

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/5.0/StructureDefinition/extension-Subscription.identifier
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content

Other representations of profile: CSV, Excel, Schematron