This page is part of the Da Vinci Prior Authorization Support (PAS) FHIR IG (v2.1.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Resource Profile: PAS Subscription

The profile for PAS subscription.

Usage:

• Examples for this Resource Profile: Subscription/PASSubscriptionExample

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
status		1..1	code	requested | active | error | off Required Pattern: active
criteria		1..1	string	Rule for server push Required Pattern: http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
filterCriteria	S	1..1	string	Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
channel
type		1..1	code	rest-hook | websocket | email | sms | message Required Pattern: rest-hook
payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
payloadContent	S	1..1	(Complex)	Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Slices for value[x]				Content/Rules for all slices
value[x]:valueCode		0..1	code	Value of extension Required Pattern: full-resource
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. ele-1: All FHIR elements must have a @value or children Required Pattern: active
reason	Σ	1..1	string	Description of why this subscription was created ele-1: All FHIR elements must have a @value or children
criteria	Σ	1..1	string	Rule for server push ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
filterCriteria	S	1..1	string	Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria 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
type	Σ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. ele-1: All FHIR elements must have a @value or children Required Pattern: rest-hook
payload	Σ	0..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
payloadContent	S	1..1	(Complex)	Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content"
Slices for value[x]		0..1	code	Notification content level Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
value[x]:valueCode		0..1	code	Value of extension Binding: Backported R5 Subscription Content Value Set (required) ele-1: All FHIR elements must have a @value or children Required Pattern: full-resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Subscription.status	required	Pattern: active http://hl7.org/fhir/ValueSet/subscription-status|4.0.1 from the FHIR Standard
Subscription.channel.type	required	Pattern: rest-hook http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 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.0.1 from the FHIR Standard
Subscription.channel.payload.extension:payloadContent.value[x]:valueCode	required	Pattern: full-resource http://hl7.org/fhir/uv/subscriptions-backport/ValueSet/backport-content-value-set

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): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
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. Required Pattern: active
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	Σ	1..1	string	Rule for server push Required Pattern: http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
filterCriteria	S	1..1	string	Backported R5 FilterBy Criteria 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
extension		0..*	Extension	Additional content defined by implementations
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
endpoint	Σ	0..1	url	Where the channel points to
payload	Σ	0..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
payloadContent	S	1..1	(Complex)	Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content"
Slices for value[x]		0..1	code	Notification content level Slice: Unordered, Closed by type:$this
value[x]:valueCode		0..1	code	Value of extension Binding: Backported R5 Subscription Content Value Set (required) Required Pattern: full-resource
value		0..1	string	Primitive value for code
header	Σ	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Subscription.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Subscription.status	required	Pattern: active http://hl7.org/fhir/ValueSet/subscription-status|4.0.1 from the FHIR Standard
Subscription.channel.type	required	Pattern: rest-hook http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 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.0.1 from the FHIR Standard
Subscription.channel.payload.extension:payloadContent.value[x]:valueCode	required	Pattern: full-resource http://hl7.org/fhir/uv/subscriptions-backport/ValueSet/backport-content-value-set

This structure is derived from Subscription

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content

Maturity: 3

Differential View

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
status		1..1	code	requested | active | error | off Required Pattern: active
criteria		1..1	string	Rule for server push Required Pattern: http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
filterCriteria	S	1..1	string	Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
channel
type		1..1	code	rest-hook | websocket | email | sms | message Required Pattern: rest-hook
payload
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
payloadContent	S	1..1	(Complex)	Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Slices for value[x]				Content/Rules for all slices
value[x]:valueCode		0..1	code	Value of extension Required Pattern: full-resource
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. ele-1: All FHIR elements must have a @value or children Required Pattern: active
reason	Σ	1..1	string	Description of why this subscription was created ele-1: All FHIR elements must have a @value or children
criteria	Σ	1..1	string	Rule for server push ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
filterCriteria	S	1..1	string	Backported R5 FilterBy Criteria URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
channel	Σ	1..1	BackboneElement	The channel on which to report matches to the criteria 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
type	Σ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. ele-1: All FHIR elements must have a @value or children Required Pattern: rest-hook
payload	Σ	0..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
payloadContent	S	1..1	(Complex)	Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content"
Slices for value[x]		0..1	code	Notification content level Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
value[x]:valueCode		0..1	code	Value of extension Binding: Backported R5 Subscription Content Value Set (required) ele-1: All FHIR elements must have a @value or children Required Pattern: full-resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Subscription.status	required	Pattern: active http://hl7.org/fhir/ValueSet/subscription-status|4.0.1 from the FHIR Standard
Subscription.channel.type	required	Pattern: rest-hook http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 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.0.1 from the FHIR Standard
Subscription.channel.payload.extension:payloadContent.value[x]:valueCode	required	Pattern: full-resource http://hl7.org/fhir/uv/subscriptions-backport/ValueSet/backport-content-value-set

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): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
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. Required Pattern: active
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	Σ	1..1	string	Rule for server push Required Pattern: http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
filterCriteria	S	1..1	string	Backported R5 FilterBy Criteria 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
extension		0..*	Extension	Additional content defined by implementations
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
endpoint	Σ	0..1	url	Where the channel points to
payload	Σ	0..1	code	MIME type to send, or omit for no payload Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
payloadContent	S	1..1	(Complex)	Backport R5 Subscription Payload Content Information URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content"
Slices for value[x]		0..1	code	Notification content level Slice: Unordered, Closed by type:$this
value[x]:valueCode		0..1	code	Value of extension Binding: Backported R5 Subscription Content Value Set (required) Required Pattern: full-resource
value		0..1	string	Primitive value for code
header	Σ	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Subscription.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Subscription.status	required	Pattern: active http://hl7.org/fhir/ValueSet/subscription-status|4.0.1 from the FHIR Standard
Subscription.channel.type	required	Pattern: rest-hook http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.1 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.0.1 from the FHIR Standard
Subscription.channel.payload.extension:payloadContent.value[x]:valueCode	required	Pattern: full-resource http://hl7.org/fhir/uv/subscriptions-backport/ValueSet/backport-content-value-set

This structure is derived from Subscription

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
• http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content

Maturity: 3

Other representations of profile: CSV, Excel, Schematron