Implementierungsleitfaden ISiK-Modul Terminplanung

ISiKTerminblock (Slot)

Motivation

Die Slot-Ressource repräsentiert die Verbindung eines Termins (Appointment) und den dazugehörigen Ressourcen (z.B. HealthcareService, Device, Practitioner). Für diese Ressourcen können separate Kalender (Schedules) verwaltet werden. Der Slot agiert als Verbindungsstück zwischen diesen Ressourcen.

Kompabilität

Siehe Kompabilität.

FHIR-Profil

Name	Canonical
ISiKTerminblock	https://gematik.de/fhir/isik/v2/Terminplanung/StructureDefinition/ISiKTerminblock

Slot	I		Slot	Element Id Slot Short description A slot of time on a schedule that may be available for booking appointments Definition A slot of time on a schedule that may be available for booking appointments. Data Type Slot Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: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-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 `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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` ISiK-slot-1:Der Endzeitpunkt eines Terminsblocks sollte nach dem Startzeitpunkt liegen `start <= end` Mappings rim:Entity. Role, or Act rim:n/a ical:(refer to the Availability resource for the header mapping details)
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id Slot.identifier Short description External Ids for this item Definition External Ids for this item. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier
serviceCategory	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id Slot.serviceCategory Short description A broad categorization of the service that is to be performed during this appointment Definition A broad categorization of the service that is to be performed during this appointment. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding ServiceCategory (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class
serviceType	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id Slot.serviceType Short description 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 Definition 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. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding ServiceType (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class
specialty	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Slot.specialty Short description The specialty of a practitioner that would be required to perform the service requested in this appointment Definition The specialty of a practitioner that would be required to perform the service requested in this appointment. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Additional details about where the content was created (e.g. clinical specialty). PracticeSettingCodeValueSet (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class
appointmentType	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Slot.appointmentType Short description The style of appointment or patient that may be booked in the slot (not service type) Definition The style of appointment or patient that may be booked in the slot (not service type). Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding v2.0276 (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class
schedule	S Σ I	1..1	Reference(ISiKKalender)	Element Id Slot.schedule Short description The schedule resource that this slot defines an interval of status information Definition The schedule resource that this slot defines an interval of status information. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(ISiKKalender) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
status	S Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Slot.status Short description busy \| free \| busy-unavailable \| busy-tentative \| entered-in-error Definition busy \| free \| busy-unavailable \| busy-tentative \| entered-in-error. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The free/busy status of the slot. SlotStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a ical:FREEBUSY;FBTYPE=(freeBusyType):19980314T233000Z/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded
start	S Σ	1..1	instant	There are no (further) constraints on this element Element Id Slot.start Short description Date/Time that the slot is to begin Definition Date/Time that the slot is to begin. Comments Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.planned ical:FREEBUSY;FBTYPE=FREE:(start)/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded
end	S Σ	1..1	instant	There are no (further) constraints on this element Element Id Slot.end Short description Date/Time that the slot is to conclude Definition Date/Time that the slot is to conclude. Comments Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.planned ical:FREEBUSY:19980314T233000Z/(end) If the freeBusyType is BUSY, then this value can be excluded (as shown)
overbooked		0..1	boolean	There are no (further) constraints on this element Element Id Slot.overbooked Short description This slot has already been overbooked, appointments are unlikely to be accepted for this time Definition This slot has already been overbooked, appointments are unlikely to be accepted for this time. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
comment		0..1	string	There are no (further) constraints on this element Element Id Slot.comment Short description Comments on the slot to describe any extended information. Such as custom constraints on the slot Definition Comments on the slot to describe any extended information. Such as custom constraints on the slot. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a

Folgende FHIRPath-Constraints sind im Profil zu beachten:

key	severity	human	expression
ISiK-slot-1	error	Der Endzeitpunkt eines Terminsblocks sollte nach dem Startzeitpunkt liegen	start <= end

Anmerkungen zu Must-Support-Feldern

`Slot.schedule`

Bedeutung: Verknüpfung einer Termins / Terminblocks und den dazugehörigen Terminlisten bzw. deren Ressourcen.

Hinweise: Die Referenz auf Schedule bietet die Möglichkeit der Abfrage eines Appointments / Slots auf Basis einer Verknüpfung mit einem Schedule bzw. eines Schedules für eine bestimmte Ressource (Schedule.actor).

`Slot.status`

Bedeutung: Indikator ob ein Slot verwendbar ist für die Buchung eines Appointments.

Hinweise: Inbesondere eine Differenzierung des Status "busy" ermöglicht es einem Termin Requestor passende Termine einer BenutzerIn zur Verfügung zu stellen. Durch entsprechende Kombinationen können somit Termine in einer passenden Länge gebucht werden.

`Slot.start`

Bedeutung: Startdatum des Slots (sekundengenau).

Hinweise: Falls sich ein Appoinment über mehrere Slots erstreckt, kann mit Hilfe des Startdatums der Beginn eines zu vereinbarenden Termins gefunden werden.

`Slot.end`

Bedeutung: Enddatum des Slots (sekundengenau).

Hinweise: Falls sich ein Appoinment über mehrere Slots erstreckt, kann mit Hilfe des Enddatums der Slot gefunden werden, welcher als nächste innerhalb einer Reihe gebucht werden muss, sodass das Appointment eine gewünschte Länge erreicht.

Interaktionen

Für die Ressource Slot MUSS die REST-Interaktion "READ" implementiert werden.

Der Suchparameter "_id" MUSS unterstützt werden:

Beispiele:

GET [base]/Slot?_id=103270

Anwendungshinweise: Weitere Informationen zur Suche nach "_id" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter "schedule" MUSS unterstützt werden:

Beispiele:

GET [base]/Slot?schedule=Schedule/ISiKKalenderExample

Anwendungshinweise: Weitere Informationen zur Suche nach "Slot.schedule" finden sich in der FHIR-Basisspezifikation - Abschnitt "reference".
Der Suchparameter "status" MUSS unterstützt werden:

Beispiele:

GET [base]/Slot?status=busy

Anwendungshinweise: Weitere Informationen zur Suche nach "Slot.status" finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "start" MUSS unterstützt werden:

Beispiele:

GET [base]/Slot?start=2022-12-10T09:00:00Z

Anwendungshinweise: Weitere Informationen zur Suche nach "Slot.start" finden sich in der FHIR-Basisspezifikation - Abschnitt "Date Search".
Abfrage aller verfügbaren Slots für einen Kalender:

GET https://example.org/fhir/Slot?schedule=<Scheudule/ISiKKalenderExampple>

Anwendungshinweise: In diesem Fall ist auch ein Chaining auf weitere verknüpfte Akteure möglich: GET https://example.org/fhir/Slot?schedule.actor:HealthcareService.type=https://example.org/fhir/CodeSystem/Behandlungsleistung|CT

Beispiele

{
    "resourceType": "Slot",
    "id": "ISiKTerminblockExample",
    "meta": {
        "profile":  [
            "https://gematik.de/fhir/isik/v2/Terminplanung/StructureDefinition/ISiKTerminblock"
        ]
    },
    "schedule": {
        "reference": "Schedule/ISiKKalenderExample"
    },
    "status": "busy",
    "start": "2022-12-10T09:00:00Z",
    "end": "2022-12-10T11:00:00Z"
}