Finnish Base Profiles
1.0.0 - trial-use
Finnish Base Profiles
1.0.0 - trial-use
This page is part of the Finnish Base Profiles (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-slot | Version: 1.0.0 | |||
| Active as of 2023-11-10 | Computable Name: FiBaseSlot | |||
This is the Finnish base profile for the Slot resource.
This implementation guide does not profile scheduling related resources.
However, references to Appointment, Schedule, and Slot resources are included here in order to draw the readers attention to two previous implementation guides published by HL7 Finland:
There is also ongoing work on FHIR APIs for scheduling in the national Kanta system.
The contents of both of the implementation guides published by HL7 Finland are already a bit outdated.
The concepts and resources are used, most notably by Omaolo symptom assessment services and AVPH (ajanvaraus ja palveluohjain -sovellus) scheduling service, and the scheduling API of the OMNI360 electronic health record system.
Still, implementers should read these implementation guides with caution and verify the latest state of the art from their customers or from vendors of real world implementations.
HL7 Finland is currently considering updating the published implementation guides.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Slot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Slot | Slot | |||
  schedule | 1..1 | Reference(FI Base Schedule) | The schedule resource that this slot defines an interval of status information | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| schedule | Σ | 1..1 | Reference(FI Base Schedule) | 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 | Conformance | ValueSet |
| Slot.status | required | SlotStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 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().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-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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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: CommonLanguages (preferred): 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 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 | Σ | 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..1 | 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(FI Base Schedule) | 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 | Conformance | ValueSet | ||||
| Slot.language | preferred | CommonLanguages
| ||||
| Slot.serviceCategory | example | ServiceCategory | ||||
| Slot.serviceType | example | ServiceType | ||||
| Slot.specialty | preferred | PracticeSettingCodeValueSet | ||||
| Slot.appointmentType | preferred | Hl7VSAppointmentReasonCodes | ||||
| Slot.status | required | SlotStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 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().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-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
Differential View
This structure is derived from Slot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Slot | Slot | |||
| schedule | 1..1 | Reference(FI Base Schedule) | The schedule resource that this slot defines an interval of status information | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| schedule | Σ | 1..1 | Reference(FI Base Schedule) | 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 | Conformance | ValueSet |
| Slot.status | required | SlotStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 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().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-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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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: CommonLanguages (preferred): 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 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 | Σ | 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..1 | 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(FI Base Schedule) | 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 | Conformance | ValueSet | ||||
| Slot.language | preferred | CommonLanguages
| ||||
| Slot.serviceCategory | example | ServiceCategory | ||||
| Slot.serviceType | example | ServiceType | ||||
| Slot.specialty | preferred | PracticeSettingCodeValueSet | ||||
| Slot.appointmentType | preferred | Hl7VSAppointmentReasonCodes | ||||
| Slot.status | required | SlotStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 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().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-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
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 Finland. Package hl7.fhir.fi.base#1.0.0 based on FHIR 4.0.1. Generated 2023-11-10
Links: Table of Contents
| QA Report| Version History
| 
| Source
| Propose a change