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:
- an actor (“lowest schedulable unit for subscriber”)
- 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 PST 2018 as a active by Argonaut Project.
This profile builds on Schedule
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Schedule | 0..* | |||
 actor | S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | |
  reference | S | 1..1 | string | |
| planningHorizon | S | 1..1 | Period | |
 start | S | 1..1 | dateTime | |
| end | S | 1..1 | dateTime | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Schedule | I | 0..* | A container for slots of time that may be available for booking appointments | |
 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 |
| identifier | Σ | 0..* | Identifier | External Ids for this item |
| active | ?!Σ | 0..1 | boolean | Whether this schedule is in active use |
| serviceCategory | Σ | 0..1 | CodeableConcept | A broad categorisation of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
| serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
| specialty | Σ | 0..* | CodeableConcept | The 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..1 | Reference(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..1 | string | xml:id (or equivalent in JSON) | |
| reference | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| planningHorizon | SΣ | 1..1 | Period | The 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..1 | string | xml:id (or equivalent in JSON) | |
| start | SΣI | 1..1 | dateTime | Starting time with inclusive boundary |
| end | SΣI | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
| comment | 0..1 | string | Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated | |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Schedule | 0..* | |||
| actor | S | 1..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | |
| reference | S | 1..1 | string | |
| planningHorizon | S | 1..1 | Period | |
| start | S | 1..1 | dateTime | |
| end | S | 1..1 | dateTime | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Schedule | I | 0..* | A container for slots of time that may be available for booking appointments | |
| 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 |
| identifier | Σ | 0..* | Identifier | External Ids for this item |
| active | ?!Σ | 0..1 | boolean | Whether this schedule is in active use |
| serviceCategory | Σ | 0..1 | CodeableConcept | A broad categorisation of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
| serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
| specialty | Σ | 0..* | CodeableConcept | The 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..1 | Reference(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..1 | string | xml:id (or equivalent in JSON) | |
| reference | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| planningHorizon | SΣ | 1..1 | Period | The 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..1 | string | xml:id (or equivalent in JSON) | |
| start | SΣI | 1..1 | dateTime | Starting time with inclusive boundary |
| end | SΣI | 1..1 | dateTime | End time with inclusive boundary, if not ongoing |
| comment | 0..1 | string | Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated | |
| 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:
- Poll for Updated Slots on of the search requirements.
