Terminprofil (Schedule)

Fachlicher Kontext

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

Die Terminschnittstelle für Dritte ermöglicht die Suche von freien Terminen, die von Praxen / medizinischen Einrichtungen angeboten werden sowie das Abrufen von Informationen über eine zuvor durchgeführte Terminbuchung. Um Patienten Details zu einem Terminslot oder einer Terminbuchung anzuzeigen, der bzw. die auf dem Terminprofil basiert, sind folgende Daten notwendig:

  • ID
  • Name
  • Terminprofilhinweis
  • Diagnosefremdsprachen (von der behandelnden Person gesprochene Sprachen)

Die ID ist dabei primär für die Implementierenden relevant, um ein Terminprofil eindeutig einem gefunden Terminslot zuordnen zu können. (Da in den Suchergebnissen einer Terminsuche sehr viele Terminslots und damit auch mehrere Terminprofile enthalten sein können, muss bei der Implementierung eine entsprechende Zuordnung anhand der Terminprofil-ID erfolgen.)

Die genannten Informationen sind in dem vorliegenden Profil gebündelt und ergänzen somit die Profile für die Terminbuchung (Appointment) und den Terminslot (Slot) um weitere Details.


FHIR-Profil

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

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
diagnosefremdsprachenS I0..*Extension(Coding)
terminprofilnameS I1..1Extension(string)
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemS Σ1..1uriPattern
valueS Σ1..1string
periodΣ I0..0Period
assignerΣ I0..0Reference(Organization)
activeΣ ?!0..0boolean
serviceCategoryΣ0..0CodeableConcept
serviceTypeΣ0..0CodeableConcept
specialtyΣ0..0CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..0uriBinding
identifierΣ0..0Identifier
displayΣ0..0string
planningHorizonΣ I0..0Period
commentS0..1string
Schedule
DefinitionDas Terminprofil kann - wenn vorhanden - die angebotenen Diagnosefremdsprachen und Hinweise (für die Patienten) zu den zugehörigen Terminen enthalten.
Cardinality0...*
AliasAvailability
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()
Mappings
  • rim: Entity. Role, or Act
  • rim: n/a
  • ical: BEGIN:VFREEBUSY ??? END:VFREEBUSY (If your fhir server provides this information via calDAV, then you may want to include addressing information in a URL section, and with the search, a DTSTART and DTEND component can be included to indicate the range of time that has been covered in the collection of slots, where these overlap the resources period values. For all slots that reference this resource, include a FREEBUSY row for each slot)
Schedule.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.

Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.meta.profile:kvdigitalProfil.value
DefinitionPrimitive value for canonical
Cardinality1...1
TypeSystem.String
Pattern

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

Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.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?
Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.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.
Cardinality1...*
TypeExtension
Must SupportTrue
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
Schedule.extension:diagnosefremdsprachen
DefinitionListe der Codings für Fremdsprachen (abgesehen von deutsch), in der der Arzt mit dem Patienten kommunizieren und eine Diagnose stellen kann.
Cardinality0...*
TypeExtension(Coding)
Must SupportTrue
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.

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
Schedule.extension:terminprofilname
DefinitionDie Extension enthält den Namen des Terminprofils; die Angabe eines Namens ist verpflichtend.
Cardinality1...1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content
Comments

Der Name eines Terminrprofil muss nicht eindeutig sein.

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
Schedule.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
Schedule.identifier
DefinitionExternal Ids for this item.
Cardinality1...1
TypeIdentifier
Must SupportTrue
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
  • w5: FiveWs.identifier
  • ical: UID
Schedule.identifier.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
Schedule.identifier.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
Schedule.identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...0
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
Schedule.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...0
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

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: CX.5
  • rim: Role.code or implied by context
Schedule.identifier.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality1...1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

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

urn:ietf:rfc:4122

Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Schedule.identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

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

123456


Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Schedule.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...0
TypePeriod
SummaryTrue
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"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
Schedule.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...0
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

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)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
Schedule.active
DefinitionWhether this schedule record is in active use or should not be used (such as was entered in error).
Cardinality0...0
Typeboolean
ModifierTrue
SummaryTrue
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
Schedule.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
  • w5: FiveWs.class
Schedule.serviceType
DefinitionThe specific service that is to be performed during this appointment.
Cardinality0...0
TypeCodeableConcept
BindingServiceType (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
  • w5: FiveWs.class
  • ical: n/a
Schedule.specialty
DefinitionThe specialty of a practitioner that would be required to perform the service requested in this appointment.
Cardinality0...0
TypeCodeableConcept
Binding

Additional details about where the content was created (e.g. clinical specialty).

PracticeSettingCodeValueSet (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
  • w5: FiveWs.class
Schedule.actor
DefinitionReferenz auf die Praxis/medizinische Einrichtung, die das Terminprofil angelegt hat.
Cardinality1...1
TypeReference(KBV_PR_KV_DIGITAL_TS_DRITTE_Location)
Must SupportTrue
SummaryTrue
Comments

The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.

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.subject[x]
  • ical: ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced resource
  • w5: FiveWs.subject
Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.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
Schedule.planningHorizon
DefinitionThe period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
Cardinality0...0
TypePeriod
SummaryTrue
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"]
  • w5: FiveWs.planned
  • ical: DTSTART:20131201T003000Z DTEND:2014030101T003000Z
Schedule.comment
DefinitionHinweise für Patienten zum Termin (bspw. "Bitte Handtuch mitbringen")
Cardinality0...1
Typestring
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())
Mappings
  • rim: n/a
  • ical: COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar entry
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="KBV-PR-KV-DIGITAL-TS-DRITTE-Schedule-Slot-Profile" />
    <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_Schedule_Slot_Profile" />
    <version value="1.0.0" />
    <name value="KBV_PR_KV_DIGITAL_TS_DRITTE_Schedule_Slot_Profile" />
    <title value="KBV_PR_KV_DIGITAL_TS_DRITTE_Schedule_Slot_Profile" />
    <status value="active" />
    <date value="2023-12" />
    <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="Ein Terminprofil dient als Vorlage zum Anlegen von Terminslots und kann - neben dem Namen des Terminprofils - Hinweise f&#252;r die Patienten und angebotene Diagnosefremdsprachen enthalten. Beim Anlegen eines neuen Terminslots auf Basis eines Terminprofils werden die im Profil enthaltenen Daten in den Terminslot &#252;bernommen. Dadurch  b&#252;ndelt ein Terminprofil beliebig viele Termine der gleichen Art." />
    <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="Schedule" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Schedule" />
    <derivation value="constraint" />
    <differential>
        <element id="Schedule">
            <path value="Schedule" />
            <short value="Terminprofil mit Hinweis f&#252;r Patienten" />
            <definition value="Das Terminprofil kann - wenn vorhanden - die angebotenen Diagnosefremdsprachen und Hinweise (f&#252;r die Patienten) zu den zugeh&#246;rigen Terminen enthalten." />
        </element>
        <element id="Schedule.meta">
            <path value="Schedule.meta" />
            <min value="1" />
        </element>
        <element id="Schedule.meta.versionId">
            <path value="Schedule.meta.versionId" />
            <max value="0" />
        </element>
        <element id="Schedule.meta.lastUpdated">
            <path value="Schedule.meta.lastUpdated" />
            <max value="0" />
        </element>
        <element id="Schedule.meta.source">
            <path value="Schedule.meta.source" />
            <max value="0" />
        </element>
        <element id="Schedule.meta.profile">
            <path value="Schedule.meta.profile" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="value" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="1" />
        </element>
        <element id="Schedule.meta.profile:kvdigitalProfil">
            <path value="Schedule.meta.profile" />
            <sliceName value="kvdigitalProfil" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Schedule.meta.profile:kvdigitalProfil.value">
            <path value="Schedule.meta.profile.value" />
            <min value="1" />
            <patternCanonical value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Schedule_Slot_Profile|1.0.0" />
        </element>
        <element id="Schedule.meta.security">
            <path value="Schedule.meta.security" />
            <max value="0" />
        </element>
        <element id="Schedule.meta.tag">
            <path value="Schedule.meta.tag" />
            <max value="0" />
        </element>
        <element id="Schedule.implicitRules">
            <path value="Schedule.implicitRules" />
            <max value="0" />
        </element>
        <element id="Schedule.language">
            <path value="Schedule.language" />
            <max value="0" />
        </element>
        <element id="Schedule.text">
            <path value="Schedule.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="Schedule.text.status">
            <path value="Schedule.text.status" />
            <fixedCode value="extensions" />
            <mustSupport value="true" />
        </element>
        <element id="Schedule.text.div">
            <path value="Schedule.text.div" />
            <mustSupport value="true" />
        </element>
        <element id="Schedule.contained">
            <path value="Schedule.contained" />
            <max value="0" />
        </element>
        <element id="Schedule.extension">
            <path value="Schedule.extension" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Schedule.extension:diagnosefremdsprachen">
            <path value="Schedule.extension" />
            <sliceName value="diagnosefremdsprachen" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Foreign_Languages_For_Diagnostic_Outcome" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="Schedule.extension:terminprofilname">
            <path value="Schedule.extension" />
            <sliceName value="terminprofilname" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Slot_Profile_Name" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="Schedule.identifier">
            <path value="Schedule.identifier" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Schedule.identifier.use">
            <path value="Schedule.identifier.use" />
            <max value="0" />
        </element>
        <element id="Schedule.identifier.type">
            <path value="Schedule.identifier.type" />
            <max value="0" />
        </element>
        <element id="Schedule.identifier.system">
            <path value="Schedule.identifier.system" />
            <short value="UUID" />
            <min value="1" />
            <patternUri value="urn:ietf:rfc:4122" />
            <mustSupport value="true" />
        </element>
        <element id="Schedule.identifier.value">
            <path value="Schedule.identifier.value" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Schedule.identifier.period">
            <path value="Schedule.identifier.period" />
            <max value="0" />
        </element>
        <element id="Schedule.identifier.assigner">
            <path value="Schedule.identifier.assigner" />
            <max value="0" />
        </element>
        <element id="Schedule.active">
            <path value="Schedule.active" />
            <max value="0" />
        </element>
        <element id="Schedule.serviceCategory">
            <path value="Schedule.serviceCategory" />
            <max value="0" />
        </element>
        <element id="Schedule.serviceType">
            <path value="Schedule.serviceType" />
            <max value="0" />
        </element>
        <element id="Schedule.specialty">
            <path value="Schedule.specialty" />
            <max value="0" />
        </element>
        <element id="Schedule.actor">
            <path value="Schedule.actor" />
            <short value="Praxis, die dieses Terminprofil angelegt hat" />
            <definition value="Referenz auf die Praxis/medizinische Einrichtung, die das Terminprofil angelegt hat." />
            <max 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="Schedule.actor.reference">
            <path value="Schedule.actor.reference" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Schedule.actor.type">
            <path value="Schedule.actor.type" />
            <max value="0" />
            <mustSupport value="false" />
        </element>
        <element id="Schedule.actor.identifier">
            <path value="Schedule.actor.identifier" />
            <max value="0" />
        </element>
        <element id="Schedule.actor.display">
            <path value="Schedule.actor.display" />
            <max value="0" />
        </element>
        <element id="Schedule.planningHorizon">
            <path value="Schedule.planningHorizon" />
            <max value="0" />
        </element>
        <element id="Schedule.comment">
            <path value="Schedule.comment" />
            <label value="Terminprofilhinweis" />
            <short value="Terminprofilhinweis" />
            <definition value="Hinweise f&#252;r Patienten zum Termin (bspw. &quot;Bitte Handtuch mitbringen&quot;)" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "KBV-PR-KV-DIGITAL-TS-DRITTE-Schedule-Slot-Profile",
    "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_Schedule_Slot_Profile",
    "version": "1.0.0",
    "name": "KBV_PR_KV_DIGITAL_TS_DRITTE_Schedule_Slot_Profile",
    "title": "KBV_PR_KV_DIGITAL_TS_DRITTE_Schedule_Slot_Profile",
    "status": "active",
    "date": "2023-12",
    "publisher": "kv.digital GmbH",
    "contact":  [
        {
            "name": "kv.digital GmbH",
            "telecom":  [
                {
                    "system": "url",
                    "value": "https://www.kv.digital"
                }
            ]
        }
    ],
    "description": "Ein Terminprofil dient als Vorlage zum Anlegen von Terminslots und kann - neben dem Namen des Terminprofils - Hinweise für die Patienten und angebotene Diagnosefremdsprachen enthalten. Beim Anlegen eines neuen Terminslots auf Basis eines Terminprofils werden die im Profil enthaltenen Daten in den Terminslot übernommen. Dadurch  bündelt ein Terminprofil beliebig viele Termine der gleichen Art.",
    "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": "Schedule",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Schedule",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Schedule",
                "path": "Schedule",
                "short": "Terminprofil mit Hinweis für Patienten",
                "definition": "Das Terminprofil kann - wenn vorhanden - die angebotenen Diagnosefremdsprachen und Hinweise (für die Patienten) zu den zugehörigen Terminen enthalten."
            },
            {
                "id": "Schedule.meta",
                "path": "Schedule.meta",
                "min": 1
            },
            {
                "id": "Schedule.meta.versionId",
                "path": "Schedule.meta.versionId",
                "max": "0"
            },
            {
                "id": "Schedule.meta.lastUpdated",
                "path": "Schedule.meta.lastUpdated",
                "max": "0"
            },
            {
                "id": "Schedule.meta.source",
                "path": "Schedule.meta.source",
                "max": "0"
            },
            {
                "id": "Schedule.meta.profile",
                "path": "Schedule.meta.profile",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "value"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1
            },
            {
                "id": "Schedule.meta.profile:kvdigitalProfil",
                "path": "Schedule.meta.profile",
                "sliceName": "kvdigitalProfil",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Schedule.meta.profile:kvdigitalProfil.value",
                "path": "Schedule.meta.profile.value",
                "min": 1,
                "patternCanonical": "https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Schedule_Slot_Profile|1.0.0"
            },
            {
                "id": "Schedule.meta.security",
                "path": "Schedule.meta.security",
                "max": "0"
            },
            {
                "id": "Schedule.meta.tag",
                "path": "Schedule.meta.tag",
                "max": "0"
            },
            {
                "id": "Schedule.implicitRules",
                "path": "Schedule.implicitRules",
                "max": "0"
            },
            {
                "id": "Schedule.language",
                "path": "Schedule.language",
                "max": "0"
            },
            {
                "id": "Schedule.text",
                "path": "Schedule.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": "Schedule.text.status",
                "path": "Schedule.text.status",
                "fixedCode": "extensions",
                "mustSupport": true
            },
            {
                "id": "Schedule.text.div",
                "path": "Schedule.text.div",
                "mustSupport": true
            },
            {
                "id": "Schedule.contained",
                "path": "Schedule.contained",
                "max": "0"
            },
            {
                "id": "Schedule.extension",
                "path": "Schedule.extension",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Schedule.extension:diagnosefremdsprachen",
                "path": "Schedule.extension",
                "sliceName": "diagnosefremdsprachen",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Foreign_Languages_For_Diagnostic_Outcome"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Schedule.extension:terminprofilname",
                "path": "Schedule.extension",
                "sliceName": "terminprofilname",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Slot_Profile_Name"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Schedule.identifier",
                "path": "Schedule.identifier",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Schedule.identifier.use",
                "path": "Schedule.identifier.use",
                "max": "0"
            },
            {
                "id": "Schedule.identifier.type",
                "path": "Schedule.identifier.type",
                "max": "0"
            },
            {
                "id": "Schedule.identifier.system",
                "path": "Schedule.identifier.system",
                "short": "UUID",
                "min": 1,
                "patternUri": "urn:ietf:rfc:4122",
                "mustSupport": true
            },
            {
                "id": "Schedule.identifier.value",
                "path": "Schedule.identifier.value",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Schedule.identifier.period",
                "path": "Schedule.identifier.period",
                "max": "0"
            },
            {
                "id": "Schedule.identifier.assigner",
                "path": "Schedule.identifier.assigner",
                "max": "0"
            },
            {
                "id": "Schedule.active",
                "path": "Schedule.active",
                "max": "0"
            },
            {
                "id": "Schedule.serviceCategory",
                "path": "Schedule.serviceCategory",
                "max": "0"
            },
            {
                "id": "Schedule.serviceType",
                "path": "Schedule.serviceType",
                "max": "0"
            },
            {
                "id": "Schedule.specialty",
                "path": "Schedule.specialty",
                "max": "0"
            },
            {
                "id": "Schedule.actor",
                "path": "Schedule.actor",
                "short": "Praxis, die dieses Terminprofil angelegt hat",
                "definition": "Referenz auf die Praxis/medizinische Einrichtung, die das Terminprofil angelegt hat.",
                "max": "1",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Location"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Schedule.actor.reference",
                "path": "Schedule.actor.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Schedule.actor.type",
                "path": "Schedule.actor.type",
                "max": "0",
                "mustSupport": false
            },
            {
                "id": "Schedule.actor.identifier",
                "path": "Schedule.actor.identifier",
                "max": "0"
            },
            {
                "id": "Schedule.actor.display",
                "path": "Schedule.actor.display",
                "max": "0"
            },
            {
                "id": "Schedule.planningHorizon",
                "path": "Schedule.planningHorizon",
                "max": "0"
            },
            {
                "id": "Schedule.comment",
                "path": "Schedule.comment",
                "label": "Terminprofilhinweis",
                "short": "Terminprofilhinweis",
                "definition": "Hinweise für Patienten zum Termin (bspw. \"Bitte Handtuch mitbringen\")",
                "mustSupport": true
            }
        ]
    }
}

Anmerkungen

In der folgenden Tabelle finden sich Anmerkungen zu einzelnen Feldern.

Feld Anmerkung
Schedule.identifier.value Die UUID wird als Business-Identifier für das Terminprofil genutzt, um eine eindeutige Zuordnung zu Termin (Appointment) und Terminslot (Slot) zu ermöglichen.
Schedule.actor Dieses Feld lässt (bedingt durch die Vorgaben des Basis-Profils) keine Referenz auf eine Organization zu, daher wird hier die Location der Praxis / medizinischen Einrichtung referenziert, die dieses Terminprofil angelegt hat.

Beispiele

Alle Beispiele sind hier im vorliegenden Projekt zu finden.


<Schedule xmlns="http://hl7.org/fhir">
    <id value="3b6b4224-8ba0-4e8a-8dae-6f6a772d5cb4" />
    <meta>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Schedule_Slot_Profile|1.0.0" />
    </meta>
    <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Foreign_Languages_For_Diagnostic_Outcome">
        <valueCoding>
            <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR_FREMDSPRACHE" />
            <code value="83" />
            <display value="Thai (Thailand)" />
        </valueCoding>
    </extension>
    <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Foreign_Languages_For_Diagnostic_Outcome">
        <valueCoding>
            <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR_FREMDSPRACHE" />
            <code value="107" />
            <display value="Schottisch-G&#228;lisch" />
        </valueCoding>
    </extension>
    <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Slot_Profile_Name">
        <valueString value="Videosprechstunde auf Thai oder Schottisch-G&#228;lisch" />
    </extension>
    <identifier>
        <system value="urn:ietf:rfc:4122" />
        <value value="4ea7f4eb-401c-48d4-bfcf-f43c0505d835" />
    </identifier>
    <actor>
        <reference value="urn:uuid:aae373f1-5bfb-4fb4-92ce-8e5322f4d429" />
    </actor>
    <comment value="Bitte n&#252;chtern kommen." />
</Schedule>

<Schedule xmlns="http://hl7.org/fhir">
    <id value="6b6b4224-8ba0-4e8a-8dae-6f0a772d5cb4" />
    <meta>
        <profile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Schedule_Slot_Profile|1.0.0" />
    </meta>
    <extension url="https://fhir.kbv.de/StructureDefinition/KBV_EX_KV_DIGITAL_TS_DRITTE_Slot_Profile_Name">
        <valueString value="Videosprechstunde auf Thai oder Schottisch-G&#228;lisch" />
    </extension>
    <identifier>
        <system value="urn:ietf:rfc:4122" />
        <value value="4ea7f4eb-401c-48d4-bfcf-f43c0505d835" />
    </identifier>
    <actor>
        <reference value="urn:uuid:aae373f1-5bfb-4fb4-92ce-8e5322f4d429" />
    </actor>
</Schedule>