FHIR Orders Exchange (FOE) / Post-Acute Orders (PAO) / (DME-Orders), published by HL7. This is not an authorized publication; it is the continuous build for version 0.2.2). This version is based on the current content of https://github.com/HL7/dme-orders/ and changes regularly. See the Directory of published versions

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

Resource Profile: PAO Subscription Profile

PAO Subscription Resource Profile The subscription resource should accompany the initial message bundle to provide a mechanism of informing the ordering provider when there is a change in the order as indicated by a change in the Task resorurce. The subscriber has the option of receiving a notifiction when a change occurs or receiving the updated task and any relevant order resources (device, service, medication)

Purpose

Usage:

• Examples for this Resource Profile: Subscription/Home-Health-Task

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	S	1..1	code	requested | active | error | off
reason	S	1..1	string	Description of why this subscription was created
criteria	S	1..1	string	Rule for server push
channel	S	1..1	BackboneElement	The channel on which to report matches to the criteria
type	S	1..1	code	rest-hook | websocket | email | sms | message
endpoint	S	0..1	url	Where the channel points to
payload	S	0..1	code	MIME type to send, or omit for no payload
header	S	0..*	string	Usage depends on the channel type
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription.
reason	SΣ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	Rule for server push
channel	SΣ	1..1	BackboneElement	The channel on which to report matches to the criteria
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SΣ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
endpoint	SΣ	0..1	url	Where the channel points to
payload	SΣ	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.
header	SΣ	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Subscription.status	required	SubscriptionStatus
Subscription.channel.type	required	SubscriptionChannelType
Subscription.channel.payload	required	Mime Types (a valid code from urn:ietf:bcp:13)

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Subscription	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Subscription	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Subscription	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Subscription	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Subscription	A resource should have narrative for robust management : text.`div`.exists()
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()

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	?!SΣ	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	SΣ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	Rule for server push
error	Σ	0..1	string	Latest error note
channel	SΣ	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	SΣ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
endpoint	SΣ	0..1	url	Where the channel points to
payload	SΣ	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.
header	SΣ	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Subscription.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Subscription.status	required	SubscriptionStatus
Subscription.channel.type	required	SubscriptionChannelType
Subscription.channel.payload	required	Mime Types (a valid code from urn:ietf:bcp:13)

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Subscription

Summary

Must-Support: 8 elements

Differential View

This structure is derived from Subscription

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*	Subscription	Server push subscription criteria
status	S	1..1	code	requested | active | error | off
reason	S	1..1	string	Description of why this subscription was created
criteria	S	1..1	string	Rule for server push
channel	S	1..1	BackboneElement	The channel on which to report matches to the criteria
type	S	1..1	code	rest-hook | websocket | email | sms | message
endpoint	S	0..1	url	Where the channel points to
payload	S	0..1	code	MIME type to send, or omit for no payload
header	S	0..*	string	Usage depends on the channel type
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription.
reason	SΣ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	Rule for server push
channel	SΣ	1..1	BackboneElement	The channel on which to report matches to the criteria
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SΣ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
endpoint	SΣ	0..1	url	Where the channel points to
payload	SΣ	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.
header	SΣ	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Subscription.status	required	SubscriptionStatus
Subscription.channel.type	required	SubscriptionChannelType
Subscription.channel.payload	required	Mime Types (a valid code from urn:ietf:bcp:13)

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Subscription	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Subscription	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Subscription	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Subscription	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Subscription	A resource should have narrative for robust management : text.`div`.exists()
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()

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	?!SΣ	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	SΣ	1..1	string	Description of why this subscription was created
criteria	SΣ	1..1	string	Rule for server push
error	Σ	0..1	string	Latest error note
channel	SΣ	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	SΣ	1..1	code	rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.
endpoint	SΣ	0..1	url	Where the channel points to
payload	SΣ	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.
header	SΣ	0..*	string	Usage depends on the channel type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Subscription.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Subscription.status	required	SubscriptionStatus
Subscription.channel.type	required	SubscriptionChannelType
Subscription.channel.payload	required	Mime Types (a valid code from urn:ietf:bcp:13)

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Subscription

Summary

Must-Support: 8 elements

Other representations of profile: CSV, Excel, Schematron

Notes: