Terminbuchung (Appointment)


Fachlicher Kontext

Scope Art
Buchungsinformationen abrufen Ausgabeparameter (als Teil des Result Bundles)

Die Terminschnittstelle für Dritte ermöglicht das Abrufen von Informationen über eine zuvor durchgeführte Terminbuchung. Um dem Patienten Details zu einer Terminbuchung anzeigen zu können, sind folgende Information notwendig:

  • Startzeitpunkt des Termins
  • Endzeitpunkt des Termins
  • Termintyp
  • Leistungsmerkmale
  • Zeitpunkt der Terminbuchung

Diese Informationen sind (zusammen mit einigen anderen, vom Basis-Profil erzwungenen Angaben) in dem vorliegenden Profil gebündelt.



FHIR-Profil

Name KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment
Type Appointment
Base Definition http://hl7.org/fhir/StructureDefinition/Appointment (Version: R4)
Canonical URL https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..0id
lastUpdatedΣ0..0instant
sourceΣ0..0uri
id0..1string
extensionI0..*Extension
value1..1System.StringPattern
securityΣ0..0CodingBinding
tagΣ0..0Coding
implicitRulesΣ ?!0..0uri
language0..0codeBinding
id0..1string
extensionI0..*Extension
statusS1..1codeBindingFixed Value
divS I1..1xhtml
contained0..0Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..0Identifier
statusS Σ ?!1..1codeBinding
cancelationReasonΣ0..0CodeableConcept
serviceCategoryΣ0..0CodeableConcept
serviceTypeΣ0..0CodeableConcept
id0..1string
extensionI0..*Extension
idS0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionS Σ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
textΣ0..0string
id0..1string
extensionI0..*Extension
idS0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionS Σ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
textΣ0..0string
reasonCodeΣ0..0CodeableConceptBinding
reasonReferenceI0..0Reference(Condition | Procedure | Observation | ImmunizationRecommendation)
priority0..0unsignedInt
description0..0string
supportingInformationI0..0Reference(Resource)
startS Σ1..1instant
endS Σ1..1instant
minutesDuration0..0positiveInt
slotI0..0Reference(Slot)
createdS1..1dateTime
comment0..0string
patientInstruction0..0string
basedOnI0..0Reference(ServiceRequest)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..0CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..0uriBinding
identifierΣ0..0Identifier
displayΣ0..0string
requiredΣ0..0codeBinding
statusS Σ1..1codeBindingFixed Value
periodI0..0Period
requestedPeriodI0..0Period
Appointment
DefinitionTermin einer zu behandelnden Person in einer Praxis/medizinischen Einrichtung basierend auf einem Vermittlungscode
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • app-4: 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')
  • app-3: Only proposed or cancelled appointments can be missing start/end dates
    (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
  • app-2: Either start and end are specified, or neither
    start.exists() = end.exists()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Request
  • rim: Act[@moodCode <= 'INT']
  • ical: VEVENT
Appointment.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Appointment.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality1...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Appointment.meta.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Appointment.meta.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.meta.versionId
DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Cardinality0...0
Typeid
SummaryTrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Appointment.meta.lastUpdated
DefinitionWhen the resource last changed - e.g. when the version changed.
Cardinality0...0
Typeinstant
SummaryTrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Appointment.meta.source
DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Cardinality0...0
Typeuri
SummaryTrue
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Appointment.meta.profile
DefinitionA list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
Cardinality1...*
Typecanonical(StructureDefinition)
SummaryTrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

SlicingUnordered, Open, by value(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Appointment.meta.profile:kvdigitalProfil
DefinitionA list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
Cardinality1...1
Typecanonical(StructureDefinition)
SummaryTrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Appointment.meta.profile:kvdigitalProfil.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Appointment.meta.profile:kvdigitalProfil.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.meta.profile:kvdigitalProfil.value
DefinitionPrimitive value for canonical
Cardinality1...1
TypeSystem.String
Pattern

https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment|1.0.0

Appointment.meta.security
DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality0...0
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)
SummaryTrue
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
Appointment.meta.tag
DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Cardinality0...0
TypeCoding
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)
SummaryTrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
Appointment.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...0
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Appointment.language
DefinitionThe base language in which the resource is written.
Cardinality0...0
Typecode
Binding

A human language.

CommonLanguages (preferred)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Appointment.text
DefinitionIn diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind.
Cardinality0...1
TypeNarrative
Must SupportTrue
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
Appointment.text.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Appointment.text.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.text.status
DefinitionThe status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Cardinality1...1
Typecode
Binding

The status of a resource narrative.

NarrativeStatus (required)
Must SupportTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

extensions

Mappings
  • rim: n/a
  • rim: N/A
Appointment.text.div
DefinitionThe actual narrative content, a stripped down version of XHTML.
Cardinality1...1
Typexhtml
Must SupportTrue
Comments

The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
    htmlChecks()
  • txt-2: The narrative SHALL have some non-whitespace content
    htmlChecks()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...0
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
Appointment.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.identifier
DefinitionThis records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
Cardinality0...0
TypeIdentifier
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • workflow: Request.identifier
  • w5: FiveWs.identifier
  • v2: SCH-1, SCH-2, ARQ-1, ARQ-2
  • rim: .id
  • ical: UID
Appointment.status
DefinitionStatus des Termins: pending = frei | booked = gebucht | cancelled = abgesagt
Cardinality1...1
Typecode
Binding

The free/busy status of an appointment.

KBV_VS_KV_DIGITAL_TS_DRITTE_Appointment_Status (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Comments

Aktuell ist ein Termin nur vorhanden, wenn er tatsächlich gebucht und nicht abgesagt wurde. Daher ist der Status aktuell immer "booked".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.status
  • w5: FiveWs.status
  • v2: SCH-25
  • rim: .statusCode
  • ical: STATUS
Appointment.cancelationReason
DefinitionThe coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
Cardinality0...0
TypeCodeableConcept
BindingAppointmentCancellationReason (example)
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
Appointment.serviceCategory
DefinitionA broad categorization of the service that is to be performed during this appointment.
Cardinality0...0
TypeCodeableConcept
BindingServiceCategory (example)
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: n/a, might be inferred from the ServiceDeliveryLocation
  • ical: CATEGORIES
Appointment.serviceType
DefinitionThe specific service that is to be performed during this appointment.
Cardinality0...0
TypeCodeableConcept
BindingServiceType (example)
SummaryTrue
Comments

For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Request.code
  • rim: n/a, might be inferred from the ServiceDeliveryLocation
Appointment.specialty
DefinitionDie gebuchten Leistungsmerkmale sind die Schnittmenge aus den vom User gesuchten und zum Terminslot angebotenen Leistungsmerkmalen, wobei auch gleichwertige Leistungsmerkmale enthalten sein können. Hierzu gehören Arztgruppen, WBO-Kennziffern, Zusatzqualifikationen und U-Untersuchungen.
Cardinality1...*
TypeCodeableConcept
BindingKBV_VS_KV_DIGITAL_TS_DRITTE_Specialties (required)
Must SupportTrue
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
  • rim: .performer.AssignedPerson.code
Appointment.specialty.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Appointment.specialty.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.specialty.coding
DefinitionVorgegebenes Coding zu einem Leistungsmerkmal
Cardinality1...1
TypeCoding
Must SupportTrue
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Appointment.specialty.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Must SupportTrue
Mappings
  • rim: n/a
Appointment.specialty.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.specialty.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Appointment.specialty.coding.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Appointment.specialty.coding.code
DefinitionDer Code der WBO-Kennziffer, Genehmigung oder Zusatzqualifikation gemäß der von der KBV veröffentlichten Schlüsseltabellen (bspw. "027")
Cardinality1...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Appointment.specialty.coding.display
DefinitionMenschenlesbare Bezeichnung des Leistungsmerkmals gemäß der von der KBV veröffentlichten Schlüsseltabellen (bspw. die Arztgruppe "Hausärzte", die WBO "TG Hämatologie" oder die Zusatzqualifikation "Allergologie")
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Appointment.specialty.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Appointment.specialty.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...0
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Appointment.appointmentType
DefinitionAMB = Vor-Ort-Termin VR = Videosprechstunde
Cardinality1...1
TypeCodeableConcept
BindingKBV_VS_KV_DIGITAL_TS_DRITTE_Appointment_Type (required)
Must SupportTrue
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: ARQ-7
  • rim: .code
  • ical: CLASSIFICATION
Appointment.appointmentType.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Appointment.appointmentType.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.appointmentType.coding
DefinitionVorgegebenes Coding zum Typ des Termins
Cardinality1...1
TypeCoding
Must SupportTrue
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Appointment.appointmentType.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Must SupportTrue
Mappings
  • rim: n/a
Appointment.appointmentType.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.appointmentType.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://terminology.hl7.org/CodeSystem/v3-ActCode

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Appointment.appointmentType.coding.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Appointment.appointmentType.coding.code
DefinitionDer Code definiert, ob es sich bei dem Terminslot um einen Präsenztermin (AMB) oder eine Videosprechstunde (VR) handelt.
Cardinality1...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Aktuell werden nur Videosprechstundentermine abgebildet; d.h., aktuell ist der Code immer "VR".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Appointment.appointmentType.coding.display
DefinitionVor-Ort-Termin oder Videosprechstunde
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Aktuell werden nur Videosprechstundentermine abgebildet; d.h., aktuell ist der display-Wert immer "Videosprechstunde".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Appointment.appointmentType.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Appointment.appointmentType.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...0
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Appointment.reasonCode
DefinitionThe coded reason that this appointment is being scheduled. This is more clinical than administrative.
Cardinality0...0
TypeCodeableConcept
Binding

The Reason for the appointment to take place.

EncounterReasonCodes (preferred)
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Request.reasonCode
  • v2: AIS-3, SCH-7
  • rim: .reasonCode
Appointment.reasonReference
DefinitionReason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
Cardinality0...0
TypeReference(Condition | Procedure | Observation | ImmunizationRecommendation)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.reasonReference
  • rim: .inboundRelationship[@typeCode = 'RSON'].observation
Appointment.priority
DefinitionThe priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
Cardinality0...0
TypeunsignedInt
Comments

Seeking implementer feedback on this property and how interoperable it is.

Using an extension to record a CodeableConcept for named values may be tested at a future connectathon.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.priority
  • w5: FiveWs.class
  • v2: ARQ-12, SCH-11.6 / TQ1-9
  • rim: .priorityCode
  • ical: PRIORITY
Appointment.description
DefinitionThe brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
Cardinality0...0
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: NTE-3
  • rim: .text
  • ical: SUMMARY
Appointment.supportingInformation
DefinitionAdditional information to support the appointment provided when making the appointment.
Cardinality0...0
TypeReference(Resource)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.supportingInfo
  • w5: FiveWs.context
  • rim: .inboundRelationship[@typeCode = 'SPRT'].observation
  • ical: ATTACH
Appointment.start
DefinitionDatum und Uhrzeit, zu der der Termin startet
Cardinality1...1
Typeinstant
Must SupportTrue
SummaryTrue
Comments

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.occurrence[x]
  • w5: FiveWs.init
  • v2: ARQ-11.1, SCH-11.4 / TQ1-7
  • rim: .effectiveTime.low
  • ical: DTSTART
Appointment.end
DefinitionDatum und Uhrzeit, zu der der Termin endet
Cardinality1...1
Typeinstant
Must SupportTrue
SummaryTrue
Comments

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.occurrence[x]
  • w5: FiveWs.done[x]
  • v2: SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9
  • rim: .effectiveTime.high
  • ical: DTEND
Appointment.minutesDuration
DefinitionNumber of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
Cardinality0...0
TypepositiveInt
Comments

32 bit number; for values larger than this, use decimal

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.occurrence[x]
  • rim: .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width
  • ical: DURATION (e.g. PT15M)
Appointment.slot
DefinitionThe slots from the participants' schedules that will be filled by the appointment.
Cardinality0...0
TypeReference(Slot)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']
Appointment.created
DefinitionDatum und Uhrzeit, wann der Termin erstellt - d.h., durch einen Drittanbieter für einen Patienten gebucht - wurde.
Cardinality1...1
TypedateTime
Must SupportTrue
Comments

This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.authoredOn
  • rim: .author.time
  • ical: CREATED
Appointment.comment
DefinitionAdditional comments about the appointment.
Cardinality0...0
Typestring
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.note
  • v2: NTE-3
  • rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
  • ical: DESCRIPTION (for internal use)
Appointment.patientInstruction
DefinitionWhile Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
Cardinality0...0
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: NTE-3
  • rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
  • ical: DESCRIPTION (for patient use)
Appointment.basedOn
DefinitionThe service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
Cardinality0...0
TypeReference(ServiceRequest)
AliasincomingReferral
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.basedOn
  • rim: .outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']
Appointment.participant
DefinitionHier wird auf die Location der Praxis/medizinischen Einrichtung referenziert, die den Termin anbietet.
Cardinality1...1
TypeBackboneElement
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • app-1: Either the type or actor on the participant SHALL be specified
    type.exists() or actor.exists()
Mappings
  • rim: n/a
  • workflow: Request.performer, Request.subject
  • v2: PID, AIP, AIG, AIL
  • rim: performer | reusableDevice | subject | location
  • ical: ATTENDEE component to be created
Appointment.participant.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Appointment.participant.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.participant.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.participant.type
DefinitionRole of participant in the appointment.
Cardinality0...0
TypeCodeableConcept
Binding

Role of participant in encounter.

ParticipantType (extensible)
SummaryTrue
Comments

The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.

If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.

This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: AIP-4, AIG-4
  • rim: (performer | reusableDevice | subject | location).@typeCode
  • ical: n/a
Appointment.participant.actor
DefinitionReferenz auf die Location der Praxis/medizinischen Einrichtung, die den Termin anbietet
Cardinality1...1
TypeReference(KBV_PR_KV_DIGITAL_TS_DRITTE_Location)
Must SupportTrue
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.who
  • v2: PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3
  • rim: performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
  • ical: ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"
Appointment.participant.actor.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Appointment.participant.actor.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Appointment.participant.actor.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Appointment.participant.actor.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...0
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Appointment.participant.actor.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...0
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
Appointment.participant.actor.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...0
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Appointment.participant.required
DefinitionWhether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.
Cardinality0...0
Typecode
Binding

Is the Participant required to attend the appointment.

ParticipantRequired (required)
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: (performer | reusableDevice | subject | location).@performInd
  • ical: ROLE=REQ-PARTICIPANT (roleparam)
Appointment.participant.status
DefinitionParticipation status of the actor.
Cardinality1...1
Typecode
Binding

The Participation status of an appointment.

ParticipationStatus (required)
Must SupportTrue
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

accepted

Mappings
  • rim: n/a
  • v2: AIP-12, AIG-14
  • rim: (performer | reusableDevice | subject | location).statusCode
  • ical: ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)
Appointment.participant.period
DefinitionParticipation period of the actor.
Cardinality0...0
TypePeriod
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
Appointment.requestedPeriod
DefinitionA set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.
Cardinality0...0
TypePeriod
Comments

This does not introduce a capacity for recurring appointments.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • workflow: Request.occurrence[x]
  • v2: ARQ-11
  • rim: .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="KBV-PR-KV-DIGITAL-TS-DRITTE-Appointment" />
    <text>
        <status value="generated" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <url value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment" />
    <version value="1.0.0" />
    <name value="KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment" />
    <title value="KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment" />
    <status value="active" />
    <publisher value="kv.digital GmbH" />
    <contact>
        <name value="kv.digital GmbH" />
        <telecom>
            <system value="url" />
            <value value="https://www.kv.digital/" />
        </telecom>
    </contact>
    <description value="Termin einer zu behandelnden Person in einer Praxis/medizinischen Einrichtung basierend auf einem Vermittlungscode" />
    <copyright value="Im folgenden Profil k&#246;nnen Codes aus den Code-Systemen SNOMED CT&#174;, LOINC, Ucum, ATC, ICD-10-GM, ICD-10-WHO, OPS, Alpha-ID/Alpha-ID-SE und ICF enthalten sein, die dem folgenden Urheberrecht unterliegen: This material includes SNOMED CT&#174; Clinical Terms&#174; (SNOMED CT&#174; CT&#174;) which is used by permission of SNOMED CT&#174; International. All rights reserved. SNOMED CT&#174; CT&#174;, was originally created by The College of American Pathologists. SNOMED CT&#174; and SNOMED CT&#174; CT are registered trademarks of SNOMED CT&#174; International. Implementers of these artefacts must have the appropriate SNOMED CT&#174; CT Affiliate license. This material contains content from LOINC (http://LOINC.org). LOINC is copyright &#169; 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://LOINC.org/license. LOINC&#174; is a registered United States trademark of Regenstrief Institute, Inc. This product includes all or a portion of the UCUM table, UCUM codes, and UCUM definitions or is derived from it, subject to a license from Regenstrief Institute, Inc. and The UCUM Organization. Your use of the UCUM table, UCUM codes, UCUM definitions also is subject to this license, a copy of which is available at http://unitsofmeasure.org. The current complete UCUM table, UCUM Specification are available for download at http://unitsofmeasure.org. The UCUM table and UCUM codes are copyright &#169; 1995-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. THE UCUM TABLE (IN ALL FORMATS), UCUM DEFINITIONS, AND SPECIFICATION ARE PROVIDED &#39;AS IS.&#39; ANY EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Dieses Material enth&#228;lt Inhalte aus ATC. Die Erstellung erfolgte unter Verwendung der Datentr&#228;ger der amtlichen Fassung der ATCKlassifikation mit DDD des Bundesinstituts f&#252;r Arzneimittel und Medizinprodukte (BfArM). Dieses Material enth&#228;lt Inhalte aus ICD-10-GM, ICD-10-WHO, OPS Alpha-ID ans Alpha-ID-SE. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Bundesinstituts f&#252;r Arzneimittel und Medizinprodukte (BfArM). Dieses Material enth&#228;lt Inhalte aus ICF. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Deutschen Instituts f&#252;r Medizinische Dokumentation und Information (DIMDI). ICF-Kodes, -Begriffe und -Texte &#169; Weltgesundheitsorganisation, &#252;bersetzt und herausgegeben durch das Deutsche Institut f&#252;r Medizinische Dokumentation und Information von der International classification of functioning, disability and health - ICF, herausgegeben durch die Weltgesundheitsorganisation." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Appointment" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Appointment" />
    <derivation value="constraint" />
    <differential>
        <element id="Appointment">
            <path value="Appointment" />
            <short value="Termin" />
            <definition value="Termin einer zu behandelnden Person in einer Praxis/medizinischen Einrichtung basierend auf einem Vermittlungscode" />
        </element>
        <element id="Appointment.meta">
            <path value="Appointment.meta" />
            <min value="1" />
        </element>
        <element id="Appointment.meta.versionId">
            <path value="Appointment.meta.versionId" />
            <max value="0" />
        </element>
        <element id="Appointment.meta.lastUpdated">
            <path value="Appointment.meta.lastUpdated" />
            <max value="0" />
        </element>
        <element id="Appointment.meta.source">
            <path value="Appointment.meta.source" />
            <max value="0" />
        </element>
        <element id="Appointment.meta.profile">
            <path value="Appointment.meta.profile" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="value" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="1" />
        </element>
        <element id="Appointment.meta.profile:kvdigitalProfil">
            <path value="Appointment.meta.profile" />
            <sliceName value="kvdigitalProfil" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Appointment.meta.profile:kvdigitalProfil.value">
            <path value="Appointment.meta.profile.value" />
            <min value="1" />
            <patternCanonical value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment|1.0.0" />
        </element>
        <element id="Appointment.meta.security">
            <path value="Appointment.meta.security" />
            <max value="0" />
        </element>
        <element id="Appointment.meta.tag">
            <path value="Appointment.meta.tag" />
            <max value="0" />
        </element>
        <element id="Appointment.implicitRules">
            <path value="Appointment.implicitRules" />
            <max value="0" />
        </element>
        <element id="Appointment.language">
            <path value="Appointment.language" />
            <max value="0" />
        </element>
        <element id="Appointment.text">
            <path value="Appointment.text" />
            <definition value="In diesem Element k&#246;nnen die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden d&#252;rfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind." />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.text.status">
            <path value="Appointment.text.status" />
            <fixedCode value="extensions" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.text.div">
            <path value="Appointment.text.div" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.contained">
            <path value="Appointment.contained" />
            <max value="0" />
        </element>
        <element id="Appointment.identifier">
            <path value="Appointment.identifier" />
            <max value="0" />
        </element>
        <element id="Appointment.status">
            <path value="Appointment.status" />
            <short value="pending | booked | cancelled" />
            <definition value="Status des Termins: pending = frei | booked = gebucht | cancelled = abgesagt" />
            <comment value="Aktuell ist ein Termin nur vorhanden, wenn er tats&#228;chlich gebucht und nicht abgesagt wurde. Daher ist der Status aktuell immer &quot;booked&quot;." />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://fhir.kbv.de/ValueSet/KBV_VS_KV_DIGITAL_TS_DRITTE_Appointment_Status" />
            </binding>
        </element>
        <element id="Appointment.cancelationReason">
            <path value="Appointment.cancelationReason" />
            <max value="0" />
        </element>
        <element id="Appointment.serviceCategory">
            <path value="Appointment.serviceCategory" />
            <max value="0" />
        </element>
        <element id="Appointment.serviceType">
            <path value="Appointment.serviceType" />
            <max value="0" />
        </element>
        <element id="Appointment.specialty">
            <path value="Appointment.specialty" />
            <short value="Gebuchte Leistungsmerkmale" />
            <definition value="Die gebuchten Leistungsmerkmale sind die Schnittmenge aus den vom User gesuchten und zum Terminslot angebotenen Leistungsmerkmalen, wobei auch gleichwertige Leistungsmerkmale enthalten sein k&#246;nnen. Hierzu geh&#246;ren Arztgruppen, WBO-Kennziffern, Zusatzqualifikationen und U-Untersuchungen." />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://fhir.kbv.de/ValueSet/KBV_VS_KV_DIGITAL_TS_DRITTE_Specialties" />
            </binding>
        </element>
        <element id="Appointment.specialty.coding">
            <path value="Appointment.specialty.coding" />
            <short value="Coding f&#252;r ein Leistungsmerkmal" />
            <definition value="Vorgegebenes Coding zu einem Leistungsmerkmal" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.specialty.coding.id">
            <path value="Appointment.specialty.coding.id" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.specialty.coding.system">
            <path value="Appointment.specialty.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.specialty.coding.version">
            <path value="Appointment.specialty.coding.version" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.specialty.coding.code">
            <path value="Appointment.specialty.coding.code" />
            <short value="WBO-Kennziffer/Genehmigung/Zusatzqualifikation" />
            <definition value="Der Code der WBO-Kennziffer, Genehmigung oder Zusatzqualifikation gem&#228;&#223; der von der KBV ver&#246;ffentlichten Schl&#252;sseltabellen (bspw. &quot;027&quot;)" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.specialty.coding.display">
            <path value="Appointment.specialty.coding.display" />
            <short value="Name des Leistungsmerkmals" />
            <definition value="Menschenlesbare Bezeichnung des Leistungsmerkmals gem&#228;&#223; der von der KBV ver&#246;ffentlichten Schl&#252;sseltabellen (bspw. die Arztgruppe &quot;Haus&#228;rzte&quot;, die WBO &quot;TG H&#228;matologie&quot; oder die Zusatzqualifikation &quot;Allergologie&quot;)" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.specialty.coding.userSelected">
            <path value="Appointment.specialty.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="Appointment.specialty.text">
            <path value="Appointment.specialty.text" />
            <max value="0" />
        </element>
        <element id="Appointment.appointmentType">
            <path value="Appointment.appointmentType" />
            <short value="Termintyp: AMB | VR" />
            <definition value="AMB = Vor-Ort-Termin\nVR = Videosprechstunde" />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://fhir.kbv.de/ValueSet/KBV_VS_KV_DIGITAL_TS_DRITTE_Appointment_Type" />
            </binding>
        </element>
        <element id="Appointment.appointmentType.coding">
            <path value="Appointment.appointmentType.coding" />
            <short value="Coding zum Termintyp" />
            <definition value="Vorgegebenes Coding zum Typ des Termins" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.appointmentType.coding.id">
            <path value="Appointment.appointmentType.coding.id" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.appointmentType.coding.system">
            <path value="Appointment.appointmentType.coding.system" />
            <min value="1" />
            <fixedUri value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.appointmentType.coding.version">
            <path value="Appointment.appointmentType.coding.version" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.appointmentType.coding.code">
            <path value="Appointment.appointmentType.coding.code" />
            <short value="AMB | VR" />
            <definition value="Der Code definiert, ob es sich bei dem Terminslot um einen Pr&#228;senztermin (AMB) oder eine Videosprechstunde (VR) handelt." />
            <comment value="Aktuell werden nur Videosprechstundentermine abgebildet; d.h., aktuell ist der Code immer &quot;VR&quot;." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.appointmentType.coding.display">
            <path value="Appointment.appointmentType.coding.display" />
            <short value="Menschenlesbare Bezeichnung des Termintyps" />
            <definition value="Vor-Ort-Termin oder Videosprechstunde" />
            <comment value="Aktuell werden nur Videosprechstundentermine abgebildet; d.h., aktuell ist der display-Wert immer &quot;Videosprechstunde&quot;." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.appointmentType.coding.userSelected">
            <path value="Appointment.appointmentType.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="Appointment.appointmentType.text">
            <path value="Appointment.appointmentType.text" />
            <max value="0" />
        </element>
        <element id="Appointment.reasonCode">
            <path value="Appointment.reasonCode" />
            <max value="0" />
        </element>
        <element id="Appointment.reasonReference">
            <path value="Appointment.reasonReference" />
            <max value="0" />
        </element>
        <element id="Appointment.priority">
            <path value="Appointment.priority" />
            <max value="0" />
        </element>
        <element id="Appointment.description">
            <path value="Appointment.description" />
            <max value="0" />
        </element>
        <element id="Appointment.supportingInformation">
            <path value="Appointment.supportingInformation" />
            <max value="0" />
        </element>
        <element id="Appointment.start">
            <path value="Appointment.start" />
            <short value="Startzeitpunkt des Termins" />
            <definition value="Datum und Uhrzeit, zu der der Termin startet" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.end">
            <path value="Appointment.end" />
            <short value="Endzeitpunkt des Termins" />
            <definition value="Datum und Uhrzeit, zu der der Termin endet" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.minutesDuration">
            <path value="Appointment.minutesDuration" />
            <max value="0" />
        </element>
        <element id="Appointment.slot">
            <path value="Appointment.slot" />
            <max value="0" />
        </element>
        <element id="Appointment.created">
            <path value="Appointment.created" />
            <short value="Zeitpunkt der Terminerstellung" />
            <definition value="Datum und Uhrzeit, wann der Termin erstellt - d.h., durch einen Drittanbieter f&#252;r einen Patienten gebucht - wurde." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.comment">
            <path value="Appointment.comment" />
            <max value="0" />
        </element>
        <element id="Appointment.patientInstruction">
            <path value="Appointment.patientInstruction" />
            <max value="0" />
        </element>
        <element id="Appointment.basedOn">
            <path value="Appointment.basedOn" />
            <max value="0" />
            <mustSupport value="false" />
        </element>
        <element id="Appointment.participant">
            <path value="Appointment.participant" />
            <short value="Location der Praxis, die den Termin anbietet" />
            <definition value="Hier wird auf die Location der Praxis/medizinischen Einrichtung referenziert, die den Termin anbietet." />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.type">
            <path value="Appointment.participant.type" />
            <max value="0" />
        </element>
        <element id="Appointment.participant.actor">
            <path value="Appointment.participant.actor" />
            <short value="Location der Praxis, die den Termin anbietet" />
            <definition value="Referenz auf die Location der Praxis/medizinischen Einrichtung, die den Termin anbietet" />
            <min value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Location" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.actor.reference">
            <path value="Appointment.participant.actor.reference" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.actor.type">
            <path value="Appointment.participant.actor.type" />
            <max value="0" />
        </element>
        <element id="Appointment.participant.actor.identifier">
            <path value="Appointment.participant.actor.identifier" />
            <max value="0" />
        </element>
        <element id="Appointment.participant.actor.display">
            <path value="Appointment.participant.actor.display" />
            <max value="0" />
        </element>
        <element id="Appointment.participant.required">
            <path value="Appointment.participant.required" />
            <max value="0" />
        </element>
        <element id="Appointment.participant.status">
            <path value="Appointment.participant.status" />
            <fixedCode value="accepted" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.period">
            <path value="Appointment.participant.period" />
            <max value="0" />
        </element>
        <element id="Appointment.requestedPeriod">
            <path value="Appointment.requestedPeriod" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "KBV-PR-KV-DIGITAL-TS-DRITTE-Appointment",
    "text": {
        "status": "generated",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "url": "https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment",
    "version": "1.0.0",
    "name": "KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment",
    "title": "KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment",
    "status": "active",
    "publisher": "kv.digital GmbH",
    "contact":  [
        {
            "name": "kv.digital GmbH",
            "telecom":  [
                {
                    "system": "url",
                    "value": "https://www.kv.digital/"
                }
            ]
        }
    ],
    "description": "Termin einer zu behandelnden Person in einer Praxis/medizinischen Einrichtung basierend auf einem Vermittlungscode",
    "copyright": "Im folgenden Profil können Codes aus den Code-Systemen SNOMED CT®, LOINC, Ucum, ATC, ICD-10-GM, ICD-10-WHO, OPS, Alpha-ID/Alpha-ID-SE und ICF enthalten sein, die dem folgenden Urheberrecht unterliegen: This material includes SNOMED CT® Clinical Terms® (SNOMED CT® CT®) which is used by permission of SNOMED CT® International. All rights reserved. SNOMED CT® CT®, was originally created by The College of American Pathologists. SNOMED CT® and SNOMED CT® CT are registered trademarks of SNOMED CT® International. Implementers of these artefacts must have the appropriate SNOMED CT® CT Affiliate license. This material contains content from LOINC (http://LOINC.org). LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://LOINC.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc. This product includes all or a portion of the UCUM table, UCUM codes, and UCUM definitions or is derived from it, subject to a license from Regenstrief Institute, Inc. and The UCUM Organization. Your use of the UCUM table, UCUM codes, UCUM definitions also is subject to this license, a copy of which is available at http://unitsofmeasure.org. The current complete UCUM table, UCUM Specification are available for download at http://unitsofmeasure.org. The UCUM table and UCUM codes are copyright © 1995-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. THE UCUM TABLE (IN ALL FORMATS), UCUM DEFINITIONS, AND SPECIFICATION ARE PROVIDED 'AS IS.' ANY EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Dieses Material enthält Inhalte aus ATC. Die Erstellung erfolgte unter Verwendung der Datenträger der amtlichen Fassung der ATCKlassifikation mit DDD des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICD-10-GM, ICD-10-WHO, OPS Alpha-ID ans Alpha-ID-SE. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Bundesinstituts für Arzneimittel und Medizinprodukte (BfArM). Dieses Material enthält Inhalte aus ICF. Die Erstellung erfolgt unter Verwendung der maschinenlesbaren Fassung des Deutschen Instituts für Medizinische Dokumentation und Information (DIMDI). ICF-Kodes, -Begriffe und -Texte © Weltgesundheitsorganisation, übersetzt und herausgegeben durch das Deutsche Institut für Medizinische Dokumentation und Information von der International classification of functioning, disability and health - ICF, herausgegeben durch die Weltgesundheitsorganisation.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Appointment",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Appointment",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Appointment",
                "path": "Appointment",
                "short": "Termin",
                "definition": "Termin einer zu behandelnden Person in einer Praxis/medizinischen Einrichtung basierend auf einem Vermittlungscode"
            },
            {
                "id": "Appointment.meta",
                "path": "Appointment.meta",
                "min": 1
            },
            {
                "id": "Appointment.meta.versionId",
                "path": "Appointment.meta.versionId",
                "max": "0"
            },
            {
                "id": "Appointment.meta.lastUpdated",
                "path": "Appointment.meta.lastUpdated",
                "max": "0"
            },
            {
                "id": "Appointment.meta.source",
                "path": "Appointment.meta.source",
                "max": "0"
            },
            {
                "id": "Appointment.meta.profile",
                "path": "Appointment.meta.profile",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "value"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1
            },
            {
                "id": "Appointment.meta.profile:kvdigitalProfil",
                "path": "Appointment.meta.profile",
                "sliceName": "kvdigitalProfil",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Appointment.meta.profile:kvdigitalProfil.value",
                "path": "Appointment.meta.profile.value",
                "min": 1,
                "patternCanonical": "https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment|1.0.0"
            },
            {
                "id": "Appointment.meta.security",
                "path": "Appointment.meta.security",
                "max": "0"
            },
            {
                "id": "Appointment.meta.tag",
                "path": "Appointment.meta.tag",
                "max": "0"
            },
            {
                "id": "Appointment.implicitRules",
                "path": "Appointment.implicitRules",
                "max": "0"
            },
            {
                "id": "Appointment.language",
                "path": "Appointment.language",
                "max": "0"
            },
            {
                "id": "Appointment.text",
                "path": "Appointment.text",
                "definition": "In diesem Element können die in der Instanz enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind.",
                "mustSupport": true
            },
            {
                "id": "Appointment.text.status",
                "path": "Appointment.text.status",
                "fixedCode": "extensions",
                "mustSupport": true
            },
            {
                "id": "Appointment.text.div",
                "path": "Appointment.text.div",
                "mustSupport": true
            },
            {
                "id": "Appointment.contained",
                "path": "Appointment.contained",
                "max": "0"
            },
            {
                "id": "Appointment.identifier",
                "path": "Appointment.identifier",
                "max": "0"
            },
            {
                "id": "Appointment.status",
                "path": "Appointment.status",
                "short": "pending | booked | cancelled",
                "definition": "Status des Termins: pending = frei | booked = gebucht | cancelled = abgesagt",
                "comment": "Aktuell ist ein Termin nur vorhanden, wenn er tatsächlich gebucht und nicht abgesagt wurde. Daher ist der Status aktuell immer \"booked\".",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_KV_DIGITAL_TS_DRITTE_Appointment_Status"
                }
            },
            {
                "id": "Appointment.cancelationReason",
                "path": "Appointment.cancelationReason",
                "max": "0"
            },
            {
                "id": "Appointment.serviceCategory",
                "path": "Appointment.serviceCategory",
                "max": "0"
            },
            {
                "id": "Appointment.serviceType",
                "path": "Appointment.serviceType",
                "max": "0"
            },
            {
                "id": "Appointment.specialty",
                "path": "Appointment.specialty",
                "short": "Gebuchte Leistungsmerkmale",
                "definition": "Die gebuchten Leistungsmerkmale sind die Schnittmenge aus den vom User gesuchten und zum Terminslot angebotenen Leistungsmerkmalen, wobei auch gleichwertige Leistungsmerkmale enthalten sein können. Hierzu gehören Arztgruppen, WBO-Kennziffern, Zusatzqualifikationen und U-Untersuchungen.",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_KV_DIGITAL_TS_DRITTE_Specialties"
                }
            },
            {
                "id": "Appointment.specialty.coding",
                "path": "Appointment.specialty.coding",
                "short": "Coding für ein Leistungsmerkmal",
                "definition": "Vorgegebenes Coding zu einem Leistungsmerkmal",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Appointment.specialty.coding.id",
                "path": "Appointment.specialty.coding.id",
                "mustSupport": true
            },
            {
                "id": "Appointment.specialty.coding.system",
                "path": "Appointment.specialty.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.specialty.coding.version",
                "path": "Appointment.specialty.coding.version",
                "mustSupport": true
            },
            {
                "id": "Appointment.specialty.coding.code",
                "path": "Appointment.specialty.coding.code",
                "short": "WBO-Kennziffer/Genehmigung/Zusatzqualifikation",
                "definition": "Der Code der WBO-Kennziffer, Genehmigung oder Zusatzqualifikation gemäß der von der KBV veröffentlichten Schlüsseltabellen (bspw. \"027\")",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.specialty.coding.display",
                "path": "Appointment.specialty.coding.display",
                "short": "Name des Leistungsmerkmals",
                "definition": "Menschenlesbare Bezeichnung des Leistungsmerkmals gemäß der von der KBV veröffentlichten Schlüsseltabellen (bspw. die Arztgruppe \"Hausärzte\", die WBO \"TG Hämatologie\" oder die Zusatzqualifikation \"Allergologie\")",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.specialty.coding.userSelected",
                "path": "Appointment.specialty.coding.userSelected",
                "max": "0"
            },
            {
                "id": "Appointment.specialty.text",
                "path": "Appointment.specialty.text",
                "max": "0"
            },
            {
                "id": "Appointment.appointmentType",
                "path": "Appointment.appointmentType",
                "short": "Termintyp: AMB | VR",
                "definition": "AMB = Vor-Ort-Termin\nVR = Videosprechstunde",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_KV_DIGITAL_TS_DRITTE_Appointment_Type"
                }
            },
            {
                "id": "Appointment.appointmentType.coding",
                "path": "Appointment.appointmentType.coding",
                "short": "Coding zum Termintyp",
                "definition": "Vorgegebenes Coding zum Typ des Termins",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Appointment.appointmentType.coding.id",
                "path": "Appointment.appointmentType.coding.id",
                "mustSupport": true
            },
            {
                "id": "Appointment.appointmentType.coding.system",
                "path": "Appointment.appointmentType.coding.system",
                "min": 1,
                "fixedUri": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                "mustSupport": true
            },
            {
                "id": "Appointment.appointmentType.coding.version",
                "path": "Appointment.appointmentType.coding.version",
                "mustSupport": true
            },
            {
                "id": "Appointment.appointmentType.coding.code",
                "path": "Appointment.appointmentType.coding.code",
                "short": "AMB | VR",
                "definition": "Der Code definiert, ob es sich bei dem Terminslot um einen Präsenztermin (AMB) oder eine Videosprechstunde (VR) handelt.",
                "comment": "Aktuell werden nur Videosprechstundentermine abgebildet; d.h., aktuell ist der Code immer \"VR\".",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.appointmentType.coding.display",
                "path": "Appointment.appointmentType.coding.display",
                "short": "Menschenlesbare Bezeichnung des Termintyps",
                "definition": "Vor-Ort-Termin oder Videosprechstunde",
                "comment": "Aktuell werden nur Videosprechstundentermine abgebildet; d.h., aktuell ist der display-Wert immer \"Videosprechstunde\".",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.appointmentType.coding.userSelected",
                "path": "Appointment.appointmentType.coding.userSelected",
                "max": "0"
            },
            {
                "id": "Appointment.appointmentType.text",
                "path": "Appointment.appointmentType.text",
                "max": "0"
            },
            {
                "id": "Appointment.reasonCode",
                "path": "Appointment.reasonCode",
                "max": "0"
            },
            {
                "id": "Appointment.reasonReference",
                "path": "Appointment.reasonReference",
                "max": "0"
            },
            {
                "id": "Appointment.priority",
                "path": "Appointment.priority",
                "max": "0"
            },
            {
                "id": "Appointment.description",
                "path": "Appointment.description",
                "max": "0"
            },
            {
                "id": "Appointment.supportingInformation",
                "path": "Appointment.supportingInformation",
                "max": "0"
            },
            {
                "id": "Appointment.start",
                "path": "Appointment.start",
                "short": "Startzeitpunkt des Termins",
                "definition": "Datum und Uhrzeit, zu der der Termin startet",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.end",
                "path": "Appointment.end",
                "short": "Endzeitpunkt des Termins",
                "definition": "Datum und Uhrzeit, zu der der Termin endet",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.minutesDuration",
                "path": "Appointment.minutesDuration",
                "max": "0"
            },
            {
                "id": "Appointment.slot",
                "path": "Appointment.slot",
                "max": "0"
            },
            {
                "id": "Appointment.created",
                "path": "Appointment.created",
                "short": "Zeitpunkt der Terminerstellung",
                "definition": "Datum und Uhrzeit, wann der Termin erstellt - d.h., durch einen Drittanbieter für einen Patienten gebucht - wurde.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.comment",
                "path": "Appointment.comment",
                "max": "0"
            },
            {
                "id": "Appointment.patientInstruction",
                "path": "Appointment.patientInstruction",
                "max": "0"
            },
            {
                "id": "Appointment.basedOn",
                "path": "Appointment.basedOn",
                "max": "0",
                "mustSupport": false
            },
            {
                "id": "Appointment.participant",
                "path": "Appointment.participant",
                "short": "Location der Praxis, die den Termin anbietet",
                "definition": "Hier wird auf die Location der Praxis/medizinischen Einrichtung referenziert, die den Termin anbietet.",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.type",
                "path": "Appointment.participant.type",
                "max": "0"
            },
            {
                "id": "Appointment.participant.actor",
                "path": "Appointment.participant.actor",
                "short": "Location der Praxis, die den Termin anbietet",
                "definition": "Referenz auf die Location der Praxis/medizinischen Einrichtung, die den Termin anbietet",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Location"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.actor.reference",
                "path": "Appointment.participant.actor.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.actor.type",
                "path": "Appointment.participant.actor.type",
                "max": "0"
            },
            {
                "id": "Appointment.participant.actor.identifier",
                "path": "Appointment.participant.actor.identifier",
                "max": "0"
            },
            {
                "id": "Appointment.participant.actor.display",
                "path": "Appointment.participant.actor.display",
                "max": "0"
            },
            {
                "id": "Appointment.participant.required",
                "path": "Appointment.participant.required",
                "max": "0"
            },
            {
                "id": "Appointment.participant.status",
                "path": "Appointment.participant.status",
                "fixedCode": "accepted",
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.period",
                "path": "Appointment.participant.period",
                "max": "0"
            },
            {
                "id": "Appointment.requestedPeriod",
                "path": "Appointment.requestedPeriod",
                "max": "0"
            }
        ]
    }
}

Anmerkungen

In der folgenden Tabelle finden sich Anmerkungen zu einzelnen Feldern.

Feld Anmerkung
Appointment.status

Dieses Feld wird durch das Basis-Profil mit einer Kardinalität von 1..1 erzwungen und muss einen Wert aus dem ValueSet AppointmentStatus enthalten. Deshalb wurde basierend darauf das ValueSet Appointment_Status erstellt, das nur die für die Terminschnittstelle für Dritte relevanten Werte zulässt. Da einige Codings dadurch keinen sprechenden Namen mehr haben, wurde in der Definition des Feldes die Bedeutung der Codings im Kontext des 116117 Terminservice beschrieben.

Aktuell hat dieses Feld zudem immer den fixed value booked, da im System der Terminschnittstelle für Dritte nur dann ein Termin (Appointment) existiert, wenn dieser gebucht und nicht abgesagt wurde. (Bei der Terminsuche werden Terminslots, keine Appointments, zurückgegeben.
Appointment.created Dieses Feld enthält den Zeitpunkt der Terminbuchung. Aus fachlicher Sicht wird der Termin (also die Appointment-Ressource) erst mit der Buchung angelegt; bei der Terminsuche werden nur Terminslots (Slot-Ressourcen) zurückgegeben, die zuvor von einer Praxis / medizinischen Einrichtung erstellt wurden.)
Appointment.participant Dieses Feld wird durch das Basis-Profil mit einer Kardinalität von 1..1 oder 1..* erzwungen und muss eine Reference auf eine Ressource der folgenden Typen haben: Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location. Da die Terminschnittstelle für Dritte aus datenschutzrechtlichen Gründen keine Patientendaten zurückgeben darf (und die anderen Typen nicht verwendet), ist hier immer die Referenz auf die Location hinterlegt, also den Standort der Praxis / medizinischen Einrichtung, die den Termin anbietet.

Beispiele

Alle Beispiele sind hier im vorliegenden Projekt zu finden.


<Appointment xmlns="http://hl7.org/fhir">
    <id value="3cfc477b-45b4-4665-9043-2c9045968ca0" />
    <meta>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment|1.0.0" />
        <profile value="http://hl7.org/fhir/StructureDefinition/Appointment" />
    </meta>
    <status value="booked" />
    <specialty>
        <coding>
            <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BPL_ARZTGRUPPE" />
            <code value="09" />
            <display value="Kinder- und Jugend&#228;rzte" />
        </coding>
    </specialty>
    <specialty>
        <coding>
            <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR2_WBO" />
            <code value="341" />
            <display value="F&#196;/FA Kinder- und Jugendmedizin" />
        </coding>
    </specialty>
    <appointmentType>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
            <code value="VR" />
            <display value="virtual" />
        </coding>
    </appointmentType>
    <start value="2024-01-27T10:15:00Z" />
    <end value="2024-01-27T10:30:00Z" />
    <created value="2024-01-05T11:34:15Z" />
    <participant>
        <actor>
            <reference value="urn:uuid:77b761fa-8d72-4c99-a388-a190c5c086f8" />
        </actor>
        <status value="accepted" />
    </participant>
</Appointment>
<Appointment xmlns="http://hl7.org/fhir">
    <id value="8c11ddd5-0ac4-4d9a-b5bd-2a90e1498621" />
    <meta>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Appointment|1.0.0" />
    </meta>
    <status value="booked" />
    <specialty>
        <coding>
            <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BPL_ARZTGRUPPE" />
            <code value="09" />
            <display value="Kinder- und Jugend&#228;rzte" />
        </coding>
    </specialty>
    <appointmentType>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
            <code value="VR" />
            <display value="virtual" />
        </coding>
    </appointmentType>
    <start value="2024-01-27T10:15:00Z" />
    <end value="2024-01-27T10:30:00Z" />
    <created value="2024-01-05T11:34:15Z" />
    <participant>
        <actor>
            <reference value="urn:uuid:77b761fa-8d72-4c99-a388-a190c5c086f9" />
        </actor>
        <status value="accepted" />
    </participant>
</Appointment>