0.1.0 - ci-build
0.1.0 - ci-build
TCFHIRAGSchedulingR5 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/at-scheduling-healthcareservice | Version: 0.1.0 | |||
| Draft as of 2025-03-31 | 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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| active |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use ele-1: All FHIR elements must have a @value or children |
 providedBy |
Σ | 0..1 | Reference(HL7® AT Core Organization Profile) | Organization that provides this service ele-1: All FHIR elements must have a @value or children |
| offeredIn |
0..* | Reference(HL7® AT Scheduling HealthcareService Profile) | The service within which this service is offered ele-1: All FHIR elements must have a @value or children | |
  type |
Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: AtSchedulingServiceType (extensible) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.type | extensible | AtSchedulingServiceTypehttp://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/ValueSet/AtSchedulingServiceTypefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService |
HealthcareService | |||
| 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: AtSchedulingServiceType (extensible) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.type | extensible | AtSchedulingServiceTypehttp://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/ValueSet/AtSchedulingServiceTypefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| 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: AtSchedulingServiceType (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 (No ValueSet): (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
| |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | |
| HealthcareService.type | extensible | AtSchedulingServiceTypehttp://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/ValueSet/AtSchedulingServiceTypefrom this IG | |
| HealthcareService.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard | |
| HealthcareService.serviceProvisionCode | example | ServiceProvisionConditionshttp://hl7.org/fhir/ValueSet/service-provision-conditionsfrom the FHIR Standard | |
| HealthcareService.eligibility.code | example | ||
| HealthcareService.program | example | Programhttp://hl7.org/fhir/ValueSet/programfrom the FHIR Standard | |
| HealthcareService.characteristic | example | ServiceModehttp://hl7.org/fhir/ValueSet/service-modefrom the FHIR Standard | |
| HealthcareService.communication | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-methodfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| active |
?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use ele-1: All FHIR elements must have a @value or children |
| providedBy |
Σ | 0..1 | Reference(HL7® AT Core Organization Profile) | Organization that provides this service ele-1: All FHIR elements must have a @value or children |
| offeredIn |
0..* | Reference(HL7® AT Scheduling HealthcareService Profile) | The service within which this service is offered ele-1: All FHIR elements must have a @value or children | |
| type |
Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: AtSchedulingServiceType (extensible) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.type | extensible | AtSchedulingServiceTypehttp://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/ValueSet/AtSchedulingServiceTypefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService |
HealthcareService | |||
| 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: AtSchedulingServiceType (extensible) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.type | extensible | AtSchedulingServiceTypehttp://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/ValueSet/AtSchedulingServiceTypefrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| 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: AtSchedulingServiceType (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 (No ValueSet): (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
| |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| HealthcareService.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| HealthcareService.category | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | |
| HealthcareService.type | extensible | AtSchedulingServiceTypehttp://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/ValueSet/AtSchedulingServiceTypefrom this IG | |
| HealthcareService.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard | |
| HealthcareService.serviceProvisionCode | example | ServiceProvisionConditionshttp://hl7.org/fhir/ValueSet/service-provision-conditionsfrom the FHIR Standard | |
| HealthcareService.eligibility.code | example | ||
| HealthcareService.program | example | Programhttp://hl7.org/fhir/ValueSet/programfrom the FHIR Standard | |
| HealthcareService.characteristic | example | ServiceModehttp://hl7.org/fhir/ValueSet/service-modefrom the FHIR Standard | |
| HealthcareService.communication | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| HealthcareService.referralMethod | example | ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-methodfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Other representations of profile: CSV, Excel, Schematron
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 |
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) |