ISiK Terminplanung Implementierungsleitfaden
Version 6.0.0-rc - ci-build

Resource Profile: ISiKTermin

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

Das Datenobjekte ISiKTermin repräsentiert einen gebuchten Termin, sowie einen Terminvorschlag.

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
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-2, app-3, app-4, ISiK-app-1
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... Slices for tag SΣ 0..* Coding Tags applied to this resource
Slice: Unordered, Open by pattern:$this
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
..... tag:Source SΣ 0..1 Coding Tags applied to this resource
Binding: VS_CommonMetaTag_De (required)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:replaces S 0..1 Reference(Appointment) Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code Der Status des Termins
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... cancelationReason SΣ 0..1 CodeableConcept Der Grund für die Absage des Termins
Binding: ISiKTerminCancelationReason (required)
... serviceType SΣ 1..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
.... text SΣ 0..1 string Plain text representation of the concept
... specialty SΣ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
.... 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 (required)
... priority S 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:Priority S 0..1 CodeableConcept Optional Extensions Element
URL: https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminPriorityExtension
Binding: ISiKTerminPriority (required)
... start SΣ 0..1 instant Der Startzeitpunkt des Termins
... end SΣ 0..1 instant Der Endzeitpunkt des Termins
... slot S 0..* Reference(Slot) Verweise auf die gebuchten Terminblöcke
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... comment S 0..1 string Zusätzliche Kommentare zum Termin zwischen Leistungserbringern
... patientInstruction S 0..1 string Anweisungen für den Patienten zum Termin
... Slices for participant SC 1..* BackboneElement Teilnehmer des Termins
Slice: Unordered, Open by type:actor.resolve()
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
...... display SΣ 0..1 string Text alternative for the resource
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:AkteurPatient SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(Patient) Person, Location/HealthcareService or Device
...... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... display SΣ 0..1 string Text alternative for the resource
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:AkteurPersonImGesundheitsberuf SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(Practitioner) Person, Location/HealthcareService or Device
...... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... display SΣ 0..1 string Text alternative for the resource
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:AkteurMedizinischeBehandlungseinheit SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(HealthcareService) Person, Location/HealthcareService or Device
...... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... display SΣ 0..1 string Text alternative for the resource
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:Angehoeriger SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(RelatedPerson) Person, Location/HealthcareService or Device
...... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... display SΣ 0..1 string Text alternative for the resource
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Appointment.meta.tag:Source Base required VS_CommonMetaTag_De 📦1.5.4 de.basisprofil.r4 v1.5
Appointment.status Base required AppointmentStatus 📍4.0.1 FHIR Std.
Appointment.cancelationReason Base required ISiKTerminCancelationReason 📦6.0.0-rc This IG
Appointment.serviceType Base example Service type 📍4.0.1 FHIR Std.
Appointment.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
Appointment.specialty.​coding:Fachrichtung Base required IHE XDS practiceSettingCode 📦2019-05-17T13:46:31 de.ihe-d.terminology v3.0
Appointment.specialty.​coding:ErweiterterFachabteilungsschluessel Base required FachabteilungsschluesselErweitert ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Appointment.participant.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPatient.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPersonImGesundheitsberuf.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:AkteurMedizinischeBehandlungseinheit.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:Angehoeriger.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ISiK-app-1 error Appointment Der Endzeitpunkt eines Termins MUSS nach dem Startzeitpunkt liegen start <= end
app-1 error Appointment.participant, Appointment.participant:AkteurPatient, Appointment.participant:AkteurPersonImGesundheitsberuf, Appointment.participant:AkteurMedizinischeBehandlungseinheit, Appointment.participant:Angehoeriger Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment 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 Appointment 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 Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment 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 Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: ISiK-app-1
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta S 0..1 Meta Metadata about the resource
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
.... Slices for tag S 0..* Coding Tags applied to this resource
Slice: Unordered, Open by pattern:$this
..... tag:Source S 0..1 Coding Tags applied to this resource
Binding: VS_CommonMetaTag_De (required)
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:replaces S 0..1 Reference(Appointment) Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces
... cancelationReason S 0..1 CodeableConcept Der Grund für die Absage des Termins
Binding: ISiKTerminCancelationReason (required)
... serviceType S 1..* CodeableConcept The specific service that is to be performed during this appointment
.... text S 0..1 string Plain text representation of the concept
... specialty S 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
.... 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 (required)
... priority S 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:Priority S 0..1 CodeableConcept Optional Extensions Element
URL: https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminPriorityExtension
Binding: ISiKTerminPriority (required)
... start S 0..1 instant Der Startzeitpunkt des Termins
... end S 0..1 instant Der Endzeitpunkt des Termins
... slot S 0..* Reference(Slot) Verweise auf die gebuchten Terminblöcke
.... reference S 1..1 string Literal reference, Relative, internal or absolute URL
... comment S 0..1 string Zusätzliche Kommentare zum Termin zwischen Leistungserbringern
... patientInstruction S 0..1 string Anweisungen für den Patienten zum Termin
... Slices for participant S 1..* BackboneElement Teilnehmer des Termins
Slice: Unordered, Open by type:actor.resolve()
.... participant:All Slices Content/Rules for all slices
..... actor S 1..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
...... display S 0..1 string Text alternative for the resource
..... status S 1..1 code accepted | declined | tentative | needs-action
.... participant:AkteurPatient S 0..* BackboneElement Participants involved in appointment
..... actor 1..1 Reference(Patient) Person, Location/HealthcareService or Device
...... reference S 1..1 string Literal reference, Relative, internal or absolute URL
.... participant:AkteurPersonImGesundheitsberuf S 0..* BackboneElement Participants involved in appointment
..... actor 1..1 Reference(Practitioner) Person, Location/HealthcareService or Device
...... reference S 1..1 string Literal reference, Relative, internal or absolute URL
.... participant:AkteurMedizinischeBehandlungseinheit S 0..* BackboneElement Participants involved in appointment
..... actor 1..1 Reference(HealthcareService) Person, Location/HealthcareService or Device
...... reference S 1..1 string Literal reference, Relative, internal or absolute URL
.... participant:Angehoeriger S 0..* BackboneElement Participants involved in appointment
..... actor 1..1 Reference(RelatedPerson) Person, Location/HealthcareService or Device
...... 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
Appointment.meta.tag:Source Base required VS_CommonMetaTag_De 📦1.5.4 de.basisprofil.r4 v1.5
Appointment.cancelationReason Base required ISiKTerminCancelationReason 📦6.0.0-rc This IG
Appointment.specialty.​coding:Fachrichtung Base required IHE XDS practiceSettingCode 📦2019-05-17T13:46:31 de.ihe-d.terminology v3.0
Appointment.specialty.​coding:ErweiterterFachabteilungsschluessel Base required FachabteilungsschluesselErweitert ValueSet 📦1.5.4 de.basisprofil.r4 v1.5

Constraints

Id Grade Path(s) Description Expression
ISiK-app-1 error Appointment Der Endzeitpunkt eines Termins MUSS nach dem Startzeitpunkt liegen start <= end
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-2, app-3, app-4, ISiK-app-1
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta SΣ 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.
.... Slices for tag SΣ 0..* Coding Tags applied to this resource
Slice: Unordered, Open by pattern:$this
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
..... tag:Source SΣ 0..1 Coding Tags applied to this resource
Binding: VS_CommonMetaTag_De (required)
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... 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:replaces S 0..1 Reference(Appointment) Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... status ?!SΣ 1..1 code Der Status des Termins
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... cancelationReason SΣ 0..1 CodeableConcept Der Grund für die Absage des Termins
Binding: ISiKTerminCancelationReason (required)
... serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType SΣ 1..* CodeableConcept The specific service that is to be performed during this appointment
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Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
.... 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 (required)
.... text Σ 0..1 string Plain text representation of the concept
... appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... reasonCode Σ 0..* CodeableConcept Coded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the appointment is to take place (resource)
... priority S 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:Priority S 0..1 CodeableConcept Optional Extensions Element
URL: https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminPriorityExtension
Binding: ISiKTerminPriority (required)
.... value 0..1 string Primitive value for unsignedInt
... description 0..1 string Shown on a subject line in a meeting request, or appointment list
... supportingInformation 0..* Reference(Resource) Additional information to support the appointment
... start SΣ 0..1 instant Der Startzeitpunkt des Termins
... end SΣ 0..1 instant Der Endzeitpunkt des Termins
... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
... slot S 0..* Reference(Slot) Verweise auf die gebuchten Terminblöcke
.... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... created 0..1 dateTime The date that this appointment was initially created
... comment S 0..1 string Zusätzliche Kommentare zum Termin zwischen Leistungserbringern
... patientInstruction S 0..1 string Anweisungen für den Patienten zum Termin
... basedOn 0..* Reference(ServiceRequest) The service request this appointment is allocated to assess
... Slices for participant SC 1..* BackboneElement Teilnehmer des Termins
Slice: Unordered, Open by type:actor.resolve()
Constraints: app-1
.... participant: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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor SΣ 1..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
...... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display SΣ 0..1 string Text alternative for the resource
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:AkteurPatient SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor SΣ 1..1 Reference(Patient) Person, Location/HealthcareService or Device
...... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display SΣ 0..1 string Text alternative for the resource
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:AkteurPersonImGesundheitsberuf SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor SΣ 1..1 Reference(Practitioner) Person, Location/HealthcareService or Device
...... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display SΣ 0..1 string Text alternative for the resource
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:AkteurMedizinischeBehandlungseinheit SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor SΣ 1..1 Reference(HealthcareService) Person, Location/HealthcareService or Device
...... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display SΣ 0..1 string Text alternative for the resource
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:Angehoeriger SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor SΣ 1..1 Reference(RelatedPerson) Person, Location/HealthcareService or Device
...... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display SΣ 0..1 string Text alternative for the resource
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
... requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Appointment.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Appointment.meta.tag:Source Base required VS_CommonMetaTag_De 📦1.5.4 de.basisprofil.r4 v1.5
Appointment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Appointment.status Base required AppointmentStatus 📍4.0.1 FHIR Std.
Appointment.cancelationReason Base required ISiKTerminCancelationReason 📦6.0.0-rc This IG
Appointment.serviceCategory Base example Service category 📍4.0.1 FHIR Std.
Appointment.serviceType Base example Service type 📍4.0.1 FHIR Std.
Appointment.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
Appointment.specialty.​coding:Fachrichtung Base required IHE XDS practiceSettingCode 📦2019-05-17T13:46:31 de.ihe-d.terminology v3.0
Appointment.specialty.​coding:ErweiterterFachabteilungsschluessel Base required FachabteilungsschluesselErweitert ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Appointment.appointmentType Base preferred hl7VS-appointmentReasonCodes 📦2.0.0 THO v7.0
Appointment.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Appointment.slot.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPatient.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPatient.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPatient.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPatient.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPersonImGesundheitsberuf.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPersonImGesundheitsberuf.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPersonImGesundheitsberuf.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPersonImGesundheitsberuf.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:AkteurMedizinischeBehandlungseinheit.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant:AkteurMedizinischeBehandlungseinheit.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:AkteurMedizinischeBehandlungseinheit.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant:AkteurMedizinischeBehandlungseinheit.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:Angehoeriger.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant:Angehoeriger.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:Angehoeriger.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant:Angehoeriger.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ISiK-app-1 error Appointment Der Endzeitpunkt eines Termins MUSS nach dem Startzeitpunkt liegen start <= end
app-1 error Appointment.participant, Appointment.participant:AkteurPatient, Appointment.participant:AkteurPersonImGesundheitsberuf, Appointment.participant:AkteurMedizinischeBehandlungseinheit, Appointment.participant:Angehoeriger Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment 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 Appointment 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 Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment 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
Appointment.cancelationReason Der Grund für die Absage des Termins

Begründung zu Must Support: Dieses Feld ist optional (0..1), muss jedoch implementiert werden (MS), um die Möglichkeit zu bieten, einen Grund für die Absage eines Termins zu hinterlegen.
Appointment.comment Zusätzliche Kommentare zum Termin zwischen Leistungserbringern

Hinweis: Im ISiK Kontext sollte dieses Feld zur internen Kommunikation zwischen Leistungserbringern verwendet werden, z.B. für interne Notizen rund um den Termin.

Begründung zum Must Support: Dieses Feld ist optional (0..1), muss jedoch implementiert werden (MS), um die Möglichkeit zu bieten, zusätzliche Informationen zum Termin zu hinterlegen und abrufen zu können.

Es gilt weiterhin die Semantik des Elements nach FHIR-Kernspezifikation:

‘Additional text to aid in facilitating the appointment. For instance, a comment might be, ‘patient should proceed immediately to infusion room upon arrival’

Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.’
Appointment.end Der Endzeitpunkt des Termins

Begründung zu Kardinalität und Must Support: Der Endzeitpunkt eines Termins ist von entscheidender Bedeutung, um die Verfügbarkeit und Planung des Termins zu gewährleisten. Daher muss dieses Feld unterstützt werden (MS). Das Feld ist in den meisten Fällen verpflichtend, nur für die Status ‘proposed’, ‘cancelled’, ‘waitlist’ existiert kein Wert.
Appointment.extension

Begründung zum Must Support: Termineabsagen sollten verkettbar sein, da am originalen Termin noch weitere Informationen hängen können.
Appointment.extension:replaces
Appointment.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.
Appointment.meta

Ein Tag kann verwendet werden um zu kennzeichnen, dass die Ressource von Extern erstellt worden ist.
Appointment.meta.tag
Appointment.meta.tag:Source
Appointment.participant Teilnehmer des Termins

Hinweis: Die Kardinalität von actor.display und das MS-Flag von .status wird an die Slices vererbt und diese sind entsprechend zu implementieren.

Begründung zu Kardinalität und Must Support: Die Teilnehmer eines Termins sind von entscheidender Bedeutung, um die Verfügbarkeit und Planung des Termins zu gewährleisten. Daher muss dieses Feld unterstützt werden (MS).
Appointment.participant.actor
Appointment.participant.actor.display

Hinweis: 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 welche Akteure für den Termin relevant sind.
Appointment.participant.status
Appointment.participant:AkteurMedizinischeBehandlungseinheit
Appointment.participant:AkteurMedizinischeBehandlungseinheit.actor.reference
Appointment.participant:AkteurPatient

Hinweis: Im ISIK-Kontext MUSS der referenzierte Patient konform zum ISIKPatient des Basismoduls sein. Ein Sonderfall sind Patienten, über die ein Termin-Requestor oder Termin-Repository nur rudimentäre Informationen verfügt. Diese Patienten-Ressourcen sind bis zur Vervollständigung nur gegen den Kernstandard valide.

Begründung zu Kardinalität und Must Support: Die teilnehmenden Patienten eines Termins sind von entscheidender Bedeutung, um die Verfügbarkeit und Planung des Termins zu gewährleisten. Daher muss dieses Feld unterstützt werden (MS). Hingegen kann die Patienten-Referenz separat in der $book-Operation übergeben werden, sodass hier keine verpflichtende Kardinaltiät gewählt werden kann.
Appointment.participant:AkteurPatient.actor.reference
Appointment.participant:AkteurPersonImGesundheitsberuf

​Im ISIK-Kontext MUSS die referenzierte RelatedPerson-Ressource konform zum ISiKAngehoeriger des Basismoduls sein.

Begründung zu Kardinalität und Must Support: Die Angabe eines Angehörigen ist optional, da in vielen Fällen die Referenzierung des Patienten ausreichend ist. Bei Terminen, die durch einen Angehörigen gebucht/verwaltet werden, ist es jedoch wichtig, dass diese Information an das Termin-Repository übermittelt werden kann.
Appointment.participant:AkteurPersonImGesundheitsberuf.actor.reference
Appointment.participant:Angehoeriger
Appointment.participant:Angehoeriger.actor.reference
Appointment.patientInstruction Anweisungen für den Patienten zum Termin

Hinweis: Dieses Feld sollte im Kontext von ISIK verwendet werden für die Kommunikation im Sinne der Definition der FHIR-Kernspezifikation - sowohl von Systemseite (administrativ) als auch von Seiten des medizinischen Fachpersonals.

Beispiel für eine Nachricht: ‘Bitte nüchtern erscheinen’ etc.

Begründung zum Must Support: Dieses Feld ist optional (0..1), muss jedoch implementiert werden (MS), um die Möglichkeit zu bieten, zusätzliche Informationen für Patienten zum Termin zu hinterlegen und abrufen zu können.

Es gilt weiterhin der Hinweis der FHIR Kernspezifikation: ‘Note that FHIR strings SHALL NOT exceed 1MB in size’
Appointment.priority

Begründung Must Support: Die Priorität eines Termins ist von entscheidender Bedeutung, um die Dringlichkeit und Relevanz des Termins zu kommunizieren und zu priorisieren. Eine Priorität ist nicht zwingend erforderlich, muss jedoch implementiert werden (MS), um die Möglichkeit zu bieten, die Dringlichkeit und Relevanz des Termins abzurufen.
Appointment.priority.extension

Hinweis: In R5 ist die Priority ein CodeableConcept.

Begründung zu Must Support: Dieses Element ist optional (0..1), muss jedoch implementiert werden (MS), um besonders einen Notfall als solchen ausweisen zu können.
Appointment.priority.extension:Priority
Appointment.serviceType

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.
Appointment.serviceType.text
Appointment.slot Verweise auf die gebuchten Terminblöcke

Begründung zu Kardinalität und Must Support: Die Kardinalität der slot-Eigenschaft bleibt 0..*, sodass ein Termin-Requestor bei der Terminbuchung nur einen Termin und ein Verweis auf ein ISiKKalender übergeben kann. Es ist dann die Aufgabe des Termin-Repositories in Abhängigkeit der gebuchten Dienstleistung freie Terminblöcke zu finden. Diese sind im Appointment zu referenzieren.
Appointment.slot.reference
Appointment.specialty

Optionale Angabe aller Fachbereiche aus denen ein oder mehrere Akteure für die Durchführung des Termins benötigt werden.

Begründung zu Kardinalität und Must Support: KANN auch anhand des Kalenders, in dem ein Termin gebucht wird, ermittelt werden. Die Angabe der Fachbereiche ist optional (0..*), muss jedoch implementiert werden (MS), um die Spezialisierung hinsichtlich der zugeordneten Behandlungseinheit des Termins eindeutig zu definieren und eine korrekte Zuordnung zu gewährleisten.
Appointment.specialty.coding
Appointment.specialty.coding:Fachrichtung

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

Hintergrund zur Entscheidung: 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).
Appointment.start Der Startzeitpunkt des Termins

Begründung zu Kardinalität und Must Support: Der Startzeitpunkt eines Termins ist von entscheidender Bedeutung, um die Verfügbarkeit und Planung des Termins zu gewährleisten. Daher muss dieses Feld unterstützt werden (MS). Das Feld ist in den meisten Fällen verpflichtend, nur für die Status ‘proposed’, ‘cancelled’, ‘waitlist’ existiert kein Wert.
Appointment.status Der Status des Termins

Begründung zu Must Support : Im ISiK Kontext ist der Status eines Termins von entscheidender Bedeutung, um den aktuellen Stand und die Verfügbarkeit des Termins zu kommunizieren.

This structure is derived from Appointment

Summary

Mandatory: 2 elements(7 nested mandatory elements)
Must-Support: 34 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 Appointment.meta.tag
  • The element 1 is sliced based on the value of Appointment.specialty.coding
  • The element 1 is sliced based on the value of Appointment.participant

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-2, app-3, app-4, ISiK-app-1
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta SΣ 0..1 Meta Metadata about the resource
.... versionId Σ 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated Σ 0..1 instant Zeitpunkt der letzten Änderung
.... Slices for tag SΣ 0..* Coding Tags applied to this resource
Slice: Unordered, Open by pattern:$this
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
..... tag:Source SΣ 0..1 Coding Tags applied to this resource
Binding: VS_CommonMetaTag_De (required)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:replaces S 0..1 Reference(Appointment) Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code Der Status des Termins
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... cancelationReason SΣ 0..1 CodeableConcept Der Grund für die Absage des Termins
Binding: ISiKTerminCancelationReason (required)
... serviceType SΣ 1..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
.... text SΣ 0..1 string Plain text representation of the concept
... specialty SΣ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
.... 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 (required)
... priority S 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:Priority S 0..1 CodeableConcept Optional Extensions Element
URL: https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminPriorityExtension
Binding: ISiKTerminPriority (required)
... start SΣ 0..1 instant Der Startzeitpunkt des Termins
... end SΣ 0..1 instant Der Endzeitpunkt des Termins
... slot S 0..* Reference(Slot) Verweise auf die gebuchten Terminblöcke
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... comment S 0..1 string Zusätzliche Kommentare zum Termin zwischen Leistungserbringern
... patientInstruction S 0..1 string Anweisungen für den Patienten zum Termin
... Slices for participant SC 1..* BackboneElement Teilnehmer des Termins
Slice: Unordered, Open by type:actor.resolve()
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
...... display SΣ 0..1 string Text alternative for the resource
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:AkteurPatient SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(Patient) Person, Location/HealthcareService or Device
...... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... display SΣ 0..1 string Text alternative for the resource
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:AkteurPersonImGesundheitsberuf SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(Practitioner) Person, Location/HealthcareService or Device
...... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... display SΣ 0..1 string Text alternative for the resource
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:AkteurMedizinischeBehandlungseinheit SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(HealthcareService) Person, Location/HealthcareService or Device
...... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... display SΣ 0..1 string Text alternative for the resource
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:Angehoeriger SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(RelatedPerson) Person, Location/HealthcareService or Device
...... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
...... display SΣ 0..1 string Text alternative for the resource
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Appointment.meta.tag:Source Base required VS_CommonMetaTag_De 📦1.5.4 de.basisprofil.r4 v1.5
Appointment.status Base required AppointmentStatus 📍4.0.1 FHIR Std.
Appointment.cancelationReason Base required ISiKTerminCancelationReason 📦6.0.0-rc This IG
Appointment.serviceType Base example Service type 📍4.0.1 FHIR Std.
Appointment.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
Appointment.specialty.​coding:Fachrichtung Base required IHE XDS practiceSettingCode 📦2019-05-17T13:46:31 de.ihe-d.terminology v3.0
Appointment.specialty.​coding:ErweiterterFachabteilungsschluessel Base required FachabteilungsschluesselErweitert ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Appointment.participant.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPatient.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPersonImGesundheitsberuf.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:AkteurMedizinischeBehandlungseinheit.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:Angehoeriger.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ISiK-app-1 error Appointment Der Endzeitpunkt eines Termins MUSS nach dem Startzeitpunkt liegen start <= end
app-1 error Appointment.participant, Appointment.participant:AkteurPatient, Appointment.participant:AkteurPersonImGesundheitsberuf, Appointment.participant:AkteurMedizinischeBehandlungseinheit, Appointment.participant:Angehoeriger Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment 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 Appointment 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 Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment 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 Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: ISiK-app-1
... id S 0..1 id serverseitige, interne ID des Datensatzes
... meta S 0..1 Meta Metadata about the resource
.... versionId 0..1 id Eindeutiger Name der serverseitigen Version des Datensatzes
.... lastUpdated 0..1 instant Zeitpunkt der letzten Änderung
.... Slices for tag S 0..* Coding Tags applied to this resource
Slice: Unordered, Open by pattern:$this
..... tag:Source S 0..1 Coding Tags applied to this resource
Binding: VS_CommonMetaTag_De (required)
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:replaces S 0..1 Reference(Appointment) Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces
... cancelationReason S 0..1 CodeableConcept Der Grund für die Absage des Termins
Binding: ISiKTerminCancelationReason (required)
... serviceType S 1..* CodeableConcept The specific service that is to be performed during this appointment
.... text S 0..1 string Plain text representation of the concept
... specialty S 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
.... 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 (required)
... priority S 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:Priority S 0..1 CodeableConcept Optional Extensions Element
URL: https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminPriorityExtension
Binding: ISiKTerminPriority (required)
... start S 0..1 instant Der Startzeitpunkt des Termins
... end S 0..1 instant Der Endzeitpunkt des Termins
... slot S 0..* Reference(Slot) Verweise auf die gebuchten Terminblöcke
.... reference S 1..1 string Literal reference, Relative, internal or absolute URL
... comment S 0..1 string Zusätzliche Kommentare zum Termin zwischen Leistungserbringern
... patientInstruction S 0..1 string Anweisungen für den Patienten zum Termin
... Slices for participant S 1..* BackboneElement Teilnehmer des Termins
Slice: Unordered, Open by type:actor.resolve()
.... participant:All Slices Content/Rules for all slices
..... actor S 1..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
...... display S 0..1 string Text alternative for the resource
..... status S 1..1 code accepted | declined | tentative | needs-action
.... participant:AkteurPatient S 0..* BackboneElement Participants involved in appointment
..... actor 1..1 Reference(Patient) Person, Location/HealthcareService or Device
...... reference S 1..1 string Literal reference, Relative, internal or absolute URL
.... participant:AkteurPersonImGesundheitsberuf S 0..* BackboneElement Participants involved in appointment
..... actor 1..1 Reference(Practitioner) Person, Location/HealthcareService or Device
...... reference S 1..1 string Literal reference, Relative, internal or absolute URL
.... participant:AkteurMedizinischeBehandlungseinheit S 0..* BackboneElement Participants involved in appointment
..... actor 1..1 Reference(HealthcareService) Person, Location/HealthcareService or Device
...... reference S 1..1 string Literal reference, Relative, internal or absolute URL
.... participant:Angehoeriger S 0..* BackboneElement Participants involved in appointment
..... actor 1..1 Reference(RelatedPerson) Person, Location/HealthcareService or Device
...... 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
Appointment.meta.tag:Source Base required VS_CommonMetaTag_De 📦1.5.4 de.basisprofil.r4 v1.5
Appointment.cancelationReason Base required ISiKTerminCancelationReason 📦6.0.0-rc This IG
Appointment.specialty.​coding:Fachrichtung Base required IHE XDS practiceSettingCode 📦2019-05-17T13:46:31 de.ihe-d.terminology v3.0
Appointment.specialty.​coding:ErweiterterFachabteilungsschluessel Base required FachabteilungsschluesselErweitert ValueSet 📦1.5.4 de.basisprofil.r4 v1.5

Constraints

Id Grade Path(s) Description Expression
ISiK-app-1 error Appointment Der Endzeitpunkt eines Termins MUSS nach dem Startzeitpunkt liegen start <= end

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Constraints: app-2, app-3, app-4, ISiK-app-1
... id SΣ 0..1 id serverseitige, interne ID des Datensatzes
... meta SΣ 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.
.... Slices for tag SΣ 0..* Coding Tags applied to this resource
Slice: Unordered, Open by pattern:$this
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
..... tag:Source SΣ 0..1 Coding Tags applied to this resource
Binding: VS_CommonMetaTag_De (required)
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... 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:replaces S 0..1 Reference(Appointment) Extension
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... status ?!SΣ 1..1 code Der Status des Termins
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... cancelationReason SΣ 0..1 CodeableConcept Der Grund für die Absage des Termins
Binding: ISiKTerminCancelationReason (required)
... serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType SΣ 1..* CodeableConcept The specific service that is to be performed during this appointment
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Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
.... 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 (required)
.... text Σ 0..1 string Plain text representation of the concept
... appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... reasonCode Σ 0..* CodeableConcept Coded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the appointment is to take place (resource)
... priority S 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:Priority S 0..1 CodeableConcept Optional Extensions Element
URL: https://gematik.de/fhir/isik/StructureDefinition/ISiKTerminPriorityExtension
Binding: ISiKTerminPriority (required)
.... value 0..1 string Primitive value for unsignedInt
... description 0..1 string Shown on a subject line in a meeting request, or appointment list
... supportingInformation 0..* Reference(Resource) Additional information to support the appointment
... start SΣ 0..1 instant Der Startzeitpunkt des Termins
... end SΣ 0..1 instant Der Endzeitpunkt des Termins
... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
... slot S 0..* Reference(Slot) Verweise auf die gebuchten Terminblöcke
.... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... created 0..1 dateTime The date that this appointment was initially created
... comment S 0..1 string Zusätzliche Kommentare zum Termin zwischen Leistungserbringern
... patientInstruction S 0..1 string Anweisungen für den Patienten zum Termin
... basedOn 0..* Reference(ServiceRequest) The service request this appointment is allocated to assess
... Slices for participant SC 1..* BackboneElement Teilnehmer des Termins
Slice: Unordered, Open by type:actor.resolve()
Constraints: app-1
.... participant: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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor SΣ 1..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
...... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display SΣ 0..1 string Text alternative for the resource
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:AkteurPatient SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor SΣ 1..1 Reference(Patient) Person, Location/HealthcareService or Device
...... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display SΣ 0..1 string Text alternative for the resource
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:AkteurPersonImGesundheitsberuf SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor SΣ 1..1 Reference(Practitioner) Person, Location/HealthcareService or Device
...... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display SΣ 0..1 string Text alternative for the resource
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:AkteurMedizinischeBehandlungseinheit SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor SΣ 1..1 Reference(HealthcareService) Person, Location/HealthcareService or Device
...... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display SΣ 0..1 string Text alternative for the resource
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:Angehoeriger SC 0..* BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor SΣ 1..1 Reference(RelatedPerson) Person, Location/HealthcareService or Device
...... 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 Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display SΣ 0..1 string Text alternative for the resource
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
... requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Appointment.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Appointment.meta.tag:Source Base required VS_CommonMetaTag_De 📦1.5.4 de.basisprofil.r4 v1.5
Appointment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Appointment.status Base required AppointmentStatus 📍4.0.1 FHIR Std.
Appointment.cancelationReason Base required ISiKTerminCancelationReason 📦6.0.0-rc This IG
Appointment.serviceCategory Base example Service category 📍4.0.1 FHIR Std.
Appointment.serviceType Base example Service type 📍4.0.1 FHIR Std.
Appointment.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
Appointment.specialty.​coding:Fachrichtung Base required IHE XDS practiceSettingCode 📦2019-05-17T13:46:31 de.ihe-d.terminology v3.0
Appointment.specialty.​coding:ErweiterterFachabteilungsschluessel Base required FachabteilungsschluesselErweitert ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
Appointment.appointmentType Base preferred hl7VS-appointmentReasonCodes 📦2.0.0 THO v7.0
Appointment.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Appointment.slot.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPatient.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPatient.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPatient.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPatient.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPersonImGesundheitsberuf.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPersonImGesundheitsberuf.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPersonImGesundheitsberuf.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant:AkteurPersonImGesundheitsberuf.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:AkteurMedizinischeBehandlungseinheit.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant:AkteurMedizinischeBehandlungseinheit.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:AkteurMedizinischeBehandlungseinheit.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant:AkteurMedizinischeBehandlungseinheit.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.
Appointment.participant:Angehoeriger.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Appointment.participant:Angehoeriger.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Appointment.participant:Angehoeriger.​required Base required ParticipantRequired 📍4.0.1 FHIR Std.
Appointment.participant:Angehoeriger.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ISiK-app-1 error Appointment Der Endzeitpunkt eines Termins MUSS nach dem Startzeitpunkt liegen start <= end
app-1 error Appointment.participant, Appointment.participant:AkteurPatient, Appointment.participant:AkteurPersonImGesundheitsberuf, Appointment.participant:AkteurMedizinischeBehandlungseinheit, Appointment.participant:Angehoeriger Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment 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 Appointment 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 Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment 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 Appointment

Summary

Mandatory: 2 elements(7 nested mandatory elements)
Must-Support: 34 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 Appointment.meta.tag
  • The element 1 is sliced based on the value of Appointment.specialty.coding
  • The element 1 is sliced based on the value of Appointment.participant

 

Other representations of profile: CSV, Excel, Schematron