ISiK Terminplanung Implementierungsleitfaden
Version 6.0.0-rc - ci-build

Resource Profile: ISiKKalender

Official URL: https://gematik.de/fhir/isik/StructureDefinition/ISiKKalender Version: 6.0.0-rc
Active as of 2025-12-17 Computable Name: ISiKKalender

Das Datenobjekt ISiKKalender bietet die Möglichkeit Kalender für verschiedene Akteure (Practitioner, Device, HealthcareService) zu exponieren, sodass für die Ressourcen Termine gebucht werden können.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:KalenderName S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name"
..... value[x] 1..1 string Value of extension
... active ?!SΣ 1..1 boolean Gibt an, ob der Kalender aktiv ist
... serviceType SΣ 1..* CodeableConcept Die Art der Dienstleistung, die der Kalender abdeckt
Binding: ServiceType (example)
.... text SΣ 0..1 string Plain text representation of the concept
... specialty SΣ 1..* CodeableConcept Die Fachrichtung, die der Kalender abdeckt
Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty).
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:Fachrichtung SΣ 1..1 Coding Code defined by a terminology system
Binding: IHE XDS practiceSettingCode (required)
..... coding:ErweiterterFachabteilungsschluessel Σ 0..1 Coding Code defined by a terminology system
Binding: FachabteilungsschluesselErweitert ValueSet (extensible)

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dkgev/Fachabteilungsschluessel-erweitert
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
... Slices for actor SΣ 1..* Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Der Akteur, der dem Kalender zugeordnet ist
Slice: Unordered, Open by type:$this
.... actor:All Slices Content/Rules for all slices
..... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... display SΣ 0..1 string Text alternative for the resource
.... actor:Akteur SΣ 0..1 Reference(Practitioner | HealthcareService | Location) Resource(s) that availability information is being provided for
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Schedule.serviceType Base example Service type 📍4.0.1 FHIR Std.
Schedule.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
Schedule.specialty.coding:Fachrichtung Base required IHE XDS practiceSettingCode 📦2019-05-17T13:46:31 de.ihe-d.terminology v3.0
Schedule.specialty.coding:ErweiterterFachabteilungsschluessel Base extensible FachabteilungsschluesselErweitert ValueSet 📦1.5.4 de.basisprofil.r4 v1.5

Constraints

Id Grade Path(s) Description Expression
dom-2 error Schedule If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Schedule 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 Schedule 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 Schedule If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Schedule 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 Schedule

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:KalenderName S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name
..... value[x] 1..1 string Value of extension
... serviceType S 1..* CodeableConcept Die Art der Dienstleistung, die der Kalender abdeckt
.... text S 0..1 string Plain text representation of the concept
... specialty S 1..* CodeableConcept Die Fachrichtung, die der Kalender abdeckt
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:Fachrichtung S 1..1 Coding Code defined by a terminology system
Binding: IHE XDS practiceSettingCode (required)
..... coding:ErweiterterFachabteilungsschluessel 0..1 Coding Code defined by a terminology system
Binding: FachabteilungsschluesselErweitert ValueSet (extensible)
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dkgev/Fachabteilungsschluessel-erweitert
... Slices for actor S 1..* Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Der Akteur, der dem Kalender zugeordnet ist
Slice: Unordered, Open by type:$this
.... actor:All Slices Content/Rules for all slices
..... identifier S 0..1 Identifier Logical reference, when literal reference is not known
..... display S 0..1 string Text alternative for the resource
.... actor:Akteur S 0..1 Reference(Practitioner | HealthcareService | Location) Resource(s) that availability information is being provided for
..... reference S 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Schedule.specialty.coding:Fachrichtung Base required IHE XDS practiceSettingCode 📦2019-05-17T13:46:31 de.ihe-d.terminology v3.0
Schedule.specialty.coding:ErweiterterFachabteilungsschluessel Base extensible FachabteilungsschluesselErweitert ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:KalenderName S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name"
..... value[x] 1..1 string Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... active ?!SΣ 1..1 boolean Gibt an, ob der Kalender aktiv ist
... serviceCategory Σ 0..* CodeableConcept High-level category
Binding: ServiceCategory (example)
... serviceType SΣ 1..* CodeableConcept Die Art der Dienstleistung, die der Kalender abdeckt
Binding: ServiceType (example)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept
... specialty SΣ 1..* CodeableConcept Die Fachrichtung, die der Kalender abdeckt
Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty).
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:Fachrichtung SΣ 1..1 Coding Code defined by a terminology system
Binding: IHE XDS practiceSettingCode (required)
..... coding:ErweiterterFachabteilungsschluessel Σ 0..1 Coding Code defined by a terminology system
Binding: FachabteilungsschluesselErweitert ValueSet (extensible)

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dkgev/Fachabteilungsschluessel-erweitert
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... Slices for actor SΣ 1..* Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Der Akteur, der dem Kalender zugeordnet ist
Slice: Unordered, Open by type:$this
.... actor:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... display SΣ 0..1 string Text alternative for the resource
.... actor:Akteur SΣ 0..1 Reference(Practitioner | HealthcareService | Location) Resource(s) that availability information is being provided for
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... display SΣ 0..1 string Text alternative for the resource
... planningHorizon Σ 0..1 Period Period of time covered by schedule
... comment 0..1 string Comments on availability

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Schedule.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Schedule.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Schedule.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Schedule.serviceCategory Base example Service category 📍4.0.1 FHIR Std.
Schedule.serviceType Base example Service type 📍4.0.1 FHIR Std.
Schedule.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
Schedule.specialty.coding:Fachrichtung Base required IHE XDS practiceSettingCode 📦2019-05-17T13:46:31 de.ihe-d.terminology v3.0
Schedule.specialty.coding:ErweiterterFachabteilungsschluessel Base extensible FachabteilungsschluesselErweitert ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Schedule.actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Schedule.actor:Akteur.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Schedule If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Schedule 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 Schedule 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 Schedule If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Schedule 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()
ElementShort descriptionNotes
Schedule.active Gibt an, ob der Kalender aktiv ist

Begründung Kardinalität und Must-Support-Flag (MS): Die Kardinalität 1..1 und das Must-Support-Flag (MS) für das ‘active’-Element stellen sicher, dass jeder Kalender eindeutig als aktiv oder inaktiv gekennzeichnet ist. Dies ist entscheidend für die Ressourcenplanung und Verfügbarkeit von Terminen.

Schedule.actor Der Akteur, der dem Kalender zugeordnet ist

Begründung Kardinalität und Must-Support-Flag (MS): Die Kardinalität der Akteur-Eigenschaft wird auf 0..1 festgelegt, um sicherzustellen, dass ein Akteur eindeutig ist, falls dieser vorhanden ist. Durch das MS wird sichergestellt, dass Systeme in der Lage sind, einen Akteur zu unterstützen, wenn er vorhanden ist.

Schedule.actor.display

Hinweis und Begründung zum Must Support: Für alle Target-Ressourcen SOLL ein Displaywert für die Referenz angegeben werden, sodass Systeme eine Übersicht der am Termin beteiligten Akteure anzeigen können, ohne die Referenzen auflösen zu müssen. Somit kann ein Termin-Consumer direkt anzeigen für welche Akteure ein Terminkalender existiert.

Schedule.actor.identifier

Begründung Must-Support-Flag (MS): Das Must-Support-Flag (MS) für das ‘identifier’-Element stellt sicher, dass Systeme in der Lage sind, einen Identifier zu unterstützen, wenn er vorhanden ist. Dies ist wichtig für die eindeutige Identifizierung und Verknüpfung von Akteuren in verschiedenen Systemen. Inbesondere gilt dies für die genaue Identifizierung von Geräten (Device).

Schedule.actor:Akteur

Im ISIK-Kontext MUSS die referenzierte Practitioner-Ressource konform zum ISiKPersonImGesundheitsberuf des Basismoduls sein. Zudem MUSS die referenzierte Location-Ressource konform zum ISiKStandort des Basismoduls sein. Dieses Element dient dazu, alle Akteure zu gruppieren, sodass für diese Einheit von Terminressourcen ein Terminblock herausgegeben werden kann. Unter ‘Akteure’ fallen hier auch Standorte und Dienstleistungen.

Schedule.actor:Akteur.reference

Begründung Kardinalität: Die Kardinalität der Akteur-Eigenschaft wird auf 1..1 festgelegt, um sicherzustellen, dass ein eindeutiger Akteur vorhanden ist.

Schedule.extension
Schedule.extension:KalenderName

Begründung Must-Support-Flag (MS): Die KalenderName-Extension ermöglicht es einen menschenlesbaren Namen zu definieren, welcher zur Wiedererkennbarkeit des Kalenders im Rahmen der Terminplanung dient.

Schedule.id serverseitige, interne ID des Datensatzes

bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine id verfügen. Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine idverfügen.

Schedule.serviceType Die Art der Dienstleistung, die der Kalender abdeckt

Begründung zu Kardinalität und Must Support: Die Dienstleistungsart eines Termins ist von entscheidender Bedeutung, um die Verfügbarkeit und Planung des Termins zu gewährleisten. Daher ist dieses Feld verpflichtend (1..*) und muss unterstützt werden (MS). Aufgrund der Heterogenität von Dienstleistungen ist eine standardisierte Kodierung nicht zwingend notwendig, eine Freitextbeschreibung ist ausreichend.

Schedule.serviceType.text
Schedule.specialty Die Fachrichtung, die der Kalender abdeckt

Hinweis: Ein Kalender kann für einen Akteur gepflegt werden. Dieser Akteur kann in einer oder mehreren Fachrichtungen agieren. Für die Ressourcenplanung (z.B. welche Akteure sind für einen Termin verfügbar) sollte auch auf die Speciality des Akteurs zurückgegriffen werden für den Fall, dass ein Kalender pro Fachbereich - d.h. Akteur-übergreifend - gepflegt wird.

Begründung Kardinalität Must-Support-Flag (MS): Die Kardinalität 1..* und das Must-Support-Flag (MS) für das ‘specialty’-Element stellen sicher, dass jeder Kalender mindestens eine Fachrichtung angibt. Dies ist wichtig für die Ressourcenplanung und die Verfügbarkeit von Terminen, sodass angefragte Termine einem Fachbereich zugeordnet werden können.

Hintergrund: Die Festlegung hat in einer Expertengruppe am 4.6.2024 stattgefunden. Diese war zuvor in einer ISiK Arbeitsgruppe bekanntgegeben worden und stand damit allen Beteiligten offen.

Schedule.specialty.coding

Begründung Kardinalität Fachrichtung: Die Kardinalität der Fachrichtung-Eigenschaft wird auf 1..1 festgelegt, um sicherzustellen, dass genau eine Fachrichtung per IHE-XDS-Kodierung vorhanden ist. Dies ist notwendig, um die Spezialisierung des Kalenders eindeutig zu definieren und eine korrekte Zuordnung zu gewährleisten.

Begründung Kardinalität ErweiterterFachabteilungsschluessel: Die Kardinalität der ErweiterterFachabteilungsschluessel-Eigenschaft wird auf 0..1 festgelegt, um sicherzustellen, dass optional ein erweiterter Fachabteilungsschlüssel vorhanden sein kann.

Schedule.specialty.coding:Fachrichtung

Die Wahl des hinterlegten ValueSets (http://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode) wurde mit einem Mitglied der IHE Deutschland Arbeitsgruppe XDS ValueSets (https://www.ihe-d.de/projekte/xds-value-sets-fuer-deutschland/) sowie mit der KBV abgestimmt (Stand:13.6.2024).

This structure is derived from Schedule

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 14 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Schedule.specialty.coding
  • The element 1 is sliced based on the value of Schedule.actor

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:KalenderName S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name"
..... value[x] 1..1 string Value of extension
... active ?!SΣ 1..1 boolean Gibt an, ob der Kalender aktiv ist
... serviceType SΣ 1..* CodeableConcept Die Art der Dienstleistung, die der Kalender abdeckt
Binding: ServiceType (example)
.... text SΣ 0..1 string Plain text representation of the concept
... specialty SΣ 1..* CodeableConcept Die Fachrichtung, die der Kalender abdeckt
Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty).
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:Fachrichtung SΣ 1..1 Coding Code defined by a terminology system
Binding: IHE XDS practiceSettingCode (required)
..... coding:ErweiterterFachabteilungsschluessel Σ 0..1 Coding Code defined by a terminology system
Binding: FachabteilungsschluesselErweitert ValueSet (extensible)

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dkgev/Fachabteilungsschluessel-erweitert
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
... Slices for actor SΣ 1..* Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Der Akteur, der dem Kalender zugeordnet ist
Slice: Unordered, Open by type:$this
.... actor:All Slices Content/Rules for all slices
..... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... display SΣ 0..1 string Text alternative for the resource
.... actor:Akteur SΣ 0..1 Reference(Practitioner | HealthcareService | Location) Resource(s) that availability information is being provided for
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... display SΣ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Schedule.serviceType Base example Service type 📍4.0.1 FHIR Std.
Schedule.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
Schedule.specialty.coding:Fachrichtung Base required IHE XDS practiceSettingCode 📦2019-05-17T13:46:31 de.ihe-d.terminology v3.0
Schedule.specialty.coding:ErweiterterFachabteilungsschluessel Base extensible FachabteilungsschluesselErweitert ValueSet 📦1.5.4 de.basisprofil.r4 v1.5

Constraints

Id Grade Path(s) Description Expression
dom-2 error Schedule If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Schedule 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 Schedule 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 Schedule If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Schedule 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 Schedule

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:KalenderName S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name
..... value[x] 1..1 string Value of extension
... serviceType S 1..* CodeableConcept Die Art der Dienstleistung, die der Kalender abdeckt
.... text S 0..1 string Plain text representation of the concept
... specialty S 1..* CodeableConcept Die Fachrichtung, die der Kalender abdeckt
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:Fachrichtung S 1..1 Coding Code defined by a terminology system
Binding: IHE XDS practiceSettingCode (required)
..... coding:ErweiterterFachabteilungsschluessel 0..1 Coding Code defined by a terminology system
Binding: FachabteilungsschluesselErweitert ValueSet (extensible)
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dkgev/Fachabteilungsschluessel-erweitert
... Slices for actor S 1..* Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Der Akteur, der dem Kalender zugeordnet ist
Slice: Unordered, Open by type:$this
.... actor:All Slices Content/Rules for all slices
..... identifier S 0..1 Identifier Logical reference, when literal reference is not known
..... display S 0..1 string Text alternative for the resource
.... actor:Akteur S 0..1 Reference(Practitioner | HealthcareService | Location) Resource(s) that availability information is being provided for
..... reference S 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Schedule.specialty.coding:Fachrichtung Base required IHE XDS practiceSettingCode 📦2019-05-17T13:46:31 de.ihe-d.terminology v3.0
Schedule.specialty.coding:ErweiterterFachabteilungsschluessel Base extensible FachabteilungsschluesselErweitert ValueSet 📦1.5.4 de.basisprofil.r4 v1.5

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Schedule 0..* Schedule A container for slots of time that may be available for booking appointments
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:KalenderName S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Schedule.name"
..... value[x] 1..1 string Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... active ?!SΣ 1..1 boolean Gibt an, ob der Kalender aktiv ist
... serviceCategory Σ 0..* CodeableConcept High-level category
Binding: ServiceCategory (example)
... serviceType SΣ 1..* CodeableConcept Die Art der Dienstleistung, die der Kalender abdeckt
Binding: ServiceType (example)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept
... specialty SΣ 1..* CodeableConcept Die Fachrichtung, die der Kalender abdeckt
Binding: PracticeSettingCodeValueSet (preferred): Additional details about where the content was created (e.g. clinical specialty).
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:Fachrichtung SΣ 1..1 Coding Code defined by a terminology system
Binding: IHE XDS practiceSettingCode (required)
..... coding:ErweiterterFachabteilungsschluessel Σ 0..1 Coding Code defined by a terminology system
Binding: FachabteilungsschluesselErweitert ValueSet (extensible)

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dkgev/Fachabteilungsschluessel-erweitert
...... version 0..1 string Version of the system - if relevant
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... Slices for actor SΣ 1..* Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Der Akteur, der dem Kalender zugeordnet ist
Slice: Unordered, Open by type:$this
.... actor:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... display SΣ 0..1 string Text alternative for the resource
.... actor:Akteur SΣ 0..1 Reference(Practitioner | HealthcareService | Location) Resource(s) that availability information is being provided for
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
..... display SΣ 0..1 string Text alternative for the resource
... planningHorizon Σ 0..1 Period Period of time covered by schedule
... comment 0..1 string Comments on availability

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Schedule.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Schedule.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Schedule.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Schedule.serviceCategory Base example Service category 📍4.0.1 FHIR Std.
Schedule.serviceType Base example Service type 📍4.0.1 FHIR Std.
Schedule.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
Schedule.specialty.coding:Fachrichtung Base required IHE XDS practiceSettingCode 📦2019-05-17T13:46:31 de.ihe-d.terminology v3.0
Schedule.specialty.coding:ErweiterterFachabteilungsschluessel Base extensible FachabteilungsschluesselErweitert ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Schedule.actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Schedule.actor:Akteur.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Schedule If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Schedule 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 Schedule 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 Schedule If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Schedule 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 Schedule

Summary

Mandatory: 5 elements(2 nested mandatory elements)
Must-Support: 14 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Schedule.specialty.coding
  • The element 1 is sliced based on the value of Schedule.actor

 

Other representations of profile: CSV, Excel, Schematron