Terminprofil (Schedule)
Fachlicher Kontext
Scope | Art |
---|---|
Präsenztermine suchen | Ausgabeparameter (als Teil des Result Bundles) |
Videosprechstundentermine 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 |
KBV_PR_KV_DIGITAL_TS_DRITTE_Schedule_Slot_Profile (Schedule) | C | Schedule | |
id | Σ | 0..1 | string |
meta | Σ | 1..1 | Meta |
id | 0..1 | string | |
extension | C | 0..* | Extension |
versionId | Σ | 0..0 | id |
lastUpdated | Σ | 0..0 | instant |
source | Σ | 0..0 | uri |
profile | Σ | 1..* | canonical(StructureDefinition) |
kvdigitalProfil | Σ | 1..1 | canonical(StructureDefinition)Pattern |
security | Σ | 0..0 | CodingBinding |
tag | Σ | 0..0 | Coding |
implicitRules | Σ ?! | 0..0 | uri |
language | 0..0 | codeBinding | |
text | S | 0..1 | Narrative |
id | 0..1 | string | |
extension | C | 0..* | Extension |
status | S | 1..1 | codeBindingFixed Value |
div | S C | 1..1 | xhtml |
contained | 0..0 | Resource | |
extension | S C | 1..* | Extension |
diagnosefremdsprachen | S C | 0..* | Extension(Coding) |
terminprofilname | S C | 1..1 | Extension(string) |
modifierExtension | ?! C | 0..* | Extension |
identifier | S Σ | 1..1 | Identifier |
id | 0..1 | string | |
extension | C | 0..* | Extension |
use | Σ ?! | 0..0 | codeBinding |
type | Σ | 0..0 | CodeableConceptBinding |
system | S Σ | 1..1 | uriPattern |
value | S Σ | 1..1 | string |
period | Σ | 0..0 | Period |
assigner | Σ | 0..0 | Reference(Organization) |
active | Σ ?! | 0..0 | boolean |
serviceCategory | Σ | 0..0 | CodeableConcept |
serviceType | Σ | 0..0 | CodeableConcept |
specialty | Σ | 0..0 | CodeableConceptBinding |
actor | S Σ | 1..1 | Reference(KBV_PR_KV_DIGITAL_TS_DRITTE_Location) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
reference | S Σ C | 1..1 | string |
type | Σ | 0..0 | uriBinding |
identifier | Σ | 0..0 | Identifier |
display | Σ | 0..0 | string |
planningHorizon | Σ | 0..0 | Period |
comment | S | 0..1 | string |
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. | ||
Cardinality | 0..* | ||
Alias | Availability | ||
Constraints |
| ||
Mappings |
| ||
Schedule.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
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 | |||
Short | Metadata about the resource | ||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||
Cardinality | 1..1 | ||
Type | Meta | ||
Summary | True | ||
Constraints |
| ||
Schedule.meta.id | |||
Short | Unique id for inter-element referencing | ||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Schedule.meta.extension | |||
Short | Additional content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Schedule.meta.versionId | |||
Short | Version specific identifier | ||
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||
Cardinality | 0..0 | ||
Type | id | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Schedule.meta.lastUpdated | |||
Short | When the resource version last changed | ||
Definition | When the resource last changed - e.g. when the version changed. | ||
Cardinality | 0..0 | ||
Type | instant | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Schedule.meta.source | |||
Short | Identifies where the resource comes from | ||
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance 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. | ||
Cardinality | 0..0 | ||
Type | uri | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Schedule.meta.profile | |||
Short | Profiles this resource claims to conform to | ||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||
Cardinality | 1..* | ||
Type | canonical(StructureDefinition) | ||
Summary | True | ||
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. | ||
Slicing | Unordered, Open, by $this(Value) | ||
Constraints |
| ||
Schedule.meta.profile:kvdigitalProfil | |||
Short | Profiles this resource claims to conform to | ||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||
Cardinality | 1..1 | ||
Type | canonical(StructureDefinition) | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Pattern | https://fhir.kbv.de/StructureDefinition/KBV_PR_KV_DIGITAL_TS_DRITTE_Schedule_Slot_Profile|1.1.0 | ||
Schedule.meta.security | |||
Short | Security Labels applied to this resource | ||
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||
Cardinality | 0..0 | ||
Type | Coding | ||
Binding | Security Labels from the Healthcare Privacy and Security Classification System. | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Schedule.meta.tag | |||
Short | Tags applied to this resource | ||
Definition | Tags 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. | ||
Cardinality | 0..0 | ||
Type | Coding | ||
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Schedule.implicitRules | |||
Short | A set of rules under which this content was created | ||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||
Cardinality | 0..0 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Schedule.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..0 | ||
Type | code | ||
Binding | A human language.
| ||
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). | ||
Constraints |
| ||
Schedule.text | |||
Short | Text summary of the resource, for human interpretation | ||
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. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Must Support | True | ||
Alias | narrative, 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. | ||
Constraints |
| ||
Mappings |
| ||
Schedule.text.id | |||
Short | Unique id for inter-element referencing | ||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Schedule.text.extension | |||
Short | Additional content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Schedule.text.status | |||
Short | generated | extensions | additional | empty | ||
Definition | The 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. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | The status of a resource narrative. | ||
Must Support | True | ||
Constraints |
| ||
Fixed Value | extensions | ||
Mappings |
| ||
Schedule.text.div | |||
Short | Limited xhtml content | ||
Definition | The actual narrative content, a stripped down version of XHTML. | ||
Cardinality | 1..1 | ||
Type | xhtml | ||
Must Support | True | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Schedule.contained | |||
Short | Contained, inline Resources | ||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
Cardinality | 0..0 | ||
Type | Resource | ||
Alias | inline 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 |
| ||
Schedule.extension | |||
Short | Additional content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 1..* | ||
Type | Extension | ||
Must Support | True | ||
Alias | extensions, 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. | ||
Slicing | Unordered, Open, by url(Value) | ||
Constraints |
| ||
Mappings |
| ||
Schedule.extension:diagnosefremdsprachen | |||
Short | Liste von Diagnosefremdsprachen | ||
Definition | Liste der Codings für Fremdsprachen (abgesehen von deutsch), in der der Arzt mit dem Patienten kommunizieren und eine Diagnose stellen kann. | ||
Cardinality | 0..* | ||
Type | Extension(Coding) | ||
Must Support | True | ||
Alias | extensions, 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Schedule.extension:terminprofilname | |||
Short | Name des Terminprofils | ||
Definition | Die Extension enthält den Namen des Terminprofils; die Angabe eines Namens ist verpflichtend. | ||
Cardinality | 1..1 | ||
Type | Extension(string) | ||
Must Support | True | ||
Alias | extensions, user content | ||
Comments | Der Name eines Terminrprofil muss nicht eindeutig sein. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Schedule.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, 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. | ||
Constraints |
| ||
Mappings |
| ||
Schedule.identifier | |||
Short | External Ids for this item | ||
Definition | External Ids for this item. | ||
Cardinality | 1..1 | ||
Type | Identifier | ||
Must Support | True | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Schedule.identifier.id | |||
Short | Unique id for inter-element referencing | ||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Schedule.identifier.extension | |||
Short | Additional content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Schedule.identifier.use | |||
Short | usual | official | temp | secondary | old (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..0 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Schedule.identifier.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..0 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Schedule.identifier.system | |||
Short | UUID | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Must Support | True | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Pattern | urn:ietf:rfc:4122 | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
Schedule.identifier.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Must Support | True | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Examples | General123456 | ||
Mappings |
| ||
Schedule.identifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..0 | ||
Type | Period | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Schedule.identifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..0 | ||
Type | Reference(Organization) | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Schedule.active | |||
Short | Whether this schedule is in active use | ||
Definition | Whether this schedule record is in active use or should not be used (such as was entered in error). | ||
Cardinality | 0..0 | ||
Type | boolean | ||
Modifier | True | ||
Summary | True | ||
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. | ||
Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
Constraints |
| ||
Mappings |
| ||
Schedule.serviceCategory | |||
Short | High-level category | ||
Definition | A broad categorization of the service that is to be performed during this appointment. | ||
Cardinality | 0..0 | ||
Type | CodeableConcept | ||
Binding | |||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Schedule.serviceType | |||
Short | Specific service | ||
Definition | The specific service that is to be performed during this appointment. | ||
Cardinality | 0..0 | ||
Type | CodeableConcept | ||
Binding | |||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Schedule.specialty | |||
Short | Type of specialty needed | ||
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment. | ||
Cardinality | 0..0 | ||
Type | CodeableConcept | ||
Binding | Additional details about where the content was created (e.g. clinical specialty). | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Schedule.actor | |||
Short | Praxis, die dieses Terminprofil angelegt hat | ||
Definition | Referenz auf die Praxis/medizinische Einrichtung, die das Terminprofil angelegt hat. | ||
Cardinality | 1..1 | ||
Type | Reference(KBV_PR_KV_DIGITAL_TS_DRITTE_Location) | ||
Must Support | True | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Schedule.actor.id | |||
Short | Unique id for inter-element referencing | ||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Schedule.actor.extension | |||
Short | Additional content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Schedule.actor.reference | |||
Short | Literal reference, Relative, internal or absolute URL | ||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||
Cardinality | 1..1 | ||
Type | string | ||
Must Support | True | ||
Summary | True | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ref-1 | ||
Constraints |
| ||
Mappings |
| ||
Schedule.actor.type | |||
Short | Type the reference refers to (e.g. "Patient") | ||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||
Cardinality | 0..0 | ||
Type | uri | ||
Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Schedule.actor.identifier | |||
Short | Logical reference, when literal reference is not known | ||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||
Cardinality | 0..0 | ||
Type | Identifier | ||
Summary | True | ||
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). | ||
Constraints |
| ||
Mappings |
| ||
Schedule.actor.display | |||
Short | Text alternative for the resource | ||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
Cardinality | 0..0 | ||
Type | string | ||
Summary | True | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Schedule.planningHorizon | |||
Short | Period of time covered by schedule | ||
Definition | The 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. | ||
Cardinality | 0..0 | ||
Type | Period | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Schedule.comment | |||
Short | Terminprofilhinweis | ||
Definition | Hinweise für Patienten zum Termin (bspw. "Bitte Handtuch mitbringen") | ||
Cardinality | 0..1 | ||
Type | string | ||
Must Support | True | ||
Constraints |
| ||
Mappings |
|
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.