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 HealthcareService Profile

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

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

This Profile is used in the Find available HealthcareServices 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
.. HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
... 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
... providedBy Σ 0..1 Reference(HL7® AT Core Organization Profile) Organization that provides this service
... offeredIn 0..* Reference(HL7® AT Scheduling HealthcareService Profile) The service within which this service is offered
... type Σ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: AT Scheduling Service Type (extensible)

doco Documentation for this format

Terminology Bindings

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

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
... providedBy 0..1 Reference(HL7® AT Core Organization Profile) Organization that provides this service
... offeredIn 0..* Reference(HL7® AT Scheduling HealthcareService Profile) The service within which this service is offered
... type 0..* CodeableConcept Type of service that may be delivered or performed
Binding: AT Scheduling Service Type (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HealthcareService.type Base extensible AT Scheduling Service Type 📦0.2.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
... 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
Additional BindingsPurpose
CommonLanguages Starter
... 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 identifiers for this item
... active ?!Σ 0..1 boolean Whether this HealthcareService record is in active use
... providedBy Σ 0..1 Reference(HL7® AT Core Organization Profile) Organization that provides this service
... offeredIn 0..* Reference(HL7® AT Scheduling HealthcareService Profile) The service within which this service is offered
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.
... type Σ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: AT Scheduling Service Type (extensible)
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.
... location Σ 0..* Reference(Location) Location(s) where service may be provided
... name Σ 0..1 string Description of service as presented to a consumer while searching
... comment Σ 0..1 markdown Additional description and/or any specific issues not covered elsewhere
... extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields
... photo Σ 0..1 Attachment Facilitates quick identification of the service
... contact 0..* ExtendedContactDetail Official contact details for the HealthcareService
... coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
... eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 0..1 CodeableConcept Coded value for the eligibility
Binding Description: (example): Coded values underwhich a specific service is made available.
.... comment 0..1 markdown Describes the eligibility conditions for the service
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.
... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).
... communication 0..* CodeableConcept The language that this service is offered in
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter

... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthcareService resource.
... appointmentRequired 0..1 boolean If an appointment is required for access to this service
... availability 0..* Availability Times the healthcare service is available (including exceptions)
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.language Base required All Languages 📍5.0.0 FHIR Std.
HealthcareService.category Base example Service Category 📍5.0.0 FHIR Std.
HealthcareService.type Base extensible AT Scheduling Service Type 📦0.2.0 This IG
HealthcareService.specialty Base preferred Practice Setting Code Value Set 📍5.0.0 FHIR Std.
HealthcareService.serviceProvisionCode Base example Service Provision Conditions 📍5.0.0 FHIR Std.
HealthcareService.eligibility.​code Base example Not State Unknown
HealthcareService.program Base example Program 📍5.0.0 FHIR Std.
HealthcareService.characteristic Base example Service Mode 📍5.0.0 FHIR Std.
HealthcareService.communication Base required All Languages 📍5.0.0 FHIR Std.
HealthcareService.referralMethod Base example Referral Method 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error HealthcareService If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error HealthcareService 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 HealthcareService 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 HealthcareService If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice HealthcareService 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
.. HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
... 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
... providedBy Σ 0..1 Reference(HL7® AT Core Organization Profile) Organization that provides this service
... offeredIn 0..* Reference(HL7® AT Scheduling HealthcareService Profile) The service within which this service is offered
... type Σ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: AT Scheduling Service Type (extensible)

doco Documentation for this format

Terminology Bindings

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

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
... providedBy 0..1 Reference(HL7® AT Core Organization Profile) Organization that provides this service
... offeredIn 0..* Reference(HL7® AT Scheduling HealthcareService Profile) The service within which this service is offered
... type 0..* CodeableConcept Type of service that may be delivered or performed
Binding: AT Scheduling Service Type (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

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

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
... 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
Additional BindingsPurpose
CommonLanguages Starter
... 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 identifiers for this item
... active ?!Σ 0..1 boolean Whether this HealthcareService record is in active use
... providedBy Σ 0..1 Reference(HL7® AT Core Organization Profile) Organization that provides this service
... offeredIn 0..* Reference(HL7® AT Scheduling HealthcareService Profile) The service within which this service is offered
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.
... type Σ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: AT Scheduling Service Type (extensible)
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.
... location Σ 0..* Reference(Location) Location(s) where service may be provided
... name Σ 0..1 string Description of service as presented to a consumer while searching
... comment Σ 0..1 markdown Additional description and/or any specific issues not covered elsewhere
... extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields
... photo Σ 0..1 Attachment Facilitates quick identification of the service
... contact 0..* ExtendedContactDetail Official contact details for the HealthcareService
... coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
... eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 0..1 CodeableConcept Coded value for the eligibility
Binding Description: (example): Coded values underwhich a specific service is made available.
.... comment 0..1 markdown Describes the eligibility conditions for the service
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.
... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).
... communication 0..* CodeableConcept The language that this service is offered in
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter

... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthcareService resource.
... appointmentRequired 0..1 boolean If an appointment is required for access to this service
... availability 0..* Availability Times the healthcare service is available (including exceptions)
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.language Base required All Languages 📍5.0.0 FHIR Std.
HealthcareService.category Base example Service Category 📍5.0.0 FHIR Std.
HealthcareService.type Base extensible AT Scheduling Service Type 📦0.2.0 This IG
HealthcareService.specialty Base preferred Practice Setting Code Value Set 📍5.0.0 FHIR Std.
HealthcareService.serviceProvisionCode Base example Service Provision Conditions 📍5.0.0 FHIR Std.
HealthcareService.eligibility.​code Base example Not State Unknown
HealthcareService.program Base example Program 📍5.0.0 FHIR Std.
HealthcareService.characteristic Base example Service Mode 📍5.0.0 FHIR Std.
HealthcareService.communication Base required All Languages 📍5.0.0 FHIR Std.
HealthcareService.referralMethod Base example Referral Method 📍5.0.0 FHIR Std.

Constraints

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

Name Type Description Expression In Common
location reference The location of the Healthcare Service HealthcareService.location (Location)
organization reference The organization that provides this Healthcare Service HealthcareService.providedBy (Organization)
service-category token Service Category of the Healthcare Service HealthcareService.category
service-type token The type of service provided by this healthcare service HealthcareService.type
specialty token The specialty of the service provided by this healthcare service HealthcareService.specialty
Optional Parameters

The following search parameters SHOULD be supported by scheduling servers:

Name Type Description Expression In Common
characteristic token One of the HealthcareService's characteristics HealthcareService.characteristic
communication token Languages that are available at this service HealthcareService.communication
coverage-area reference Location(s) service is intended for/available to HealthcareService.coverageArea (Location)