{ "resourceType": "StructureDefinition", "id": "KBV-PR-Base-Appointment", "url": "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Appointment", "version": "1.8.0", "name": "KBV_PR_Base_Appointment", "title": "KBV_PR_Base_Appointment", "status": "active", "date": "2025-10-24", "publisher": "Kassenärztliche Bundesvereinigung (KBV)", "description": "Dieses Profil bildet einen Termin mit Interaktionen zwischen Patient:innen und behandelnden Personen bzw. Organisationen ab.", "copyright": "Copyright © [2025], Kassenärztliche Bundesvereinigung (KBV). All rights reserved. Im folgenden Profil können Codes aus den Codesystemen Snomed, Loinc oder Ucum enthalten sein, die dem folgenden Urheberrecht unterliegen: This material includes SNOMED Clinical Terms® SNOMED CT® which is used by permission of SNOMED International. All rights reserved. SNOMED CT®, was originally created by The College of American Pathologists. SNOMED and SNOMED CT are registered trademarks of SNOMED International. Implementers of these artefacts must have the appropriate SNOMED 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.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Appointment", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Appointment", "derivation": "constraint", "snapshot": { "element": [ { "id": "Appointment", "path": "Appointment", "short": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)", "definition": "Ein gebuchtes Ereignis innerhalb eines Behandlungskontexts zwischen verschiedenen Akteuren des Gesundheitswesens zu einem bestimmten Zeitpunkt. Dies kann in einer oder mehreren Begegnung/en resultieren und kann das Blockieren eines Zeitblocks in einem Kalender involvieren.", "min": 0, "max": "*", "base": { "path": "Appointment", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-3", "severity": "error", "human": "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", "expression": "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()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." } ], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "app-4", "severity": "error", "human": "Cancelation reason is only used for appointments that have been cancelled, or no-show", "expression": "Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')", "xpath": "not(exists(f:cancellationReason)) or f:status/@value=('no-show', 'cancelled')", "source": "http://hl7.org/fhir/StructureDefinition/Appointment" }, { "key": "app-3", "severity": "error", "human": "Only proposed or cancelled appointments can be missing start/end dates", "expression": "(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))", "xpath": "((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled') or (f:status/@value='waitlist'))", "source": "http://hl7.org/fhir/StructureDefinition/Appointment" }, { "key": "app-2", "severity": "error", "human": "Either start and end are specified, or neither", "expression": "start.exists() = end.exists()", "xpath": "((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))", "source": "http://hl7.org/fhir/StructureDefinition/Appointment" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Request" }, { "identity": "rim", "map": "Act[@moodCode <= 'INT']" }, { "identity": "ical", "map": "VEVENT" } ] }, { "id": "Appointment.id", "path": "Appointment.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.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isSummary": true }, { "id": "Appointment.meta", "path": "Appointment.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.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Appointment.implicitRules", "path": "Appointment.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.", "comment": "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.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Appointment.language", "path": "Appointment.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "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).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" } ], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Appointment.text", "path": "Appointment.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "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.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "Act.text?" } ] }, { "id": "Appointment.contained", "path": "Appointment.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.", "comment": "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Appointment.extension", "path": "Appointment.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Appointment.modifierExtension", "path": "Appointment.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "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.", "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](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Appointment.identifier", "path": "Appointment.identifier", "short": "External Ids for this item", "definition": "This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).", "min": 0, "max": "*", "base": { "path": "Appointment.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "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]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "workflow", "map": "Request.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "SCH-1, SCH-2, ARQ-1, ARQ-2" }, { "identity": "rim", "map": ".id" }, { "identity": "ical", "map": "UID" } ] }, { "id": "Appointment.status", "path": "Appointment.status", "short": "proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist", "definition": "Hier wird der übergreifende Status des Termins als kodierter Wert abgebildet.", "comment": "If the Appointment's status is \"cancelled\" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.", "min": 1, "max": "1", "base": { "path": "Appointment.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AppointmentStatus" } ], "strength": "required", "description": "The free/busy status of an appointment.", "valueSet": "http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "v2", "map": "SCH-25" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "ical", "map": "STATUS" } ] }, { "id": "Appointment.cancelationReason", "path": "Appointment.cancelationReason", "short": "The coded reason for the appointment being cancelled", "definition": "The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.", "comment": "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.", "min": 0, "max": "1", "base": { "path": "Appointment.cancelationReason", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "cancelation-reason" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/appointment-cancellation-reason" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" } ] }, { "id": "Appointment.serviceCategory", "path": "Appointment.serviceCategory", "short": "A broad categorization of the service that is to be performed during this appointment", "definition": "Hier wird eine breite Kategorisierung möglicher Behandlungen und Services, welche innerhalb eines Termins erfolgen können, als kodierte Information oder als Freitexteingabe angegeben.", "comment": "Beispiele: Hausarzt, Krankenhaus oder Transport.", "min": 0, "max": "*", "base": { "path": "Appointment.serviceCategory", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "service-category" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/service-category" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "rim", "map": "n/a, might be inferred from the ServiceDeliveryLocation" }, { "identity": "ical", "map": "CATEGORIES" } ] }, { "id": "Appointment.serviceType", "path": "Appointment.serviceType", "short": "The specific service that is to be performed during this appointment", "definition": "Hier wird die Art der Services oder Leistungen, welche innerhalb des Termins durchgeführt werden, als kodierte Information oder als Freitexteingabe angegeben.", "comment": "Beispiele: Beratungsleistungen, Hilfsmittelversorgung, diagnostische Bildgebungsverfahren, Operationen etc.", "min": 0, "max": "*", "base": { "path": "Appointment.serviceType", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "service-type" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/service-type" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "workflow", "map": "Request.code" }, { "identity": "rim", "map": "n/a, might be inferred from the ServiceDeliveryLocation" } ] }, { "id": "Appointment.specialty", "path": "Appointment.specialty", "short": "The specialty of a practitioner that would be required to perform the service requested in this appointment", "definition": "In diesem Element befindet sich Fachrichtung des behandelnden Leistungserbringers, welche zur Durchführung der geforderten Leistung benötigt wird, in kodierter Form oder als Freitext.", "comment": "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.", "min": 0, "max": "*", "base": { "path": "Appointment.specialty", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "specialty" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/c80-practice-codes" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".performer.AssignedPerson.code" } ] }, { "id": "Appointment.specialty.id", "path": "Appointment.specialty.id", "representation": [ "xmlAttr" ], "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.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Appointment.specialty.extension", "path": "Appointment.specialty.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Appointment.specialty.coding", "path": "Appointment.specialty.coding", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "description": "Hier wird ein Code aus einem geeigneten Codesystem angegeben.", "rules": "open" }, "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung", "path": "Appointment.specialty.coding", "sliceName": "KBV-Fachgruppenkodierung", "short": "Fachrichtung nach KBV-Schlüsseltabelle", "definition": "Hier wird die Fachrichtung/Fachabteilung anhand der KBV-Schlüsseltabelle S_BAR2_ARZTNRFACHGRUPPE wiedergegeben.\\nDiese enthält die zweistellige Fachgruppencodierung für die 8.+9. Stelle der LANR (nach BAR-Schlüsselverzeichnis, Anlage 35).", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "patternCoding": { "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR2_ARZTNRFACHGRUPPE" }, "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "strength": "required", "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_BAR2_ARZTNRFACHGRUPPE" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung.id", "path": "Appointment.specialty.coding.id", "representation": [ "xmlAttr" ], "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.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung.extension", "path": "Appointment.specialty.coding.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung.system", "path": "Appointment.specialty.coding.system", "short": "Identity of the terminology system", "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung.version", "path": "Appointment.specialty.coding.version", "short": "Version of the system - if relevant", "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min": 1, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung.code", "path": "Appointment.specialty.coding.code", "short": "Symbol in syntax defined by the system", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "requirements": "Need to refer to a particular code in the system.", "min": 1, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Appointment.specialty.coding.display", "short": "Representation defined by the system", "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 1, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung.userSelected", "path": "Appointment.specialty.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ] }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert", "path": "Appointment.specialty.coding", "sliceName": "HL7-FachabteilungsschluesselErweitert", "short": "Fachrichtung nach HL7 FachabteilungsschlüsselErweitert", "definition": "Hier wird die Fachrichtung/Fachabteilung anhand eines Codes aus dem Codesystem \"FachabteilungsschlüsselErweitert\" der HL7 Basis Deutschland angegeben.", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "patternCoding": { "system": "http://fhir.de/CodeSystem/dkgev/Fachabteilungsschluessel-erweitert" }, "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "strength": "required", "valueSet": "http://fhir.de/ValueSet/dkgev/Fachabteilungsschluessel-erweitert" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" }, { "identity": "rim", "map": "CV" }, { "identity": "orim", "map": "fhir:Coding rdfs:subClassOf dt:CDCoding" }, { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert.id", "path": "Appointment.specialty.coding.id", "representation": [ "xmlAttr" ], "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.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert.extension", "path": "Appointment.specialty.coding.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert.system", "path": "Appointment.specialty.coding.system", "short": "Identity of the terminology system", "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert.version", "path": "Appointment.specialty.coding.version", "short": "Version of the system - if relevant", "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min": 1, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert.code", "path": "Appointment.specialty.coding.code", "short": "Symbol in syntax defined by the system", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "requirements": "Need to refer to a particular code in the system.", "min": 1, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Appointment.specialty.coding.display", "short": "Representation defined by the system", "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 1, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert.userSelected", "path": "Appointment.specialty.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ] }, { "id": "Appointment.specialty.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Appointment.specialty.text", "short": "Plain text representation of the concept", "definition": "Hier wird die Fachrichtung als Freitext angegeben.", "comment": "Very often the text is the same as a displayName of one of the codings.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "id": "Appointment.appointmentType", "path": "Appointment.appointmentType", "short": "The style of appointment or patient that has been booked in the slot (not service type)", "definition": "Hier wird die Art des Termins oder der Patient:in, für welche ein Zeitblock gebucht wurde, als kodierte Information oder als Freitexteingabe angegeben.", "comment": "Beispiele: Routineuntersuchung, Folgetermine oder Notfälle.", "min": 0, "max": "1", "base": { "path": "Appointment.appointmentType", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "appointment-type" } ], "strength": "preferred", "valueSet": "http://terminology.hl7.org/ValueSet/v2-0276" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "ARQ-7" }, { "identity": "rim", "map": ".code" }, { "identity": "ical", "map": "CLASSIFICATION" } ] }, { "id": "Appointment.reasonCode", "path": "Appointment.reasonCode", "short": "Coded reason this appointment is scheduled", "definition": "In diesem Element wird der Grund des Kommens als Code angegeben. Dieser Grund ist eher klinisch als administrativ, z.B. dargestellt durch SNOMED Findings.", "comment": "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.", "min": 0, "max": "*", "base": { "path": "Appointment.reasonCode", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ApptReason" } ], "strength": "preferred", "description": "The Reason for the appointment to take place.", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-reason" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "workflow", "map": "Request.reasonCode" }, { "identity": "v2", "map": "AIS-3, SCH-7" }, { "identity": "rim", "map": ".reasonCode" } ] }, { "id": "Appointment.reasonReference", "path": "Appointment.reasonReference", "short": "Reason the appointment is to take place (resource)", "definition": "Hier werden Instanzen referenziert, welche die Buchung eines Termins begründen. Bei Ankunft des Patienten könnten diese z.B. als Einweisungsdiagnose genutzt werden.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "*", "base": { "path": "Appointment.reasonReference", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Procedure", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Condition_Diagnosis|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Procedure|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Heart_Rate|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Blood_Pressure|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Body_Temperature|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Pain_Scale_Score|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Respiratory_Rate|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Peripheral_Oxygen_Saturation|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Glucose_Concentration|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Body_Weight|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Body_Height|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Pregnancy_Status|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Estimated_Date_of_Delivery|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Head_Circumference|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Apgar_Score|1.8.0" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Request.reasonReference" }, { "identity": "rim", "map": ".inboundRelationship[@typeCode = 'RSON'].observation" } ] }, { "id": "Appointment.priority", "path": "Appointment.priority", "short": "Used to make informed decisions if needing to re-prioritize", "definition": "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).", "comment": "Seeking implementer feedback on this property and how interoperable it is.\r\rUsing an extension to record a CodeableConcept for named values may be tested at a future connectathon.", "min": 0, "max": "1", "base": { "path": "Appointment.priority", "min": 0, "max": "1" }, "type": [ { "code": "unsignedInt" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "v2", "map": "ARQ-12, SCH-11.6 / TQ1-9" }, { "identity": "rim", "map": ".priorityCode" }, { "identity": "ical", "map": "PRIORITY" } ] }, { "id": "Appointment.description", "path": "Appointment.description", "short": "Shown on a subject line in a meeting request, or appointment list", "definition": "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Appointment.description", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "NTE-3" }, { "identity": "rim", "map": ".text" }, { "identity": "ical", "map": "SUMMARY" } ] }, { "id": "Appointment.supportingInformation", "path": "Appointment.supportingInformation", "short": "Additional information to support the appointment", "definition": "Additional information to support the appointment provided when making the appointment.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "*", "base": { "path": "Appointment.supportingInformation", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Request.supportingInfo" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "rim", "map": ".inboundRelationship[@typeCode = 'SPRT'].observation" }, { "identity": "ical", "map": "ATTACH" } ] }, { "id": "Appointment.start", "path": "Appointment.start", "short": "When appointment is to take place", "definition": "Hier wird der Beginn des Termins als Zeitpunkt festgehalten.", "comment": "Für die Abbildung eines Zeitpunktes, sind Appointment.start sowie Appointment.end auf den gleichen Wert zu setzen.", "min": 0, "max": "1", "base": { "path": "Appointment.start", "min": 0, "max": "1" }, "type": [ { "code": "instant" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.init" }, { "identity": "v2", "map": "ARQ-11.1, SCH-11.4 / TQ1-7" }, { "identity": "rim", "map": ".effectiveTime.low" }, { "identity": "ical", "map": "DTSTART" } ] }, { "id": "Appointment.end", "path": "Appointment.end", "short": "When appointment is to conclude", "definition": "Hier wird das Ende des Termins als Zeitpunkt festgehalten.", "comment": "Für die Abbildung eines Zeitpunktes, sind Appointment.start sowie Appointment.end auf den gleichen Wert zu setzen.", "min": 0, "max": "1", "base": { "path": "Appointment.end", "min": 0, "max": "1" }, "type": [ { "code": "instant" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "v2", "map": "SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9" }, { "identity": "rim", "map": ".effectiveTime.high" }, { "identity": "ical", "map": "DTEND" } ] }, { "id": "Appointment.minutesDuration", "path": "Appointment.minutesDuration", "short": "Can be less than start/end (e.g. estimate)", "definition": "Hier wird die Zeit in Minuten angegeben, welche tatsächlich für den Termin verbraucht wurde. Dies kann weniger als die Zeitspanne zwischen Start und Ende sein.", "comment": "32 bit number; for values larger than this, use decimal", "min": 0, "max": "1", "base": { "path": "Appointment.minutesDuration", "min": 0, "max": "1" }, "type": [ { "code": "positiveInt" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.occurrence[x]" }, { "identity": "rim", "map": ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width" }, { "identity": "ical", "map": "DURATION (e.g. PT15M)" } ] }, { "id": "Appointment.slot", "path": "Appointment.slot", "short": "The slots that this appointment is filling", "definition": "The slots from the participants' schedules that will be filled by the appointment.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "*", "base": { "path": "Appointment.slot", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Slot" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "rim", "map": ".outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']" } ] }, { "id": "Appointment.created", "path": "Appointment.created", "short": "The date that this appointment was initially created", "definition": "The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.", "comment": "This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.", "min": 0, "max": "1", "base": { "path": "Appointment.created", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "rim", "map": ".author.time" }, { "identity": "ical", "map": "CREATED" } ] }, { "id": "Appointment.comment", "path": "Appointment.comment", "short": "Additional comments", "definition": "Additional comments about the appointment.", "comment": "Additional text to aid in facilitating the appointment. For instance, a comment might be, \"patient should proceed immediately to infusion room upon arrival\"\r\rWhere this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.", "min": 0, "max": "1", "base": { "path": "Appointment.comment", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.note" }, { "identity": "v2", "map": "NTE-3" }, { "identity": "rim", "map": ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value" }, { "identity": "ical", "map": "DESCRIPTION (for internal use)" } ] }, { "id": "Appointment.patientInstruction", "path": "Appointment.patientInstruction", "short": "Detailed information and instructions for the patient", "definition": "While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Appointment.patientInstruction", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "NTE-3" }, { "identity": "rim", "map": ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value" }, { "identity": "ical", "map": "DESCRIPTION (for patient use)" } ] }, { "id": "Appointment.basedOn", "path": "Appointment.basedOn", "short": "The service request this appointment is allocated to assess", "definition": "The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "alias": [ "incomingReferral" ], "min": 0, "max": "*", "base": { "path": "Appointment.basedOn", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ServiceRequest" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "workflow", "map": "Request.basedOn" }, { "identity": "rim", "map": ".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']" } ] }, { "id": "Appointment.participant", "path": "Appointment.participant", "short": "Participants involved in appointment", "definition": "Hier werden alle Akteure angegeben, die an dem Termin beteiligt sind.", "min": 1, "max": "*", "base": { "path": "Appointment.participant", "min": 1, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "app-1", "severity": "error", "human": "Either the type or actor on the participant SHALL be specified", "expression": "type.exists() or actor.exists()", "xpath": "(exists(f:type) or exists(f:actor))", "source": "http://hl7.org/fhir/StructureDefinition/Appointment" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "workflow", "map": "Request.performer, Request.subject" }, { "identity": "v2", "map": "PID, AIP, AIG, AIL" }, { "identity": "rim", "map": "performer | reusableDevice | subject | location" }, { "identity": "ical", "map": "ATTENDEE component to be created" } ] }, { "id": "Appointment.participant.id", "path": "Appointment.participant.id", "representation": [ "xmlAttr" ], "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.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Appointment.participant.extension", "path": "Appointment.participant.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Appointment.participant.modifierExtension", "path": "Appointment.participant.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "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.", "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](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "Appointment.participant.type", "path": "Appointment.participant.type", "short": "Role of participant in the appointment", "definition": "Hier wird angegeben, welche Rolle der Teilnehmer innerhalb des Termins spielt, dargestellt in kodierter Form oder als Freitexteingabe.", "comment": "The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.\r\rIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\r\rThis value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.", "min": 0, "max": "*", "base": { "path": "Appointment.participant.type", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParticipantType" } ], "strength": "extensible", "description": "Role of participant in encounter.", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-participant-type" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "AIP-4, AIG-4" }, { "identity": "rim", "map": "(performer | reusableDevice | subject | location).@typeCode" }, { "identity": "ical", "map": "n/a" } ] }, { "id": "Appointment.participant.actor", "path": "Appointment.participant.actor", "short": "Person, Location/HealthcareService or Device", "definition": "In diesem Element erfolgt eine Referenz auf eine Person, Einrichtung oder ein Gerät, welche/r am Termin beteiligt ist. Dies kann z. B. eine behandelnde Person, eine Patient:in, ein medizinisches Gerät oder eine Kontaktperson sein.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "min": 0, "max": "1", "base": { "path": "Appointment.participant.actor", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Location", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Patient|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Practitioner|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_PractitionerRole|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_RelatedPerson|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Device|1.8.0" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])", "source": "http://hl7.org/fhir/StructureDefinition/Reference" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "w5", "map": "FiveWs.who" }, { "identity": "v2", "map": "PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3" }, { "identity": "rim", "map": "performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation" }, { "identity": "ical", "map": "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not \"information-only\"" } ] }, { "id": "Appointment.participant.required", "path": "Appointment.participant.required", "short": "required | optional | information-only", "definition": "Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Appointment.participant.required", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParticipantRequired" } ], "strength": "required", "description": "Is the Participant required to attend the appointment.", "valueSet": "http://hl7.org/fhir/ValueSet/participantrequired|4.0.1" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "(performer | reusableDevice | subject | location).@performInd" }, { "identity": "ical", "map": "ROLE=REQ-PARTICIPANT (roleparam)" } ] }, { "id": "Appointment.participant.status", "path": "Appointment.participant.status", "short": "accepted | declined | tentative | needs-action", "definition": "Dieses Element zeigt den Status des Teilnehmers in kodierter Form an, z.B. akzeptiert, abgelehnt.", "comment": "Note that FHIR strings SHALL NOT exceed 1MB in size", "min": 1, "max": "1", "base": { "path": "Appointment.participant.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParticipationStatus" } ], "strength": "required", "description": "The Participation status of an appointment.", "valueSet": "http://hl7.org/fhir/ValueSet/participationstatus|4.0.1" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "AIP-12, AIG-14" }, { "identity": "rim", "map": "(performer | reusableDevice | subject | location).statusCode" }, { "identity": "ical", "map": "ATTENDEE;CN=\"John Doe\";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)" } ] }, { "id": "Appointment.participant.period", "path": "Appointment.participant.period", "short": "Participation period of the actor", "definition": "Participation period of the actor.", "comment": "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\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).", "min": 0, "max": "1", "base": { "path": "Appointment.participant.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower value than end", "expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)", "xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))", "source": "http://hl7.org/fhir/StructureDefinition/Period" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]" } ] }, { "id": "Appointment.requestedPeriod", "path": "Appointment.requestedPeriod", "short": "Potential date/time interval(s) requested to allocate the appointment within", "definition": "A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.\n\nThe duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.", "comment": "This does not introduce a capacity for recurring appointments.", "min": 0, "max": "*", "base": { "path": "Appointment.requestedPeriod", "min": 0, "max": "*" }, "type": [ { "code": "Period" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower value than end", "expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)", "xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))", "source": "http://hl7.org/fhir/StructureDefinition/Period" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]" }, { "identity": "workflow", "map": "Request.occurrence[x]" }, { "identity": "v2", "map": "ARQ-11" }, { "identity": "rim", "map": ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]" } ] } ] }, "differential": { "element": [ { "id": "Appointment", "path": "Appointment", "definition": "Ein gebuchtes Ereignis innerhalb eines Behandlungskontexts zwischen verschiedenen Akteuren des Gesundheitswesens zu einem bestimmten Zeitpunkt. Dies kann in einer oder mehreren Begegnung/en resultieren und kann das Blockieren eines Zeitblocks in einem Kalender involvieren." }, { "id": "Appointment.status", "path": "Appointment.status", "definition": "Hier wird der übergreifende Status des Termins als kodierter Wert abgebildet." }, { "id": "Appointment.serviceCategory", "path": "Appointment.serviceCategory", "definition": "Hier wird eine breite Kategorisierung möglicher Behandlungen und Services, welche innerhalb eines Termins erfolgen können, als kodierte Information oder als Freitexteingabe angegeben.", "comment": "Beispiele: Hausarzt, Krankenhaus oder Transport." }, { "id": "Appointment.serviceType", "path": "Appointment.serviceType", "definition": "Hier wird die Art der Services oder Leistungen, welche innerhalb des Termins durchgeführt werden, als kodierte Information oder als Freitexteingabe angegeben.", "comment": "Beispiele: Beratungsleistungen, Hilfsmittelversorgung, diagnostische Bildgebungsverfahren, Operationen etc." }, { "id": "Appointment.specialty", "path": "Appointment.specialty", "definition": "In diesem Element befindet sich Fachrichtung des behandelnden Leistungserbringers, welche zur Durchführung der geforderten Leistung benötigt wird, in kodierter Form oder als Freitext." }, { "id": "Appointment.specialty.coding", "path": "Appointment.specialty.coding", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "description": "Hier wird ein Code aus einem geeigneten Codesystem angegeben.", "rules": "open" } }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung", "path": "Appointment.specialty.coding", "sliceName": "KBV-Fachgruppenkodierung", "short": "Fachrichtung nach KBV-Schlüsseltabelle", "definition": "Hier wird die Fachrichtung/Fachabteilung anhand der KBV-Schlüsseltabelle S_BAR2_ARZTNRFACHGRUPPE wiedergegeben.\\nDiese enthält die zweistellige Fachgruppencodierung für die 8.+9. Stelle der LANR (nach BAR-Schlüsselverzeichnis, Anlage 35).", "min": 0, "max": "*", "patternCoding": { "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_BAR2_ARZTNRFACHGRUPPE" }, "binding": { "strength": "required", "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_BAR2_ARZTNRFACHGRUPPE" } }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung.system", "path": "Appointment.specialty.coding.system", "min": 1 }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung.version", "path": "Appointment.specialty.coding.version", "min": 1 }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung.code", "path": "Appointment.specialty.coding.code", "min": 1 }, { "id": "Appointment.specialty.coding:KBV-Fachgruppenkodierung.display", "path": "Appointment.specialty.coding.display", "min": 1 }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert", "path": "Appointment.specialty.coding", "sliceName": "HL7-FachabteilungsschluesselErweitert", "short": "Fachrichtung nach HL7 FachabteilungsschlüsselErweitert", "definition": "Hier wird die Fachrichtung/Fachabteilung anhand eines Codes aus dem Codesystem \"FachabteilungsschlüsselErweitert\" der HL7 Basis Deutschland angegeben.", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/dkgev/Fachabteilungsschluessel-erweitert" }, "binding": { "strength": "required", "valueSet": "http://fhir.de/ValueSet/dkgev/Fachabteilungsschluessel-erweitert" } }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert.system", "path": "Appointment.specialty.coding.system", "min": 1 }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert.version", "path": "Appointment.specialty.coding.version", "min": 1 }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert.code", "path": "Appointment.specialty.coding.code", "min": 1 }, { "id": "Appointment.specialty.coding:HL7-FachabteilungsschluesselErweitert.display", "path": "Appointment.specialty.coding.display", "min": 1 }, { "id": "Appointment.specialty.text", "path": "Appointment.specialty.text", "definition": "Hier wird die Fachrichtung als Freitext angegeben." }, { "id": "Appointment.appointmentType", "path": "Appointment.appointmentType", "definition": "Hier wird die Art des Termins oder der Patient:in, für welche ein Zeitblock gebucht wurde, als kodierte Information oder als Freitexteingabe angegeben.", "comment": "Beispiele: Routineuntersuchung, Folgetermine oder Notfälle." }, { "id": "Appointment.reasonCode", "path": "Appointment.reasonCode", "definition": "In diesem Element wird der Grund des Kommens als Code angegeben. Dieser Grund ist eher klinisch als administrativ, z.B. dargestellt durch SNOMED Findings." }, { "id": "Appointment.reasonReference", "path": "Appointment.reasonReference", "definition": "Hier werden Instanzen referenziert, welche die Buchung eines Termins begründen. Bei Ankunft des Patienten könnten diese z.B. als Einweisungsdiagnose genutzt werden.", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Procedure", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Condition_Diagnosis|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Procedure|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Heart_Rate|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Blood_Pressure|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Body_Temperature|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Pain_Scale_Score|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Respiratory_Rate|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Peripheral_Oxygen_Saturation|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Glucose_Concentration|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Body_Weight|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Body_Height|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Pregnancy_Status|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Estimated_Date_of_Delivery|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Head_Circumference|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Observation_Apgar_Score|1.8.0" ] } ] }, { "id": "Appointment.start", "path": "Appointment.start", "definition": "Hier wird der Beginn des Termins als Zeitpunkt festgehalten.", "comment": "Für die Abbildung eines Zeitpunktes, sind Appointment.start sowie Appointment.end auf den gleichen Wert zu setzen." }, { "id": "Appointment.end", "path": "Appointment.end", "definition": "Hier wird das Ende des Termins als Zeitpunkt festgehalten.", "comment": "Für die Abbildung eines Zeitpunktes, sind Appointment.start sowie Appointment.end auf den gleichen Wert zu setzen." }, { "id": "Appointment.minutesDuration", "path": "Appointment.minutesDuration", "definition": "Hier wird die Zeit in Minuten angegeben, welche tatsächlich für den Termin verbraucht wurde. Dies kann weniger als die Zeitspanne zwischen Start und Ende sein." }, { "id": "Appointment.participant", "path": "Appointment.participant", "definition": "Hier werden alle Akteure angegeben, die an dem Termin beteiligt sind." }, { "id": "Appointment.participant.type", "path": "Appointment.participant.type", "definition": "Hier wird angegeben, welche Rolle der Teilnehmer innerhalb des Termins spielt, dargestellt in kodierter Form oder als Freitexteingabe." }, { "id": "Appointment.participant.actor", "path": "Appointment.participant.actor", "definition": "In diesem Element erfolgt eine Referenz auf eine Person, Einrichtung oder ein Gerät, welche/r am Termin beteiligt ist. Dies kann z. B. eine behandelnde Person, eine Patient:in, ein medizinisches Gerät oder eine Kontaktperson sein.", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Location", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Patient|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Practitioner|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_PractitionerRole|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_RelatedPerson|1.8.0", "https://fhir.kbv.de/StructureDefinition/KBV_PR_Base_Device|1.8.0" ] } ] }, { "id": "Appointment.participant.status", "path": "Appointment.participant.status", "definition": "Dieses Element zeigt den Status des Teilnehmers in kodierter Form an, z.B. akzeptiert, abgelehnt." } ] } }