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.2 StructureDefinition-prefetch-slot

This profile sets the minimum expectations for the Slot resource to record, search and fetch basic information about an individual slot when prefetching slots. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

This profile is defined for:

  • Use in the Bundle resource as a result of the prefetch ‘initial load’ and polling update interactions.

Mandatory Data Elements

Each Slot must have:

  1. an id
  2. a status
  3. a location or practitioner schedule
  4. a start and end time

The system Must Support if available:

  1. a visit type
  2. comments to describe any extended information

Additional Profile specific implementation guidance:

  • For additional implementation or site specific context os constraints (For example qualification on visit types such as age restrictions for well child visits.) use Slot.comment. The example below demonstrates is usage.

Examples

SD.2.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/prefetch-slot

Published on Wed Jan 10 00:00:00 AEDT 2018 as a active by Argonaut Project.

This profile builds on Slot

Summary

Mandatory: 1 element
Must-Support: 7 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot I0..*A slot of time on a schedule that may be available for booking appointments
... id SΣ1..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
... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType SΣ0..*CodeableConceptThe type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource
Binding: Argonaut_Visit_Types (extensible)
... 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)
... appointmentType Σ0..1CodeableConceptThe style of appointment or patient that may be booked in the slot (not service type)
Binding: v2 Appointment reason codes (preferred)
... schedule SΣ1..1Reference(Schedule)The schedule resource that this slot defines an interval of status information
... status SΣ1..1codebusy | free | busy-unavailable | entered-in-error
Binding: Argonaut_Slot_Status_Codes (required)
... start SΣ1..1instantDate/Time that the slot is to begin
... end SΣ1..1instantDate/Time that the slot is to conclude
... overbooked 0..1booleanThis slot has already been overbooked, appointments are unlikely to be accepted for this time
... comment S0..1stringComments on the slot to describe any extended information. Such as custom constraints on the slot

doco Documentation for this format

Summary

Mandatory: 1 element
Must-Support: 7 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot I0..*A slot of time on a schedule that may be available for booking appointments
... id SΣ1..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
... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType SΣ0..*CodeableConceptThe type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource
Binding: Argonaut_Visit_Types (extensible)
... 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)
... appointmentType Σ0..1CodeableConceptThe style of appointment or patient that may be booked in the slot (not service type)
Binding: v2 Appointment reason codes (preferred)
... schedule SΣ1..1Reference(Schedule)The schedule resource that this slot defines an interval of status information
... status SΣ1..1codebusy | free | busy-unavailable | entered-in-error
Binding: Argonaut_Slot_Status_Codes (required)
... start SΣ1..1instantDate/Time that the slot is to begin
... end SΣ1..1instantDate/Time that the slot is to conclude
... overbooked 0..1booleanThis slot has already been overbooked, appointments are unlikely to be accepted for this time
... comment S0..1stringComments on the slot to describe any extended information. Such as custom constraints on the slot

doco Documentation for this format

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

 

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