Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

Resource Profile: UK Core Slot

Official URL: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Slot Version: 1.3.0
Active as of 2023-12-12 Computable Name: UKCoreSlot

Copyright/Legal: Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.

This profile defines the UK constraints and extensions on the International FHIR resource Slot.

Slot resources are used to provide time-slots that can be booked using an appointment. They do not provide any information about appointments that are available, just the time, and optionally what the time can be used for. These are effectively spaces of free/busy time. Slots can also be marked as busy without having appointments associated.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Slot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..* Slot A slot of time on a schedule that may be available for booking appointments
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... deliveryChannel 0..1 CodeableConcept This describes the delivery channel of a scheduled appointment.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel
Binding: UK Core Delivery Channel (extensible)
... specialty S 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment.
Binding: UK Core Practice Setting Code (extensible)
... appointmentType S 0..1 CodeableConcept The style of appointment or patient that may be booked in the slot.
... status S 1..1 code The status of the slot, e.g free, busy, etc.
... start S 1..1 instant Date/Time that the slot is to begin.
... end S 1..1 instant Date/Time that the slot is to conclude.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Slot.specialtyextensibleUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..* Slot A slot of time on a schedule that may be available for booking appointments
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... deliveryChannel 0..1 CodeableConcept This describes the delivery channel of a scheduled appointment.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel
Binding: UK Core Delivery Channel (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... appointmentType SΣ 0..1 CodeableConcept The style of appointment or patient that may be booked in the slot.
Binding: hl7VS-appointmentReasonCodes (preferred)
... schedule SΣ 1..1 Reference(Schedule) A reference to the Schedule that this Slot is an interval of.
... status SΣ 1..1 code The status of the slot, e.g free, busy, etc.
Binding: SlotStatus (required): The free/busy status of the slot.

... start SΣ 1..1 instant Date/Time that the slot is to begin.
... end SΣ 1..1 instant Date/Time that the slot is to conclude.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Slot.specialtyextensibleUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG
Slot.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Slot.statusrequiredSlotStatus
http://hl7.org/fhir/ValueSet/slotstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSlotIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSlotIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSlotIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSlotIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSlotA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..* Slot A slot of time on a schedule 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... deliveryChannel 0..1 CodeableConcept This describes the delivery channel of a scheduled appointment.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel
Binding: UK Core Delivery Channel (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableConcept The 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: ServiceType (example)
... specialty SΣ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment.
Binding: UK Core Practice Setting Code (extensible)
... appointmentType SΣ 0..1 CodeableConcept The style of appointment or patient that may be booked in the slot.
Binding: hl7VS-appointmentReasonCodes (preferred)
... schedule SΣ 1..1 Reference(Schedule) A reference to the Schedule that this Slot is an interval of.
... status SΣ 1..1 code The status of the slot, e.g free, busy, etc.
Binding: SlotStatus (required): The free/busy status of the slot.

... start SΣ 1..1 instant Date/Time that the slot is to begin.
... end SΣ 1..1 instant Date/Time that the slot is to conclude.
... overbooked 0..1 boolean This slot has already been overbooked, appointments are unlikely to be accepted for this time
... comment 0..1 string Comments on the slot to describe any extended information. Such as custom constraints on the slot

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Slot.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Slot.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Slot.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Slot.specialtyextensibleUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG
Slot.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Slot.statusrequiredSlotStatus
http://hl7.org/fhir/ValueSet/slotstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSlotIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSlotIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSlotIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSlotIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSlotA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Slot

Summary

Must-Support: 6 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Slot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..* Slot A slot of time on a schedule that may be available for booking appointments
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... deliveryChannel 0..1 CodeableConcept This describes the delivery channel of a scheduled appointment.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel
Binding: UK Core Delivery Channel (extensible)
... specialty S 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment.
Binding: UK Core Practice Setting Code (extensible)
... appointmentType S 0..1 CodeableConcept The style of appointment or patient that may be booked in the slot.
... status S 1..1 code The status of the slot, e.g free, busy, etc.
... start S 1..1 instant Date/Time that the slot is to begin.
... end S 1..1 instant Date/Time that the slot is to conclude.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Slot.specialtyextensibleUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..* Slot A slot of time on a schedule that may be available for booking appointments
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... deliveryChannel 0..1 CodeableConcept This describes the delivery channel of a scheduled appointment.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel
Binding: UK Core Delivery Channel (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... appointmentType SΣ 0..1 CodeableConcept The style of appointment or patient that may be booked in the slot.
Binding: hl7VS-appointmentReasonCodes (preferred)
... schedule SΣ 1..1 Reference(Schedule) A reference to the Schedule that this Slot is an interval of.
... status SΣ 1..1 code The status of the slot, e.g free, busy, etc.
Binding: SlotStatus (required): The free/busy status of the slot.

... start SΣ 1..1 instant Date/Time that the slot is to begin.
... end SΣ 1..1 instant Date/Time that the slot is to conclude.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Slot.specialtyextensibleUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG
Slot.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Slot.statusrequiredSlotStatus
http://hl7.org/fhir/ValueSet/slotstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSlotIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSlotIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSlotIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSlotIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSlotA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Slot 0..* Slot A slot of time on a schedule 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... deliveryChannel 0..1 CodeableConcept This describes the delivery channel of a scheduled appointment.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel
Binding: UK Core Delivery Channel (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableConcept The 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: ServiceType (example)
... specialty SΣ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment.
Binding: UK Core Practice Setting Code (extensible)
... appointmentType SΣ 0..1 CodeableConcept The style of appointment or patient that may be booked in the slot.
Binding: hl7VS-appointmentReasonCodes (preferred)
... schedule SΣ 1..1 Reference(Schedule) A reference to the Schedule that this Slot is an interval of.
... status SΣ 1..1 code The status of the slot, e.g free, busy, etc.
Binding: SlotStatus (required): The free/busy status of the slot.

... start SΣ 1..1 instant Date/Time that the slot is to begin.
... end SΣ 1..1 instant Date/Time that the slot is to conclude.
... overbooked 0..1 boolean This slot has already been overbooked, appointments are unlikely to be accepted for this time
... comment 0..1 string Comments on the slot to describe any extended information. Such as custom constraints on the slot

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Slot.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Slot.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Slot.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Slot.specialtyextensibleUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG
Slot.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Slot.statusrequiredSlotStatus
http://hl7.org/fhir/ValueSet/slotstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSlotIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSlotIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorSlotIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorSlotIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSlotA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Slot

Summary

Must-Support: 6 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron