0.2.0 - Informative
0.2.0 - Informative
TCFHIRAGSchedulingR5, published by HL7® Austria, TC FHIR®. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7Austria/TC-FHIR-AG-Scheduling-R5/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/at-scheduling-slot | Version: 0.2.0 | |||
| Draft as of 2025-11-06 | Responsible: HL7® Austria, TC FHIR® | Computable Name: HL7ATSchedulingSlot | ||
HL7® Austria FHIR® Scheduling Profile for slot data in Austria.
This Profile is used in the Find available Slots for potential Appointments.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  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 |
| contained |
0..* | Resource | Contained, inline Resources | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:SlotEncounterClass |
0..* | CodeableConcept | Slot Encounter Class URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/slot-encounter-class Binding: Encounter class (extensible) | |
 extension:bookingURL |
0..1 | uri | Appointment Booking URL URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/appointment-booking-url | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
 serviceType |
Σ | 0..* | CodeableReference(HL7® AT Scheduling HealthcareService Profile) | 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 Schedule resource Binding: AT Scheduling Service Type (extensible) |
| schedule |
Σ | 1..1 | Reference(HL7® AT Scheduling Schedule Profile) | The schedule resource that this slot defines an interval of status information |
| status |
Σ | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot. |
| start |
Σ | 1..1 | instant | Date/Time that the slot is to begin |
 end |
Σ | 1..1 | instant | Date/Time that the slot is to conclude |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Slot.serviceType | Base | extensible | AT Scheduling Service Type | 📦0.2.0 | This IG |
| Slot.status | Base | required | Slot Status | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Slot | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Slot | If 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Slot | If 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-5 | error | Slot | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Slot | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Slot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |
| extension:SlotEncounterClass |
0..* | CodeableConcept | Slot Encounter Class URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/slot-encounter-class Binding: Encounter class (extensible) | |
| extension:bookingURL |
0..1 | uri | Appointment Booking URL URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/appointment-booking-url | |
| serviceType |
0..* | CodeableReference(HL7® AT Scheduling HealthcareService Profile) | 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 Schedule resource Binding: AT Scheduling Service Type (extensible) | |
| schedule |
1..1 | Reference(HL7® AT Scheduling Schedule Profile) | The schedule resource that this slot defines an interval of status information | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Slot.serviceType | Base | extensible | AT Scheduling Service Type | 📦0.2.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:SlotEncounterClass |
0..* | CodeableConcept | Slot Encounter Class URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/slot-encounter-class Binding: Encounter class (extensible) | |||||
| extension:bookingURL |
0..1 | uri | Appointment Booking URL URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/appointment-booking-url | |||||
| 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..* | CodeableReference(HL7® AT Scheduling HealthcareService Profile) | 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 Schedule resource Binding: AT Scheduling Service Type (extensible) | ||||
| specialty |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty). | ||||
| appointmentType |
Σ | 0..* | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
| schedule |
Σ | 1..1 | Reference(HL7® AT Scheduling Schedule Profile) | The schedule resource that this slot defines an interval of status information | ||||
| status |
Σ | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot. | ||||
| start |
Σ | 1..1 | instant | Date/Time that the slot is to begin | ||||
| end |
Σ | 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Slot.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Slot.serviceCategory | Base | example | Service Category | 📍5.0.0 | FHIR Std. |
| Slot.serviceType | Base | extensible | AT Scheduling Service Type | 📦0.2.0 | This IG |
| Slot.specialty | Base | preferred | Practice Setting Code Value Set | 📍5.0.0 | FHIR Std. |
| Slot.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📦2.0.0 | THO v6.5 |
| Slot.status | Base | required | Slot Status | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Slot | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Slot | If 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Slot | If 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-5 | error | Slot | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Slot | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Slot
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:SlotEncounterClass |
0..* | CodeableConcept | Slot Encounter Class URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/slot-encounter-class Binding: Encounter class (extensible) | |
| extension:bookingURL |
0..1 | uri | Appointment Booking URL URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/appointment-booking-url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| serviceType |
Σ | 0..* | CodeableReference(HL7® AT Scheduling HealthcareService Profile) | 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 Schedule resource Binding: AT Scheduling Service Type (extensible) |
| schedule |
Σ | 1..1 | Reference(HL7® AT Scheduling Schedule Profile) | The schedule resource that this slot defines an interval of status information |
| status |
Σ | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot. |
| start |
Σ | 1..1 | instant | Date/Time that the slot is to begin |
| end |
Σ | 1..1 | instant | Date/Time that the slot is to conclude |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Slot.serviceType | Base | extensible | AT Scheduling Service Type | 📦0.2.0 | This IG |
| Slot.status | Base | required | Slot Status | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Slot | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Slot | If 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Slot | If 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-5 | error | Slot | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Slot | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Slot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |
| extension:SlotEncounterClass |
0..* | CodeableConcept | Slot Encounter Class URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/slot-encounter-class Binding: Encounter class (extensible) | |
| extension:bookingURL |
0..1 | uri | Appointment Booking URL URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/appointment-booking-url | |
| serviceType |
0..* | CodeableReference(HL7® AT Scheduling HealthcareService Profile) | 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 Schedule resource Binding: AT Scheduling Service Type (extensible) | |
| schedule |
1..1 | Reference(HL7® AT Scheduling Schedule Profile) | The schedule resource that this slot defines an interval of status information | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Slot.serviceType | Base | extensible | AT Scheduling Service Type | 📦0.2.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:SlotEncounterClass |
0..* | CodeableConcept | Slot Encounter Class URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/slot-encounter-class Binding: Encounter class (extensible) | |||||
| extension:bookingURL |
0..1 | uri | Appointment Booking URL URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/appointment-booking-url | |||||
| 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..* | CodeableReference(HL7® AT Scheduling HealthcareService Profile) | 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 Schedule resource Binding: AT Scheduling Service Type (extensible) | ||||
| specialty |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty). | ||||
| appointmentType |
Σ | 0..* | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
| schedule |
Σ | 1..1 | Reference(HL7® AT Scheduling Schedule Profile) | The schedule resource that this slot defines an interval of status information | ||||
| status |
Σ | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot. | ||||
| start |
Σ | 1..1 | instant | Date/Time that the slot is to begin | ||||
| end |
Σ | 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 | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Slot.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Slot.serviceCategory | Base | example | Service Category | 📍5.0.0 | FHIR Std. |
| Slot.serviceType | Base | extensible | AT Scheduling Service Type | 📦0.2.0 | This IG |
| Slot.specialty | Base | preferred | Practice Setting Code Value Set | 📍5.0.0 | FHIR Std. |
| Slot.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📦2.0.0 | THO v6.5 |
| Slot.status | Base | required | Slot Status | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Slot | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Slot | If 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Slot | If 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-5 | error | Slot | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Slot | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Slot
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
| Name | Type | Description | Expression | In Common |
|---|---|---|---|---|
| schedule | reference | The Schedule Resource that we are seeking a slot within | Slot.schedule (Schedule) | |
| service-type | token | The type (by coding) of appointments that can be booked into the slot | Slot.serviceType.concept |
| Name | Type | Description | Expression | In Common |
|---|---|---|---|---|
| start | date | Appointment date/time. | Slot.start | |
| status | token | The free/busy status of the appointment. Shall always be "free" | Slot.status |