Scalable Consent Management, published by HL7 International / Community Based Collaborative Care. This guide is not an authorized publication; it is the continuous build for version 1.0.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-consent-management/ and changes regularly. See the Directory of published versions

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

Resource Profile: FASTSubscription

A profile for FAST subscriptions.

Usages:

• Examples for this Profile: Subscription/FASTOrganizationSubscriptionExample and Subscription/FASTPatientSubscriptionExample
• CapabilityStatements using this Profile: Consent Server Capabilities and Consent Client Capabilities

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
Subscription		0..*	BackportSubscription	Server push subscription criteria
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (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 Required Pattern: http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic
Slices for extension				Content/Rules for all slices
extension: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				Content/Rules for all slices
extension:heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
extension:timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
extension: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. Required Pattern: rest-hook
Slices for extension				Content/Rules for all slices
extension: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
extension: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	Status	Usage	ValueSet	Version	Source
Subscription.status	Base	required	SubscriptionStatus	📍4.0.1 → 4.0.0	FHIR Std.
Subscription.channel.​type	Base	required	SubscriptionChannelType	📍4.0.1 → 4.0.0	FHIR Std.
Subscription.channel.​payload	Base	required	MimeType	📍4.0.1 → 4.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	BackportSubscription	Server push subscription criteria
criteria		1..1	string	Canonical URL for the topic used to generate events Required Pattern: http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic
channel
type		1..1	code	rest-hook | websocket | email | sms | message Required Pattern: rest-hook
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	BackportSubscription	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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources Constraints: dom-r4b
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (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 Required Pattern: http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension: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
extension:heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
extension:timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
extension: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. Required Pattern: rest-hook
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension: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
extension: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	Status	Usage	ValueSet	Version	Source
Subscription.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Subscription.status	Base	required	SubscriptionStatus	📍4.0.1 → 4.0.0	FHIR Std.
Subscription.channel.​type	Base	required	SubscriptionChannelType	📍4.0.1 → 4.0.0	FHIR Std.
Subscription.channel.​payload	Base	required	MimeType	📍4.0.1 → 4.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

Summary

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	BackportSubscription	Server push subscription criteria
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (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 Required Pattern: http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic
Slices for extension				Content/Rules for all slices
extension: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				Content/Rules for all slices
extension:heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
extension:timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
extension: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. Required Pattern: rest-hook
Slices for extension				Content/Rules for all slices
extension: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
extension: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	Status	Usage	ValueSet	Version	Source
Subscription.status	Base	required	SubscriptionStatus	📍4.0.1 → 4.0.0	FHIR Std.
Subscription.channel.​type	Base	required	SubscriptionChannelType	📍4.0.1 → 4.0.0	FHIR Std.
Subscription.channel.​payload	Base	required	MimeType	📍4.0.1 → 4.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

Differential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	BackportSubscription	Server push subscription criteria
criteria		1..1	string	Canonical URL for the topic used to generate events Required Pattern: http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic
channel
type		1..1	code	rest-hook | websocket | email | sms | message Required Pattern: rest-hook
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Subscription		0..*	BackportSubscription	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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources Constraints: dom-r4b
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (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 Required Pattern: http://hl7.org/fhir/us/consent-management/SubscriptionTopic/FASTConsentSubscriptionTopic
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension: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
extension:heartbeatPeriod		0..1	unsignedInt	Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
extension:timeout		0..1	unsignedInt	Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
extension: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. Required Pattern: rest-hook
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension: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
extension: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	Status	Usage	ValueSet	Version	Source
Subscription.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Subscription.status	Base	required	SubscriptionStatus	📍4.0.1 → 4.0.0	FHIR Std.
Subscription.channel.​type	Base	required	SubscriptionChannelType	📍4.0.1 → 4.0.0	FHIR Std.
Subscription.channel.​payload	Base	required	MimeType	📍4.0.1 → 4.0.0	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

Summary

Maturity: 1

Other representations of profile: CSV, Excel, Schematron