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. For a full list of available versions, see the Directory of published versions

SD.9 StructureDefinition-argo-sched-notif

The Argonaut Schedule Notification Profile is defined for use as the payload when sending notifications to a subscriber as described in the updating slots step in Use Case 3 Prefetching Open Slots. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Mandatory Data Elements

Each Slot must have:

  1. an actor (“lowest schedulable unit for subscriber”)
  2. a date range (preferably a single day)

Additional Profile specific implementation guidance:

  • None

Examples

SD.9.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-sched-notif

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

This profile builds on Schedule

Summary

Mandatory: 5 elements
Must-Support: 5 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule I0..*A container for slots of time that may be available for booking appointments
... 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
... identifier Σ0..*IdentifierExternal Ids for this item
... active ?!Σ0..1booleanWhether this schedule is in active use
... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Practice Setting Code Value Set (preferred)
... actor SΣ1..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson
.... id 0..1stringxml:id (or equivalent in JSON)
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... planningHorizon SΣ1..1PeriodThe period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates
.... id 0..1stringxml:id (or equivalent in JSON)
.... start SΣI1..1dateTimeStarting time with inclusive boundary
.... end SΣI1..1dateTimeEnd time with inclusive boundary, if not ongoing
... comment 0..1stringComments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated

doco Documentation for this format

Summary

Mandatory: 5 elements
Must-Support: 5 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Schedule I0..*A container for slots of time that may be available for booking appointments
... 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
... identifier Σ0..*IdentifierExternal Ids for this item
... active ?!Σ0..1booleanWhether this schedule is in active use
... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Practice Setting Code Value Set (preferred)
... actor SΣ1..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson
.... id 0..1stringxml:id (or equivalent in JSON)
.... reference SΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... planningHorizon SΣ1..1PeriodThe period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates
.... id 0..1stringxml:id (or equivalent in JSON)
.... start SΣI1..1dateTimeStarting time with inclusive boundary
.... end SΣI1..1dateTimeEnd time with inclusive boundary, if not ongoing
... comment 0..1stringComments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated

doco Documentation for this format

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

 

SD.9.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: