KisimScheduling - Local Development build (v0.1.0). See the Directory of published versions
Resource Profile: KisimSchedulingSlot ( Experimental )
| Official URL: http://fhir.kisimdocs.ch/ig/KisimScheduling/StructureDefinition/KisimSchedulingSlot | Version: 0.1.0 | |||
| Draft as of 2022-09-05 | Computable Name: KisimSchedulingSlot | |||
A fairly dynamic implementation of the Slot Ressource which is not valid longer than x minutes
Scope and Usage
Slots are searched by the custom operation searchSlotByPlan. Found slots are only kept on the server for a specific time. After that, the slots are deleted and are not accessible anymore. The reason for that is, that the bookable resources on the server are accessed from different systems. Therefore, the validity for a slot is quite short-lived.
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Slot
This structure is derived from Slot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Slot | 0..* | Slot | A slot of time on a schedule that may be available for booking appointments | |
| 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 | |||||
  id | Σ | 0..1 | string | 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(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 | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Slot | 0..* | Slot | A slot of time on a schedule that may be available for booking appointments | |
| Documentation for this format | ||||
This structure is derived from Slot
Differential View
This structure is derived from Slot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Slot | 0..* | Slot | A slot of time on a schedule that may be available for booking appointments | |
| Documentation for this format | ||||
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 | string | 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(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 | ||||||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| Slot.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Slot.serviceCategory | example | ServiceCategory |
| Slot.serviceType | example | ServiceType |
| Slot.specialty | preferred | PracticeSettingCodeValueSet |
| Slot.appointmentType | preferred | Hl7VSAppointmentReasonCodes |
| Slot.status | required | SlotStatus |
Constraints
| Id | Grade | Path | 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 | Slot.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Slot.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Slot.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Slot.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Slot.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.serviceCategory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.serviceType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.specialty | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.appointmentType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.schedule | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.start | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.end | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.overbooked | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Slot.comment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |