Argo-Scheduling

SD.8 StructureDefinition-argo-sub-notif

The Argonaut Scheduling Subscription Profile is defined for sending notifications to a subscriber as described in the updating slots step in Use Case 3 Prefetching Open Slots. This profile identifies which core elements, extensions, vocabularies and fixed values SHALL be present in the resource when using this profile.

Mandatory Data Elements

Each Subscription must have:

Trigger event description(s)
A Trigger event focus on Schedule
A notification endpoint
A notification payload profile of Argonaut Scheduling Schedule Notification Profile

Additional Profile specific implementation guidance:

The Trigger Event Description, fhirPath Expression, Trigger Event Focus, and Notification Payload Profile are all FHIR extensions defined for this Profile.
The Subscription’s criteria is based upon the Slot resource triggering events.
The Trigger Event Description extension SHALL contain natural language description for the following triggers:
1. Slots that are open to prefetching have a change of status
2. Slots that are open to prefetching have a change of visit type
3. Slots that were previously open to prefetching are no longer open to prefetching
and MAY include additional triggers.
The Trigger Event Description extension may also include a formal expression such as SQL or a reference to a named expression. A FHIRPath expression may be represented using the fhirPath Expression extension.
The Server is not obligated to implement the formal expressions if present and may use their own business logic to evaluate the changes defined in the event descriptions.
The Notification Payload Profile extension defines subscription’s notification payload as the Schedule instance that the triggering Slot references in the schedule element.
A “hearbeat” notification should be sent with a site specific frequency and should not contain a payload.
Example 1

SD.8.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-sub-notif

Published on Tue Feb 13 00:00:00 PST 2018 as a active by Argonaut Project.

This profile builds on Subscription

Summary

Mandatory: 6 elements
Must-Support: 8 elements
Fixed Value: 2 elements

Extensions

This structure refers to these extensions:

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*
criteria	S	1..1	string
extension-subscription-triggerevent	S	1..*	string	Subscription Trigger Event Description Extension URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-triggerevent
cqif-fhirPathExpression		0..*	string	Subscription Trigger Event FHIRPath Extension URL: http://hl7.org/fhir/StructureDefinition/cqif-fhirPathExpression
extension-subscription-eventfocus	S	1..*	code	Subscription Event Focus Extension URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-eventfocus Binding: FHIRAllTypes (required)
valueCode	S	1..1	code	Fixed Value: Slot
channel	S	1..1	BackboneElement
extension-subscription-payloadprofile	S	1..*	uri	Subscription Payload Profile Extension URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-payloadprofile
valueUri	S	1..1	uri	Payload profile URI Fixed Value: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-sched-notif
endpoint	S	1..1	uri
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Subscription	I	0..*		A 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: Common Languages (extensible)
text	I	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)
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	Rule for server push criteria
id		0..1	string	xml:id (or equivalent in JSON)
extension-subscription-triggerevent	SI	1..*	string	Subscription Trigger Event Description Extension URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-triggerevent
cqif-fhirPathExpression	I	0..*	string	Subscription Trigger Event FHIRPath Extension URL: http://hl7.org/fhir/StructureDefinition/cqif-fhirPathExpression
extension-subscription-eventfocus	SI	1..*	code	Subscription Event Focus Extension URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-eventfocus Binding: FHIRAllTypes (required)
id		0..1	string	xml:id (or equivalent in JSON)
url		1..1	uri	"http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-eventfocus"
valueCode	S	1..1	code	Value of extension Binding: FHIRAllTypes (required) Fixed Value: Slot
value		0..1		Primitive value for string Max Length: 1048576
error	Σ	0..1	string	Latest error note
channel	SΣI	1..1	BackboneElement	The channel on which to report matches to the criteria
id		0..1	string	xml:id (or equivalent in JSON)
extension-subscription-payloadprofile	SI	1..*	uri	Extension URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-payloadprofile
id		0..1	string	xml:id (or equivalent in JSON)
url		1..1	uri	"http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-payloadprofile"
valueUri	S	1..1	uri	Payload profile URI Fixed Value: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-sched-notif
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	code	rest-hook \| websocket \| email \| sms \| message Binding: SubscriptionChannelType (required)
endpoint	SΣ	1..1	uri	Where the channel points to
payload	Σ	0..1	string	Mimetype to send, or omit for no payload
header	Σ	0..*	string	Usage depends on the channel type
tag	Σ	0..*	Coding	A tag to add to matching resources Binding: SubscriptionTag (example)
Documentation for this format

Summary

Mandatory: 6 elements
Must-Support: 8 elements
Fixed Value: 2 elements

Extensions

This structure refers to these extensions:

Differential View

Name	Flags	Card.	Type	Description & Constraints
Subscription		0..*
criteria	S	1..1	string
extension-subscription-triggerevent	S	1..*	string	Subscription Trigger Event Description Extension URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-triggerevent
cqif-fhirPathExpression		0..*	string	Subscription Trigger Event FHIRPath Extension URL: http://hl7.org/fhir/StructureDefinition/cqif-fhirPathExpression
extension-subscription-eventfocus	S	1..*	code	Subscription Event Focus Extension URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-eventfocus Binding: FHIRAllTypes (required)
valueCode	S	1..1	code	Fixed Value: Slot
channel	S	1..1	BackboneElement
extension-subscription-payloadprofile	S	1..*	uri	Subscription Payload Profile Extension URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-payloadprofile
valueUri	S	1..1	uri	Payload profile URI Fixed Value: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-sched-notif
endpoint	S	1..1	uri
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Subscription	I	0..*		A 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: Common Languages (extensible)
text	I	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)
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	Rule for server push criteria
id		0..1	string	xml:id (or equivalent in JSON)
extension-subscription-triggerevent	SI	1..*	string	Subscription Trigger Event Description Extension URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-triggerevent
cqif-fhirPathExpression	I	0..*	string	Subscription Trigger Event FHIRPath Extension URL: http://hl7.org/fhir/StructureDefinition/cqif-fhirPathExpression
extension-subscription-eventfocus	SI	1..*	code	Subscription Event Focus Extension URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-eventfocus Binding: FHIRAllTypes (required)
id		0..1	string	xml:id (or equivalent in JSON)
url		1..1	uri	"http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-eventfocus"
valueCode	S	1..1	code	Value of extension Binding: FHIRAllTypes (required) Fixed Value: Slot
value		0..1		Primitive value for string Max Length: 1048576
error	Σ	0..1	string	Latest error note
channel	SΣI	1..1	BackboneElement	The channel on which to report matches to the criteria
id		0..1	string	xml:id (or equivalent in JSON)
extension-subscription-payloadprofile	SI	1..*	uri	Extension URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-payloadprofile
id		0..1	string	xml:id (or equivalent in JSON)
url		1..1	uri	"http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-payloadprofile"
valueUri	S	1..1	uri	Payload profile URI Fixed Value: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-sched-notif
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	code	rest-hook \| websocket \| email \| sms \| message Binding: SubscriptionChannelType (required)
endpoint	SΣ	1..1	uri	Where the channel points to
payload	Σ	0..1	string	Mimetype to send, or omit for no payload
header	Σ	0..*	string	Usage depends on the channel type
tag	Σ	0..*	Coding	A tag to add to matching resources Binding: SubscriptionTag (example)
Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

SD.8.2 Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

Patient based Scheduling:

Subscribe for Schedule Change Notifications