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

Resource Profile: HL7® AT Scheduling Schedule Profile

Official URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/at-scheduling-schedule Version: 0.2.0
Draft as of 2025-11-06 Responsible: HL7® Austria, TC FHIR® Computable Name: HL7ATSchedulingSchedule

HL7® Austria FHIR® Scheduling Profile for schedule data in Austria.

This Profile is used in the Find available Schedules Interaction.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time 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
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... serviceType Σ 0..* CodeableReference(HealthcareService) Specific service
Binding: AT Scheduling Service Type (extensible)
... actor Σ 1..* Reference(HL7® AT Core Patient Profile | HL7® AT Core Practitioner Profile | HL7® AT Core PractitionerRole Profile | CareTeam | RelatedPerson | Device | HL7® AT Scheduling HealthcareService Profile | Location) Resource(s) that availability information is being provided for

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Schedule.serviceType Base extensible AT Scheduling Service Type 📦0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Schedule If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Schedule 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 Schedule 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 Schedule If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Schedule 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 Schedule

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... serviceType 0..* CodeableReference(HealthcareService) Specific service
Binding: AT Scheduling Service Type (extensible)
... actor 1..* Reference(HL7® AT Core Patient Profile | HL7® AT Core Practitioner Profile | HL7® AT Core PractitionerRole Profile | CareTeam | RelatedPerson | Device | HL7® AT Scheduling HealthcareService Profile | Location) Resource(s) that availability information is being provided for

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Schedule.serviceType Base extensible AT Scheduling Service Type 📦0.2.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule 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
... 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
... 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..* CodeableConcept High-level category
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableReference(HealthcareService) Specific service
Binding: AT Scheduling Service Type (extensible)
... specialty Σ 0..* CodeableConcept Type of specialty needed
Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty).
... name Σ 0..1 string Human-readable label
... actor Σ 1..* Reference(HL7® AT Core Patient Profile | HL7® AT Core Practitioner Profile | HL7® AT Core PractitionerRole Profile | CareTeam | RelatedPerson | Device | HL7® AT Scheduling HealthcareService Profile | Location) Resource(s) that availability information is being provided for
... planningHorizon Σ 0..1 Period Period of time covered by schedule
... comment 0..1 markdown Comments on availability

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Schedule.language Base required All Languages 📍5.0.0 FHIR Std.
Schedule.serviceCategory Base example Service Category 📍5.0.0 FHIR Std.
Schedule.serviceType Base extensible AT Scheduling Service Type 📦0.2.0 This IG
Schedule.specialty Base preferred Practice Setting Code Value Set 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Schedule If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Schedule 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 Schedule 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 Schedule If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Schedule 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time 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
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... serviceType Σ 0..* CodeableReference(HealthcareService) Specific service
Binding: AT Scheduling Service Type (extensible)
... actor Σ 1..* Reference(HL7® AT Core Patient Profile | HL7® AT Core Practitioner Profile | HL7® AT Core PractitionerRole Profile | CareTeam | RelatedPerson | Device | HL7® AT Scheduling HealthcareService Profile | Location) Resource(s) that availability information is being provided for

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Schedule.serviceType Base extensible AT Scheduling Service Type 📦0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Schedule If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Schedule 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 Schedule 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 Schedule If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Schedule 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 Schedule

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... serviceType 0..* CodeableReference(HealthcareService) Specific service
Binding: AT Scheduling Service Type (extensible)
... actor 1..* Reference(HL7® AT Core Patient Profile | HL7® AT Core Practitioner Profile | HL7® AT Core PractitionerRole Profile | CareTeam | RelatedPerson | Device | HL7® AT Scheduling HealthcareService Profile | Location) Resource(s) that availability information is being provided for

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Schedule.serviceType Base extensible AT Scheduling Service Type 📦0.2.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule 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
... 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
... 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..* CodeableConcept High-level category
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableReference(HealthcareService) Specific service
Binding: AT Scheduling Service Type (extensible)
... specialty Σ 0..* CodeableConcept Type of specialty needed
Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty).
... name Σ 0..1 string Human-readable label
... actor Σ 1..* Reference(HL7® AT Core Patient Profile | HL7® AT Core Practitioner Profile | HL7® AT Core PractitionerRole Profile | CareTeam | RelatedPerson | Device | HL7® AT Scheduling HealthcareService Profile | Location) Resource(s) that availability information is being provided for
... planningHorizon Σ 0..1 Period Period of time covered by schedule
... comment 0..1 markdown Comments on availability

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Schedule.language Base required All Languages 📍5.0.0 FHIR Std.
Schedule.serviceCategory Base example Service Category 📍5.0.0 FHIR Std.
Schedule.serviceType Base extensible AT Scheduling Service Type 📦0.2.0 This IG
Schedule.specialty Base preferred Practice Setting Code Value Set 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Schedule If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Schedule 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 Schedule 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 Schedule If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Schedule 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()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Search parameters

Required Parameters

At least one of the parameters actor or service-type-reference is required. Additionally date is always required.

Name Type Description Expression In Common
actor reference The individual(HealthcareService, Practitioner, Location, …) to find a Schedule for **AND/OR service-type-reference required Schedule.actor (Practitioner, Practitioner Role)
date date Search for Schedule resources that have a period that contains this date specified Schedule.planningHorizon
service-type-reference reference The type (by HealthcareService) of appointments that can be booked into associated slot(s) AND/OR actor required Schedule.serviceType.reference