Argo-Scheduling Implementation Guide Release 1.0.0

This page is part of the Argonaut Scheduling Implementation Guide (v1.0.0: Release) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

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:

  1. Trigger event description(s)
  2. A Trigger event focus on Schedule
  3. A notification endpoint
  4. 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 AEDT 2018 as a active by Argonaut Project.

This profile builds on Subscription

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription I0..*A server push subscription criteria
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatus (required)
... contact Σ0..*ContactPointContact details for source (e.g. troubleshooting)
... end Σ0..1instantWhen to automatically delete the subscription
... reason Σ1..1stringDescription of why this subscription was created
... criteria SΣ1..1stringRule for server push criteria
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension-subscription-triggerevent SI1..*stringSubscription Trigger Event Description Extension
URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-triggerevent
.... cqif-fhirPathExpression I0..*stringSubscription Trigger Event FHIRPath Extension
URL: http://hl7.org/fhir/StructureDefinition/cqif-fhirPathExpression
.... extension-subscription-eventfocus SI1..*codeSubscription Event Focus Extension
URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-eventfocus
Binding: FHIRAllTypes (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-eventfocus"
..... valueCode S1..1codeValue of extension
Binding: FHIRAllTypes (required)
Fixed Value: Slot
.... value 0..1Primitive value for string
Max Length: 1048576
... error Σ0..1stringLatest error note
... channel SΣI1..1BackboneElementThe channel on which to report matches to the criteria
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension-subscription-payloadprofile SI1..*uriExtension
URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-payloadprofile
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-payloadprofile"
..... valueUri S1..1uriPayload profile URI
Fixed Value: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-sched-notif
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required)
.... endpoint SΣ1..1uriWhere the channel points to
.... payload Σ0..1stringMimetype to send, or omit for no payload
.... header Σ0..*stringUsage depends on the channel type
... tag Σ0..*CodingA tag to add to matching resources
Binding: SubscriptionTag (example)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription I0..*A server push subscription criteria
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatus (required)
... contact Σ0..*ContactPointContact details for source (e.g. troubleshooting)
... end Σ0..1instantWhen to automatically delete the subscription
... reason Σ1..1stringDescription of why this subscription was created
... criteria SΣ1..1stringRule for server push criteria
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension-subscription-triggerevent SI1..*stringSubscription Trigger Event Description Extension
URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-triggerevent
.... cqif-fhirPathExpression I0..*stringSubscription Trigger Event FHIRPath Extension
URL: http://hl7.org/fhir/StructureDefinition/cqif-fhirPathExpression
.... extension-subscription-eventfocus SI1..*codeSubscription Event Focus Extension
URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-eventfocus
Binding: FHIRAllTypes (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-eventfocus"
..... valueCode S1..1codeValue of extension
Binding: FHIRAllTypes (required)
Fixed Value: Slot
.... value 0..1Primitive value for string
Max Length: 1048576
... error Σ0..1stringLatest error note
... channel SΣI1..1BackboneElementThe channel on which to report matches to the criteria
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension-subscription-payloadprofile SI1..*uriExtension
URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-payloadprofile
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-subscription-payloadprofile"
..... valueUri S1..1uriPayload profile URI
Fixed Value: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-sched-notif
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required)
.... endpoint SΣ1..1uriWhere the channel points to
.... payload Σ0..1stringMimetype to send, or omit for no payload
.... header Σ0..*stringUsage depends on the channel type
... tag Σ0..*CodingA tag to add to matching resources
Binding: SubscriptionTag (example)

doco 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: