Implementierungsleitfaden ISiK-Terminplanung

ISiKTerminblock (Slot)

ISiKTerminblock (Slot)

ISiKTerminblock

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.

Bestätigungsrelevanz

Verbindlichkeit	SHALL

Metadaten

Canonical	https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminblock
Status	active
Version	5.0.0-rc
Basis	http://hl7.org/fhir/StructureDefinition/Slot

Inhalt

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-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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() ISiK-slot-1: Der Endzeitpunkt eines Terminsblocks MUSS 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)
id	Σ	0..1	string	There are no (further) constraints on this element Element id Slot.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Slot.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Slot.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Slot.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Slot.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Slot.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Slot.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Slot.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
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 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. 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 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. 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 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. 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 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). 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 w5: FiveWs.class
schedule	S Σ	1..1	Reference(Schedule)	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 Begründung Kardinalität und MS: Die Kardinalität der reference-Eigenschaft wird auf 1..* festgelegt, um sicherzustellen, dass ein Kalender eindeutig referenziert und identifiziert werden kann. Data type Reference(Schedule) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
id		0..1	string	There are no (further) constraints on this element Element id Slot.schedule.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Slot.schedule.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
reference	S Σ I	1..1	string	There are no (further) constraints on this element Element id Slot.schedule.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. 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
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element id Slot.schedule.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element id Slot.schedule.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .identifier
display	Σ	0..1	string	There are no (further) constraints on this element Element id Slot.schedule.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. 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
status	S Σ	1..1	codeBinding	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 Begründung Must Support: Dies ist wichtig, um die Verfügbarkeit von Terminen zu gewährleisten, eine Überbuchung zu verhindern und zudem einem Termin-Requestor die Möglichkeit zu bieten nur freie Termine bei der Terminbuchung anzuzeigen. 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 ical: FREEBUSY;FBTYPE=(freeBusyType):19980314T233000Z/19980315T003000Z If the freeBusyType is BUSY, then this value can be excluded
start	S Σ	1..1	instant	Element id Slot.start Short description Date/Time that the slot is to begin Definition Date/Time that the slot is to begin. Comments Begründung Must Support: Dies ist wichtig, um den Zeitpunkt des Termins an einen Termin-Requestor / Termin-Consumer zu kommunizieren. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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	Element id Slot.end Short description Date/Time that the slot is to conclude Definition Date/Time that the slot is to conclude. Comments Begründung Must Support: Dies ist wichtig, um die Länge des Termins an einen Termin-Requestor / Termin-Consumer zu kommunizieren. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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. Meaning when missing If overbooked is missing, systems may assume that there are still appointments available Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="ISiKTerminblock" />
    <url value="https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminblock" />
    <version value="5.0.0-rc" />
    <name value="ISiKTerminblock" />
    <status value="active" />
    <experimental value="false" />
    <date value="2025-04-09" />
    <publisher value="gematik GmbH" />
    <description value="Die Slot-Ressource repr&#228;sentiert die Verbindung eines Termins (Appointment) und den dazugeh&#246;rigen Ressourcen (z.B. HealthcareService, Device, Practitioner). F&#252;r diese Ressourcen k&#246;nnen separate Kalender (Schedules) verwaltet werden. Der Slot agiert als Verbindungsst&#252;ck zwischen diesen Ressourcen." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Slot" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Slot" />
    <derivation value="constraint" />
    <differential>
        <element id="Slot">
            <path value="Slot" />
            <constraint>
                <key value="ISiK-slot-1" />
                <severity value="error" />
                <human value="Der Endzeitpunkt eines Terminsblocks MUSS nach dem Startzeitpunkt liegen" />
                <expression value="start &lt;= end" />
                <source value="https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminblock" />
            </constraint>
        </element>
        <element id="Slot.schedule">
            <path value="Slot.schedule" />
            <comment value="Begr&#252;ndung Kardinalit&#228;t und MS: Die Kardinalit&#228;t der reference-Eigenschaft wird auf 1..* festgelegt, um sicherzustellen, dass ein Kalender eindeutig referenziert und identifiziert werden kann." />
            <mustSupport value="true" />
        </element>
        <element id="Slot.schedule.reference">
            <path value="Slot.schedule.reference" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Slot.status">
            <path value="Slot.status" />
            <comment value="Begr&#252;ndung Must Support: Dies ist wichtig, um die Verf&#252;gbarkeit von Terminen zu gew&#228;hrleisten, eine &#220;berbuchung zu verhindern und zudem einem Termin-Requestor die M&#246;glichkeit zu bieten nur freie Termine bei der Terminbuchung anzuzeigen." />
            <mustSupport value="true" />
        </element>
        <element id="Slot.start">
            <path value="Slot.start" />
            <comment value="Begr&#252;ndung Must Support: Dies ist wichtig, um den Zeitpunkt des Termins an einen Termin-Requestor / Termin-Consumer zu kommunizieren." />
            <mustSupport value="true" />
        </element>
        <element id="Slot.end">
            <path value="Slot.end" />
            <comment value="Begr&#252;ndung Must Support: Dies ist wichtig, um die L&#228;nge des Termins an einen Termin-Requestor / Termin-Consumer zu kommunizieren." />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "ISiKTerminblock",
    "url": "https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminblock",
    "version": "5.0.0-rc",
    "name": "ISiKTerminblock",
    "status": "active",
    "experimental": false,
    "date": "2025-04-09",
    "publisher": "gematik GmbH",
    "description": "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.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Slot",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Slot",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Slot",
                "path": "Slot",
                "constraint":  [
                    {
                        "key": "ISiK-slot-1",
                        "severity": "error",
                        "human": "Der Endzeitpunkt eines Terminsblocks MUSS nach dem Startzeitpunkt liegen",
                        "expression": "start <= end",
                        "source": "https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminblock"
                    }
                ]
            },
            {
                "id": "Slot.schedule",
                "path": "Slot.schedule",
                "comment": "Begründung Kardinalität und MS: Die Kardinalität der reference-Eigenschaft wird auf 1..* festgelegt, um sicherzustellen, dass ein Kalender eindeutig referenziert und identifiziert werden kann.",
                "mustSupport": true
            },
            {
                "id": "Slot.schedule.reference",
                "path": "Slot.schedule.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Slot.status",
                "path": "Slot.status",
                "comment": "Begründung Must Support: Dies ist wichtig, um die Verfügbarkeit von Terminen zu gewährleisten, eine Überbuchung zu verhindern und zudem einem Termin-Requestor die Möglichkeit zu bieten nur freie Termine bei der Terminbuchung anzuzeigen.",
                "mustSupport": true
            },
            {
                "id": "Slot.start",
                "path": "Slot.start",
                "comment": "Begründung Must Support: Dies ist wichtig, um den Zeitpunkt des Termins an einen Termin-Requestor / Termin-Consumer zu kommunizieren.",
                "mustSupport": true
            },
            {
                "id": "Slot.end",
                "path": "Slot.end",
                "comment": "Begründung Must Support: Dies ist wichtig, um die Länge des Termins an einen Termin-Requestor / Termin-Consumer zu kommunizieren.",
                "mustSupport": true
            }
        ]
    }
}

ISiKTerminblock

Constraints/Invarianten

Name	Schweregrad	Beschreibung	Ausdruck
ISiK-slot-1	error	Der Endzeitpunkt eines Terminsblocks MUSS nach dem Startzeitpunkt liegen	start <= end

Terminology-Bindings

Anmerkungen zu Must-Support-Feldern

Feldname	Hinweise
Slot.schedule	Begründung Kardinalität und MS: Die Kardinalität der reference-Eigenschaft wird auf 1..* festgelegt, um sicherzustellen, dass ein Kalender eindeutig referenziert und identifiziert werden kann.
Slot.schedule.reference
Slot.status	Begründung Must Support: Dies ist wichtig, um die Verfügbarkeit von Terminen zu gewährleisten, eine Überbuchung zu verhindern und zudem einem Termin-Requestor die Möglichkeit zu bieten nur freie Termine bei der Terminbuchung anzuzeigen.
Slot.start	Begründung Must Support: Dies ist wichtig, um den Zeitpunkt des Termins an einen Termin-Requestor / Termin-Consumer zu kommunizieren.
Slot.end	Begründung Must Support: Dies ist wichtig, um die Länge des Termins an einen Termin-Requestor / Termin-Consumer zu kommunizieren.

`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: Insbesondere eine Differenzierung des Status ‚busy‘ ermöglicht es einem Termin-Requestor, einem Benutzer passende Termine 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 Appointment über mehrere Slots erstreckt, kann mithilfe des Enddatums der Slot gefunden werden, der als nächster innerhalb einer Reihe gebucht werden muss, sodass das Appointment die gewünschte Länge erreicht.

Interaktionen

Interaktion	Verbindlichkeit
read	SHALL
search-type	SHALL

Parameter	Typ	Verbindlichkeit	Hinweise
_id	token	SHALL	Beispiel: `GET [base]/[Resourcetype]?_id=103270` Anwendungshinweis: Der Parameter `_id` wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der `id` die `READ`-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem `_include` weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten: `GET [base]/Encounter?_id=103270&_include=Encounter:patient` Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources. Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.
_tag	token	SHALL	Beispiel: `GET [base]/[Resourcetype]?_tag=https://example.org/codes\|needs-review` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.
_count	number	SHALL	Beispiel: `GET [base]/[Resourcetype]?_count=100` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.
_has	string	MAY	Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben `GET [base]/Patient?_has:Observation:patient:code=1234-5` Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde `GET [base]/Encounter?_has:Condition:encounter:code=A12.3` Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.
schedule	reference	SHALL	Beispiel: `GET [base]/Slot?schedule=Schedule/ISiKKalenderExample&start=2022-12-10T09:00:00Z` `GET [base]/Slot?schedule=Schedule/ISiKKalenderExample` Anwendungshinweis: Der Suchparameter `schedule` MUSS in Kombination mit einem definierten Startzeitpunkt mittels Suchparameter `start` unterstützt werden. Der Suchparameter `schedule` KANN alleinstehend unterstützt werden. Beim Fehlen des `start`-Suchparameters SOLL der aktuelle Zeitpunkt des Servers als Startzeitpunkt per Default verwendet werden. 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` Dies kann notwendig sein, falls interdisziplinäre Kalender durch das Termin-Repository gepflegt werden (z.B. ein Kalender pro Station). In solchen Fälle wäre es sinnvoll, wenn das Termin-Repository einem Termin-Requestor eine Verknüpfung zwischen Kalender (Schedule) und Behandlungsleistung (HealthcareService) bereitstellen würde. Weitere Details siehe FHIR-Kernspezifikation.
status	token	SHALL	Beispiel: `GET [base]/Slot?status=free&schedule=Schedule/ISiKTerminExample` `GET [base]/Slot?status=free&schedule.actor:Practitioner.name=Musterarzt` Anwendungshinweis: Der Suchparameter `status` MUSS in Kombination ('&') mit dem Parameter `schedule` unterstützt werden. Diese Abfrage KANN entweder eine direkte Angabe einer Referenz oder eine Angabe von weiteren Chaining-Parametern sein. Der Suchparameter MUSS NICHT alleinstehend unterstützt werden. Weitere Details siehe FHIR-Kernspezifikation.
start	date	SHALL	Beispiel: `GET [base]/Slot?start=2022-12-10T09:00:00Z&schedule=Schedule/ISiKTerminExample` `GET [base]/Slot?start=2022-12-10T09:00:00Z&schedule.actor:Practitioner.name=Musterarzt` Anwendungshinweis: Der Suchparameter `start` MUSS in Kombination ('&') mit dem Parameter `schedule` unterstützt werden. Diese Abfrage KANN entweder eine direkte Angabe einer Referenz oder eine Angabe von weiteren Chaining-Parametern sein. Der Suchparameter MUSS NICHT alleinstehend unterstützt werden. Weitere Details siehe FHIR-Kernspezifikation.

(Reverse-)Include

Include	ReverseInclude
Slot:schedule	Appointment:slot

Command 'pagelink' could not render: Page not found.

Beispiele

Slot

id : ISiKTerminblockExample

meta

profile : https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminblock

schedule

reference : Schedule/ISiKKalenderExample

status : busy

start : 2022-12-10T09:00:00+00:00

end : 2022-12-10T11:00:00+00:00

<Slot xmlns="http://hl7.org/fhir">
    <id value="ISiKTerminblockExample" />
    <meta>
        <profile value="https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminblock" />
    </meta>
    <schedule>
        <reference value="Schedule/ISiKKalenderExample" />
    </schedule>
    <status value="busy" />
    <start value="2022-12-10T09:00:00Z" />
    <end value="2022-12-10T11:00:00Z" />
</Slot>

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

Time slot for schedule Schedule/ISiKKalenderExample