ENRICH-mHealth FHIR Implementation Guide
0.1.0 - ci-build
ENRICH-mHealth FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-07-16 |
Definitions for the enrich-mhealth-encounter resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Encounter | |
| Definition | An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. |
| Short | An interaction during which services are provided to the patient |
| Control | 0..* |
| Is Modifier | false |
| Alternate Names | Visit |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) mii-enc-1: Falls der Encounter abgeschlossen wurde, MUSS ein Enddatum bekannt sein ( status = 'finished' implies period.end.exists())mii-enc-2: Abgeschlossene, stationäre Kontakte MÜSSEN einen Start- und End-Zeitpunkt angeben ( status = 'finished' and class = 'IMP' implies period.start.exists() and period.end.exists())mii-enc-3: Geplante Kontakte DÜRFEN NICHT einen Start- oder End-Zeitpunkt angeben ( status = 'planned' implies period.exists().not())mii-enc-4: Geplante Kontakte SOLLTEN die Extensions für den geplanten Start- oder End-Zeitpunkt verwenden ( status = 'planned' implies extension.where(url = 'http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate').exists())mii-enc-5: In-Durchführung befindliche Kontakte MÜSSEN einen Start-Zeitpunkt angeben ( status = 'in-progress' implies period.start.exists())mii-enc-6: Kontakte mit Abwesenheitsstatus MÜSSEN einen Start-Zeitpunkt angeben ( status = 'onleave' implies period.start.exists())mii-enc-7: Kontakte mit unbekannten Status SOLLTEN einen Start-Zeitpunkt angeben ( status = 'unknown' implies period.start.exists()) |
| 2. Encounter.id | |
| Definition | Angabe OPTIONAL, vom Server automatisch vergebene system-abhängige ID The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| Control | 0..1 |
| Type | idstring |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| 4. Encounter.meta | |
| Definition | Angabe OPTIONAL zur Provenance und zum Profil 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. |
| Short | Metadata about the resource |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Encounter.meta.source | |
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
| Short | Identifies where the resource comes from |
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Encounter.meta.profile | |
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
| Short | Profiles this resource claims to conform to |
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | canonical(StructureDefinition, StructureDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Encounter.implicitRules | |
| 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. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | true because 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 |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Encounter.extension:Aufnahmegrund | |
| Slice Name | Aufnahmegrund |
| Definition | Admission reason according to key 1, appendix 2, data transmission according to § 301 para. 3 SGB V |
| Short | Aufnahmegrund |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ExtensionAufnahmegrund) (Complex Extension) |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 14. Encounter.extension:Aufnahmegrund.extension:ErsteUndZweiteStelle | |
| Slice Name | ErsteUndZweiteStelle |
| Definition | Admission reason 1st and 2nd position |
| Short | 1. und 2. StelleAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 16. Encounter.extension:Aufnahmegrund.extension:ErsteUndZweiteStelle.extension | |
| 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Encounter.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 18. Encounter.extension:Aufnahmegrund.extension:ErsteUndZweiteStelle.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | ErsteUndZweiteStelle |
| 20. Encounter.extension:Aufnahmegrund.extension:DritteStelle | |
| Slice Name | DritteStelle |
| Definition | Admission reason 3rd position |
| Short | 3. StelleAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 22. Encounter.extension:Aufnahmegrund.extension:DritteStelle.extension | |
| 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Encounter.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 24. Encounter.extension:Aufnahmegrund.extension:DritteStelle.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | DritteStelle |
| 26. Encounter.extension:Aufnahmegrund.extension:VierteStelle | |
| Slice Name | VierteStelle |
| Definition | Admission reason 4th position |
| Short | 4. StelleAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 28. Encounter.extension:Aufnahmegrund.extension:VierteStelle.extension | |
| 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Encounter.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 30. Encounter.extension:Aufnahmegrund.extension:VierteStelle.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | VierteStelle |
| 32. Encounter.extension:Aufnahmegrund.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | http://fhir.de/StructureDefinition/Aufnahmegrund |
| 34. Encounter.extension:Aufnahmegrund.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | Value of extension |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Standard Status | Normative (from Trial Use) |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. Encounter.extension:plannedStartDate | |
| Slice Name | plannedStartDate |
| Definition | Optional Extension Element - found in all resources. |
| Short | Optional Extensions Element |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(MII EX Fall Planned Start Date) (Extension Type: dateTime) |
| Standard Status | Normative (from Trial Use) |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 38. Encounter.extension:plannedEndDate | |
| Slice Name | plannedEndDate |
| Definition | Optional Extension Element - found in all resources. |
| Short | Optional Extensions Element |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(MII EX Fall Planned End Date) (Extension Type: dateTime) |
| Standard Status | Normative (from Trial Use) |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 40. Encounter.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Standard Status | Normative (from Trial Use) |
| 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. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Encounter.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 42. Encounter.identifier | |
| Definition | Identifier/s by which this encounter is known. Identifier(s) by which this encounter is known. |
| Short | IdentifikatorIdentifier(s) by which this encounter is known |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Encounter.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 44. Encounter.identifier:Aufnahmenummer | |
| Slice Name | Aufnahmenummer |
| Definition | Admission number, the patient receives during an admission. Identifier(s) by which this encounter is known. |
| Short | AufnahmenummerIdentifier(s) by which this encounter is known |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. Encounter.identifier:Aufnahmenummer.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. Encounter.identifier:Aufnahmenummer.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | Unless not suitable, these codes SHALL be taken from MII VS Fall Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1 (extensible to https://www.medizininformatik-initiative.de/fhir/core/modul-fall/ValueSet/identifier-type-codes)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 50. Encounter.identifier:Aufnahmenummer.type.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 10..* This element is affected by the following invariants: ele-1 |
| Type | Coding |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Encounter.identifier.type.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 52. Encounter.identifier:Aufnahmenummer.type.coding:vn-type | |
| Slice Name | vn-type |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 10..1* This element is affected by the following invariants: ele-1 |
| Type | Coding |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. Encounter.identifier:Aufnahmenummer.type.coding:vn-type.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Short | Identity of the terminology system |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 56. Encounter.identifier:Aufnahmenummer.type.coding:vn-type.code | |
| 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). |
| Short | Symbol in syntax defined by the system |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to refer to a particular code in the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. Encounter.identifier:Aufnahmenummer.system | |
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 60. Encounter.identifier:Aufnahmenummer.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | The value that is unique |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. Encounter.status | |
| Definition | planned | in-progress | onleave | finished | cancelled | entered-in-error | unknown planned | arrived | triaged | in-progress | onleave | finished | cancelled +. |
| Short | Statusplanned | arrived | triaged | in-progress | onleave | finished | cancelled + |
| Comments | Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes). |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from Encounter Status ValueSethttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 (required to http://fhir.de/ValueSet/EncounterStatusDe)Current state of the encounter. |
| Type | code |
| Is Modifier | true because This element is labeled 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 |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 64. Encounter.class | |
| Definition | ambulatory | inpatient encounter | pre-admission | virtual | short stay | home health Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations. |
| Short | KontaktklasseClassification of patient encounter |
| Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from EncounterClassDEhttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode (required to http://fhir.de/ValueSet/EncounterClassDE)Classification of the encounter. |
| Type | Coding |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. Encounter.type | |
| Definition | Specific type of encounter Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). |
| Short | KontakttypSpecific type of encounter |
| Comments | Since there are many ways to further classify encounters, this element is 0..*. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type|4.0.1 (example to http://hl7.org/fhir/ValueSet/encounter-type)The type of encounter. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Encounter.type. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 68. Encounter.type:Kontaktebene | |
| Slice Name | Kontaktebene |
| Definition | Differentiation of the encounter hierarchy levels: facility contact | department contact | care provider contact Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). |
| Short | KontaktebeneSpecific type of encounter |
| Comments | Since there are many ways to further classify encounters, this element is 0..*. |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from For example codes, see KontaktebeneDe ValueSethttp://hl7.org/fhir/ValueSet/encounter-type|4.0.1 (required to http://fhir.de/ValueSet/kontaktebene-de)Kontaktebene The type of encounter. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 70. Encounter.type:KontaktArt | |
| Slice Name | KontaktArt |
| Definition | Type of encounter such as pre-admission | post-admission | intensive care Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). |
| Short | KontaktartSpecific type of encounter |
| Comments | Since there are many ways to further classify encounters, this element is 0..*. |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from For example codes, see KontaktartDe ValueSethttp://hl7.org/fhir/ValueSet/encounter-type|4.0.1 (required to http://fhir.de/ValueSet/kontaktart-de)The type of encounter. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. Encounter.serviceType | |
| Definition | Department classification by department key Broad categorization of the service that is to be provided (e.g. cardiology). |
| Short | FachabteilungSpecific type of service |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see ServiceTypehttp://hl7.org/fhir/ValueSet/service-type|4.0.1 (example to http://hl7.org/fhir/ValueSet/service-type)Broad categorization of the service that is to be provided. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. Encounter.serviceType.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Coding |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Encounter.serviceType.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 76. Encounter.serviceType.coding:Fachabteilungsschluessel | |
| Slice Name | Fachabteilungsschluessel |
| Definition | Departments according to appendix 1 of the Bundespflegesatzverordnung A reference to a code defined by a terminology system. |
| Short | FachabteilungsschlüsselCode defined by a terminology system |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from For codes, see Fachabteilungsschlüssel ValueSet (required to http://fhir.de/ValueSet/dkgev/Fachabteilungsschluessel) |
| Type | Coding |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 78. Encounter.serviceType.coding:Fachabteilungsschluessel.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Short | Identity of the terminology system |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. Encounter.serviceType.coding:Fachabteilungsschluessel.code | |
| 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). |
| Short | Symbol in syntax defined by the system |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to refer to a particular code in the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. Encounter.serviceType.coding:ErweiterterFachabteilungsschluessel | |
| Slice Name | ErweiterterFachabteilungsschluessel |
| Definition | Departments according to appendix 1 of the Bundespflegesatzverordnung A reference to a code defined by a terminology system. |
| Short | Erweiterter FachabteilungsschlüsselCode defined by a terminology system |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from For codes, see FachabteilungsschluesselErweitert ValueSet (required to http://fhir.de/ValueSet/dkgev/Fachabteilungsschluessel-erweitert) |
| Type | Coding |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 84. Encounter.serviceType.coding:ErweiterterFachabteilungsschluessel.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Short | Identity of the terminology system |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 86. Encounter.serviceType.coding:ErweiterterFachabteilungsschluessel.code | |
| 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). |
| Short | Symbol in syntax defined by the system |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to refer to a particular code in the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 88. Encounter.subject | |
| Definition | VERPFLICHTEND, Referenz auf Patient:in. The patient or group present at the encounter. |
| Short | PatientenidentifikatorThe patient or group present at the encounter |
| Comments | While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(Patient, Group, Patient, Group) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| Alternate Names | patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 90. Encounter.period | |
| Definition | Start and end time of the encounter. The start and end time of the encounter. |
| Short | Zeitraum des KontaktesThe start and end time of the encounter |
| Comments | If not (yet) known, the end of the Period may be omitted. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Period |
| Is Modifier | false |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end)) |
| 92. Encounter.period.start | |
| Definition | Start des Kontaktzeitraums. DARF NICHT vorhanden sein, kann OPTIONAL oder VERPFLICHTEND sein, abhängig vom Status des Kontaktes - siehe Invarianten auf Ebene Encounter. The start of the period. The boundary is inclusive. |
| Short | BeginndatumStarting time with inclusive boundary |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| Control | 0..1 This element is affected by the following invariants: ele-1, per-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 94. Encounter.period.end | |
| Definition | Ende des Kontaktzeitraums. DARF NICHT vorhanden sein, kann OPTIONAL oder VERPFLICHTEND sein, abhängig vom Status des Kontaktes - siehe Invarianten auf Ebene Encounter. The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
| Short | EnddatumEnd time with inclusive boundary, if not ongoing |
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
| Control | 0..1 This element is affected by the following invariants: ele-1, per-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 96. Encounter.diagnosis | |
| Definition | Information about diagnoses relevant for the encounter The list of diagnosis relevant to this encounter. |
| Short | DiagnosenThe list of diagnosis relevant to this encounter |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 98. Encounter.diagnosis.modifierExtension | |
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 100. Encounter.diagnosis.condition | |
| Definition | VERPFLICHTEND, wenn Diagnosedaten angegeben werden, dann MUSS diese referenziert werden. Es SOLLTE nur die Primärdiagnose referenziert werden. Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. |
| Short | Referenz zu Diagnose-RessourceThe diagnosis or procedure relevant to the encounter |
| Comments | For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis). |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(Condition, Procedure, Condition, Procedure) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| Alternate Names | Admission diagnosis, discharge diagnosis, indication |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 102. Encounter.diagnosis.use | |
| Definition | Attribute wie Aufnahme- oder Entlassdiagnose sind immer im Kontext eines stationären Aufenthaltes zu betrachten
und werden daher als Eigenschaft des Encounters modelliert.
VERPFLICHTEND mindestens die Angabe eines Codings. EMPFOHLEN ist die Angabe mittels Diagnosetyp- und DiagnosesubTyp-Coding.
Weitere Codings OPTIONAL. Extensible Binding auf Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …). |
| Short | DiagnosetypRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …) |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | Unless not suitable, these codes SHALL be taken from The codes SHOULD be taken from MII VS Fall Diagnosis Usehttp://hl7.org/fhir/ValueSet/diagnosis-role|4.0.1 (extensible to https://www.medizininformatik-initiative.de/fhir/core/modul-fall/ValueSet/mii-vs-fall-diagnosis-use)The type of diagnosis this condition represents. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 104. Encounter.diagnosis.use.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 10..* This element is affected by the following invariants: ele-1 |
| Type | Coding |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Encounter.diagnosis.use.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 106. Encounter.diagnosis.use.coding:Diagnosetyp | |
| Slice Name | Diagnosetyp |
| Definition | Einweisungs-/Überweisungsdiagnose | Behandlungsrelevante Diagnosen A reference to a code defined by a terminology system. |
| Short | DiagnosetypCode defined by a terminology system |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from For codes, see DiagnoseTyp ValueSet (required to http://fhir.de/ValueSet/DiagnoseTyp) |
| Type | Coding |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 108. Encounter.diagnosis.use.coding:DiagnosesubTyp | |
| Slice Name | DiagnosesubTyp |
| Definition | Operationsdiagnose | Abteilung Hauptdiagnose | Todesursache | Infektionsschutzdiagnose + A reference to a code defined by a terminology system. |
| Short | DiagnosesubtypCode defined by a terminology system |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from For codes, see Diagnosesubtyp ValueSet (required to http://fhir.de/ValueSet/Diagnosesubtyp) |
| Type | Coding |
| Is Modifier | false |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 110. Encounter.diagnosis.rank | |
| Definition | OPTIONAL, Rangfolge der Diagnose Ranking of the diagnosis (for each role type). |
| Short | RangfolgeRanking of the diagnosis (for each role type) |
| Comments | 32 bit number; for values larger than this, use decimal |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | positiveInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 112. Encounter.hospitalization | |
| Definition | Details about admission and discharge Details about the admission to a healthcare service. |
| Short | KlinikaufenthaltDetails about the admission to a healthcare service |
| Comments | An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included. The duration recorded in the period of this encounter covers the entire scope of this hospitalization record. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 114. Encounter.hospitalization.modifierExtension | |
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 116. Encounter.hospitalization.admitSource | |
| Definition | VERPFLICHTEND, Aufnahmeanlass. Preferred Binding auf http://fhir.de/ValueSet/dgkev/Aufnahmeanlass From where patient was admitted (physician referral, transfer). |
| Short | AufnahmeanlassFrom where patient was admitted (physician referral, transfer) |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHOULD be taken from Aufnahmeanlass ValueSethttp://hl7.org/fhir/ValueSet/encounter-admit-source|4.0.1 (preferred to http://fhir.de/ValueSet/dgkev/Aufnahmeanlass)From where the patient was admitted. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 118. Encounter.hospitalization.dischargeDisposition | |
| Definition | OPTIONAL Daten zur Entlassung Category or kind of location after discharge. |
| Short | EntlassungCategory or kind of location after discharge |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition|4.0.1 (example to http://hl7.org/fhir/ValueSet/encounter-discharge-disposition)Discharge Disposition. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 120. Encounter.hospitalization.dischargeDisposition.extension:Entlassungsgrund | |
| Slice Name | Entlassungsgrund |
| Definition | OPTIONAL, Entlassungs-/Verlegungsgrund nach § 301 Abs. 3 SGB V |
| Short | Entlassungsgrund |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ExtensionEntlassungsgrund) (Complex Extension) |
| Must Support | true |
| Standard Status | Normative (from Trial Use) |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 122. Encounter.location | |
| Definition | Details about location such as room, bed, ward List of locations where the patient has been during this encounter. |
| Short | KontaktortList of locations where the patient has been |
| Comments | Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual". |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | BackboneElement |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on Encounter.location. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 124. Encounter.location.modifierExtension | |
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| 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. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 126. Encounter.location.location | |
| Definition | The location where the encounter takes place. |
| Short | Location the encounter takes place |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(Location, Location) |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 128. Encounter.location:Zimmer | |
| Slice Name | Zimmer |
| Definition | Von Patient oder Patientin während des Kontaktes belegtes Zimmer auf einer Station. List of locations where the patient has been during this encounter. |
| Short | ZimmerList of locations where the patient has been |
| Comments | Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual". |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Type | BackboneElement |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 130. Encounter.location:Zimmer.modifierExtension | |
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| 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. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 132. Encounter.location:Zimmer.location | |
| Definition | The location where the encounter takes place. |
| Short | Location the encounter takes place |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(Location, Location) |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 134. Encounter.location:Zimmer.physicalType | |
| Definition | This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query. |
| Short | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) |
| Comments | This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query. There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type|4.0.1 (example to http://hl7.org/fhir/ValueSet/location-physical-type)Physical form of the location. |
| Type | CodeableConcept |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 136. Encounter.location:Bett | |
| Slice Name | Bett |
| Definition | Von Patient oder Patientin während des Kontaktes belegter Bettenstellplatz. List of locations where the patient has been during this encounter. |
| Short | BettList of locations where the patient has been |
| Comments | Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual". |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Type | BackboneElement |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 138. Encounter.location:Bett.modifierExtension | |
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| 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. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 140. Encounter.location:Bett.location | |
| Definition | The location where the encounter takes place. |
| Short | Location the encounter takes place |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(Location, Location) |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 142. Encounter.location:Bett.physicalType | |
| Definition | This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query. |
| Short | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) |
| Comments | This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query. There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type|4.0.1 (example to http://hl7.org/fhir/ValueSet/location-physical-type)Physical form of the location. |
| Type | CodeableConcept |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 144. Encounter.location:Station | |
| Slice Name | Station |
| Definition | Die Station, auf welcher der Patient oder die Patientin während des Kontaktes behandelt wurde. List of locations where the patient has been during this encounter. |
| Short | StationList of locations where the patient has been |
| Comments | Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual". |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Type | BackboneElement |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 146. Encounter.location:Station.modifierExtension | |
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Standard Status | Normative (from Trial Use) |
| Summary | true |
| 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. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 148. Encounter.location:Station.location | |
| Definition | The location where the encounter takes place. |
| Short | Location the encounter takes place |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(Location, Location) |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 150. Encounter.location:Station.physicalType | |
| Definition | This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query. |
| Short | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) |
| Comments | This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query. There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type|4.0.1 (example to http://hl7.org/fhir/ValueSet/location-physical-type)Physical form of the location. |
| Type | CodeableConcept |
| Is Modifier | false |
| Standard Status | Normative (from Trial Use) |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 152. Encounter.partOf | |
| Definition | Hierarchy between encounter levels by referencing further encounters. Another Encounter of which this encounter is a part of (administratively or in time). |
| Short | Teil von KontaktAnother Encounter this encounter is part of |
| Comments | This is also used for associating a child's encounter back to the mother's encounter. Refer to the Notes section in the Patient resource for further details. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(Encounter, Encounter) |
| Is Modifier | false |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Encounter | |
| 2. Encounter.participant | |
| 4. Encounter.participant.individual | |
| Type | Reference(Practitioner) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Encounter | |||||
| Definition | An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. | ||||
| Short | An interaction during which services are provided to the patient | ||||
| Control | 0..* | ||||
| Alternate Names | Visit | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())mii-enc-1: Falls der Encounter abgeschlossen wurde, MUSS ein Enddatum bekannt sein ( status = 'finished' implies period.end.exists())mii-enc-2: Abgeschlossene, stationäre Kontakte MÜSSEN einen Start- und End-Zeitpunkt angeben ( status = 'finished' and class = 'IMP' implies period.start.exists() and period.end.exists())mii-enc-3: Geplante Kontakte DÜRFEN NICHT einen Start- oder End-Zeitpunkt angeben ( status = 'planned' implies period.exists().not())mii-enc-4: Geplante Kontakte SOLLTEN die Extensions für den geplanten Start- oder End-Zeitpunkt verwenden ( status = 'planned' implies extension.where(url = 'http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate').exists())mii-enc-5: In-Durchführung befindliche Kontakte MÜSSEN einen Start-Zeitpunkt angeben ( status = 'in-progress' implies period.start.exists())mii-enc-6: Kontakte mit Abwesenheitsstatus MÜSSEN einen Start-Zeitpunkt angeben ( status = 'onleave' implies period.start.exists())mii-enc-7: Kontakte mit unbekannten Status SOLLTEN einen Start-Zeitpunkt angeben ( status = 'unknown' implies period.start.exists()) | ||||
| 2. Encounter.id | |||||
| Definition | Angabe OPTIONAL, vom Server automatisch vergebene system-abhängige ID | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Must Support | true | ||||
| Summary | true | ||||
| 4. Encounter.meta | |||||
| Definition | Angabe OPTIONAL zur Provenance und zum Profil | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Meta | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. Encounter.meta.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 8. Encounter.meta.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 10. Encounter.meta.versionId | |||||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
| Short | Version specific identifier | ||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. Encounter.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | When the resource version last changed | ||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | instant | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 14. Encounter.meta.source | |||||
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
| Short | Identifies where the resource comes from | ||||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 16. Encounter.meta.profile | |||||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
| Short | Profiles this resource claims to conform to | ||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | canonical(StructureDefinition) | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 18. Encounter.meta.security | |||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
| Short | Security Labels applied to this resource | ||||
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 20. Encounter.meta.tag | |||||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
| Short | Tags applied to this resource | ||||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. Encounter.implicitRules | |||||
| 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. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Is Modifier | true because 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 24. Encounter.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. Encounter.text | |||||
| 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. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 28. Encounter.contained | |||||
| 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. | ||||
| Short | Contained, inline Resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 30. Encounter.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 32. Encounter.extension:Aufnahmegrund | |||||
| Slice Name | Aufnahmegrund | ||||
| Definition | Admission reason according to key 1, appendix 2, data transmission according to § 301 para. 3 SGB V | ||||
| Short | Aufnahmegrund | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ExtensionAufnahmegrund) (Complex Extension) | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 34. Encounter.extension:Aufnahmegrund.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 36. Encounter.extension:Aufnahmegrund.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 38. Encounter.extension:Aufnahmegrund.extension:ErsteUndZweiteStelle | |||||
| Slice Name | ErsteUndZweiteStelle | ||||
| Definition | Admission reason 1st and 2nd position | ||||
| Short | 1. und 2. Stelle | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 40. Encounter.extension:Aufnahmegrund.extension:ErsteUndZweiteStelle.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 42. Encounter.extension:Aufnahmegrund.extension:ErsteUndZweiteStelle.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 44. Encounter.extension:Aufnahmegrund.extension:ErsteUndZweiteStelle.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Fixed Value | ErsteUndZweiteStelle | ||||
| 46. Encounter.extension:Aufnahmegrund.extension:ErsteUndZweiteStelle.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from Aufnahmegrund Erste und Zweite Stelle ValueSet (required to http://fhir.de/ValueSet/dkgev/AufnahmegrundErsteUndZweiteStelle) | ||||
| Type | Coding | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. Encounter.extension:Aufnahmegrund.extension:DritteStelle | |||||
| Slice Name | DritteStelle | ||||
| Definition | Admission reason 3rd position | ||||
| Short | 3. Stelle | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 50. Encounter.extension:Aufnahmegrund.extension:DritteStelle.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 52. Encounter.extension:Aufnahmegrund.extension:DritteStelle.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 54. Encounter.extension:Aufnahmegrund.extension:DritteStelle.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Fixed Value | DritteStelle | ||||
| 56. Encounter.extension:Aufnahmegrund.extension:DritteStelle.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from AufnahmegrundDritteStelle ValueSet (required to http://fhir.de/ValueSet/dkgev/AufnahmegrundDritteStelle) | ||||
| Type | Coding | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 58. Encounter.extension:Aufnahmegrund.extension:VierteStelle | |||||
| Slice Name | VierteStelle | ||||
| Definition | Admission reason 4th position | ||||
| Short | 4. Stelle | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 60. Encounter.extension:Aufnahmegrund.extension:VierteStelle.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 62. Encounter.extension:Aufnahmegrund.extension:VierteStelle.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 64. Encounter.extension:Aufnahmegrund.extension:VierteStelle.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Fixed Value | VierteStelle | ||||
| 66. Encounter.extension:Aufnahmegrund.extension:VierteStelle.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from Aufnahmegrund Vierte Stelle ValueSet (required to http://fhir.de/ValueSet/dkgev/AufnahmegrundVierteStelle) | ||||
| Type | Coding | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 68. Encounter.extension:Aufnahmegrund.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Fixed Value | http://fhir.de/StructureDefinition/Aufnahmegrund | ||||
| 70. Encounter.extension:Aufnahmegrund.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 72. Encounter.extension:plannedStartDate | |||||
| Slice Name | plannedStartDate | ||||
| Definition | Optional Extension Element - found in all resources. | ||||
| Short | Optional Extensions Element | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(MII EX Fall Planned Start Date) (Extension Type: dateTime) | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 74. Encounter.extension:plannedEndDate | |||||
| Slice Name | plannedEndDate | ||||
| Definition | Optional Extension Element - found in all resources. | ||||
| Short | Optional Extensions Element | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(MII EX Fall Planned End Date) (Extension Type: dateTime) | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 76. Encounter.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Standard Status | Normative (from Trial Use) | ||||
| 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. | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 78. Encounter.identifier | |||||
| Definition | Identifier/s by which this encounter is known. | ||||
| Short | Identifikator | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Identifier | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Encounter.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 80. Encounter.identifier:Aufnahmenummer | |||||
| Slice Name | Aufnahmenummer | ||||
| Definition | Admission number, the patient receives during an admission. | ||||
| Short | Aufnahmenummer | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Identifier | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 82. Encounter.identifier:Aufnahmenummer.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 84. Encounter.identifier:Aufnahmenummer.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 86. Encounter.identifier:Aufnahmenummer.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 88. Encounter.identifier:Aufnahmenummer.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from MII VS Fall Identifier Type Codes (extensible to https://www.medizininformatik-initiative.de/fhir/core/modul-fall/ValueSet/identifier-type-codes)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 90. Encounter.identifier:Aufnahmenummer.type.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 92. Encounter.identifier:Aufnahmenummer.type.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 94. Encounter.identifier:Aufnahmenummer.type.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 1..* This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Encounter.identifier.type.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 96. Encounter.identifier:Aufnahmenummer.type.coding:vn-type | |||||
| Slice Name | vn-type | ||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 98. Encounter.identifier:Aufnahmenummer.type.coding:vn-type.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 100. Encounter.identifier:Aufnahmenummer.type.coding:vn-type.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 102. Encounter.identifier:Aufnahmenummer.type.coding:vn-type.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 104. Encounter.identifier:Aufnahmenummer.type.coding:vn-type.version | |||||
| 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. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 106. Encounter.identifier:Aufnahmenummer.type.coding:vn-type.code | |||||
| 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). | ||||
| Short | Symbol in syntax defined by the system | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 108. Encounter.identifier:Aufnahmenummer.type.coding:vn-type.display | |||||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
| Short | Representation defined by the system | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 110. Encounter.identifier:Aufnahmenummer.type.coding:vn-type.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 112. Encounter.identifier:Aufnahmenummer.type.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 114. Encounter.identifier:Aufnahmenummer.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Example | General: http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 116. Encounter.identifier:Aufnahmenummer.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | The value that is unique | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Example | General: 123456 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 118. Encounter.identifier:Aufnahmenummer.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Period | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end)) | ||||
| 120. Encounter.identifier:Aufnahmenummer.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Organization) | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 122. Encounter.status | |||||
| Definition | planned | in-progress | onleave | finished | cancelled | entered-in-error | unknown | ||||
| Short | Status | ||||
| Comments | Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from Encounter Status ValueSet (required to http://fhir.de/ValueSet/EncounterStatusDe)Current state of the encounter. | ||||
| Type | code | ||||
| Is Modifier | true because This element is labeled 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 124. Encounter.statusHistory | |||||
| Definition | The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them. | ||||
| Short | List of past encounter statuses | ||||
| Comments | The current status is always found in the current version of the resource, not the status history. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 126. Encounter.statusHistory.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 128. Encounter.statusHistory.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.statusHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 130. Encounter.statusHistory.modifierExtension | |||||
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 132. Encounter.statusHistory.status | |||||
| Definition | planned | arrived | triaged | in-progress | onleave | finished | cancelled +. | ||||
| Short | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from EncounterStatus (required to http://hl7.org/fhir/ValueSet/encounter-status|4.0.1)Current state of the encounter. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 134. Encounter.statusHistory.period | |||||
| Definition | The time that the episode was in the specified status. | ||||
| Short | The time that the episode was in the specified status | ||||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Period | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end)) | ||||
| 136. Encounter.class | |||||
| Definition | ambulatory | inpatient encounter | pre-admission | virtual | short stay | home health | ||||
| Short | Kontaktklasse | ||||
| Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from EncounterClassDE (required to http://fhir.de/ValueSet/EncounterClassDE)Classification of the encounter. | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 138. Encounter.classHistory | |||||
| Definition | The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient. | ||||
| Short | List of past encounter classes | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 140. Encounter.classHistory.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 142. Encounter.classHistory.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.classHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 144. Encounter.classHistory.modifierExtension | |||||
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 146. Encounter.classHistory.class | |||||
| Definition | inpatient | outpatient | ambulatory | emergency +. | ||||
| Short | inpatient | outpatient | ambulatory | emergency + | ||||
| Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ActEncounterCode (extensible to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode)Classification of the encounter. | ||||
| Type | Coding | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 148. Encounter.classHistory.period | |||||
| Definition | The time that the episode was in the specified class. | ||||
| Short | The time that the episode was in the specified class | ||||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Period | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end)) | ||||
| 150. Encounter.type | |||||
| Definition | Specific type of encounter | ||||
| Short | Kontakttyp | ||||
| Comments | Since there are many ways to further classify encounters, this element is 0..*. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see EncounterType (example to http://hl7.org/fhir/ValueSet/encounter-type)The type of encounter. | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Encounter.type. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 152. Encounter.type:Kontaktebene | |||||
| Slice Name | Kontaktebene | ||||
| Definition | Differentiation of the encounter hierarchy levels: facility contact | department contact | care provider contact | ||||
| Short | Kontaktebene | ||||
| Comments | Since there are many ways to further classify encounters, this element is 0..*. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from KontaktebeneDe ValueSet (required to http://fhir.de/ValueSet/kontaktebene-de)Kontaktebene | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 154. Encounter.type:KontaktArt | |||||
| Slice Name | KontaktArt | ||||
| Definition | Type of encounter such as pre-admission | post-admission | intensive care | ||||
| Short | Kontaktart | ||||
| Comments | Since there are many ways to further classify encounters, this element is 0..*. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from KontaktartDe ValueSet (required to http://fhir.de/ValueSet/kontaktart-de)The type of encounter. | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 156. Encounter.serviceType | |||||
| Definition | Department classification by department key | ||||
| Short | Fachabteilung | ||||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see ServiceType (example to http://hl7.org/fhir/ValueSet/service-type)Broad categorization of the service that is to be provided. | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 158. Encounter.serviceType.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 160. Encounter.serviceType.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.serviceType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 162. Encounter.serviceType.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Encounter.serviceType.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 164. Encounter.serviceType.coding:Fachabteilungsschluessel | |||||
| Slice Name | Fachabteilungsschluessel | ||||
| Definition | Departments according to appendix 1 of the Bundespflegesatzverordnung | ||||
| Short | Fachabteilungsschlüssel | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from Fachabteilungsschlüssel ValueSet (required to http://fhir.de/ValueSet/dkgev/Fachabteilungsschluessel) | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 166. Encounter.serviceType.coding:Fachabteilungsschluessel.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 168. Encounter.serviceType.coding:Fachabteilungsschluessel.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.serviceType.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 170. Encounter.serviceType.coding:Fachabteilungsschluessel.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 172. Encounter.serviceType.coding:Fachabteilungsschluessel.version | |||||
| 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. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 174. Encounter.serviceType.coding:Fachabteilungsschluessel.code | |||||
| 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). | ||||
| Short | Symbol in syntax defined by the system | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 176. Encounter.serviceType.coding:Fachabteilungsschluessel.display | |||||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
| Short | Representation defined by the system | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 178. Encounter.serviceType.coding:Fachabteilungsschluessel.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 180. Encounter.serviceType.coding:ErweiterterFachabteilungsschluessel | |||||
| Slice Name | ErweiterterFachabteilungsschluessel | ||||
| Definition | Departments according to appendix 1 of the Bundespflegesatzverordnung | ||||
| Short | Erweiterter Fachabteilungsschlüssel | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from FachabteilungsschluesselErweitert ValueSet (required to http://fhir.de/ValueSet/dkgev/Fachabteilungsschluessel-erweitert) | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 182. Encounter.serviceType.coding:ErweiterterFachabteilungsschluessel.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 184. Encounter.serviceType.coding:ErweiterterFachabteilungsschluessel.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.serviceType.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 186. Encounter.serviceType.coding:ErweiterterFachabteilungsschluessel.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 188. Encounter.serviceType.coding:ErweiterterFachabteilungsschluessel.version | |||||
| 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. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 190. Encounter.serviceType.coding:ErweiterterFachabteilungsschluessel.code | |||||
| 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). | ||||
| Short | Symbol in syntax defined by the system | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 192. Encounter.serviceType.coding:ErweiterterFachabteilungsschluessel.display | |||||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
| Short | Representation defined by the system | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 194. Encounter.serviceType.coding:ErweiterterFachabteilungsschluessel.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 196. Encounter.serviceType.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 198. Encounter.priority | |||||
| Definition | Indicates the urgency of the encounter. | ||||
| Short | Indicates the urgency of the encounter | ||||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)Indicates the urgency of the encounter. | ||||
| Type | CodeableConcept | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 200. Encounter.subject | |||||
| Definition | VERPFLICHTEND, Referenz auf Patient:in. | ||||
| Short | Patientenidentifikator | ||||
| Comments | While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Patient, Group) | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| Alternate Names | patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 202. Encounter.episodeOfCare | |||||
| Definition | Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years). | ||||
| Short | Episode(s) of care that this encounter should be recorded against | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(EpisodeOfCare) | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 204. Encounter.basedOn | |||||
| Definition | The request this encounter satisfies (e.g. incoming referral or procedure request). | ||||
| Short | The ServiceRequest that initiated this encounter | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(ServiceRequest) | ||||
| Alternate Names | incomingReferral | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 206. Encounter.participant | |||||
| Definition | The list of people responsible for providing the service. | ||||
| Short | List of participants involved in the encounter | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 208. Encounter.participant.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 210. Encounter.participant.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.participant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 212. Encounter.participant.modifierExtension | |||||
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 214. Encounter.participant.type | |||||
| Definition | Role of participant in encounter. | ||||
| Short | Role of participant in encounter | ||||
| Comments | The participant type indicates how an individual participates in an encounter. It includes non-practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the practitioner roles which are functional roles, derived from terms of employment, education, licensing, etc. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ParticipantType (extensible to http://hl7.org/fhir/ValueSet/encounter-participant-type)Role of participant in encounter. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 216. Encounter.participant.period | |||||
| Definition | The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter's period. | ||||
| Short | Period of time during the encounter that the participant participated | ||||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Period | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end)) | ||||
| 218. Encounter.participant.individual | |||||
| Definition | Persons involved in the encounter other than the patient. | ||||
| Short | Persons involved in the encounter other than the patient | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Practitioner) | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 220. Encounter.appointment | |||||
| Definition | The appointment that scheduled this encounter. | ||||
| Short | The appointment that scheduled this encounter | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Appointment) | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 222. Encounter.period | |||||
| Definition | Start and end time of the encounter. | ||||
| Short | Zeitraum des Kontaktes | ||||
| Comments | If not (yet) known, the end of the Period may be omitted. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Period | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end)) | ||||
| 224. Encounter.period.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 226. Encounter.period.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 228. Encounter.period.start | |||||
| Definition | Start des Kontaktzeitraums. DARF NICHT vorhanden sein, kann OPTIONAL oder VERPFLICHTEND sein, abhängig vom Status des Kontaktes - siehe Invarianten auf Ebene Encounter. | ||||
| Short | Beginndatum | ||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1, per-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 230. Encounter.period.end | |||||
| Definition | Ende des Kontaktzeitraums. DARF NICHT vorhanden sein, kann OPTIONAL oder VERPFLICHTEND sein, abhängig vom Status des Kontaktes - siehe Invarianten auf Ebene Encounter. | ||||
| Short | Enddatum | ||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1, per-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 232. Encounter.length | |||||
| Definition | Quantity of time the encounter lasted. This excludes the time during leaves of absence. | ||||
| Short | Quantity of time the encounter lasted (less time absent) | ||||
| Comments | May differ from the time the Encounter.period lasted because of leave of absence. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Duration | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. ( code.exists() implies ((system = %ucum) and value.exists())) | ||||
| 234. Encounter.reasonCode | |||||
| Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. | ||||
| Short | Coded reason the encounter takes place | ||||
| Comments | For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis). | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHOULD be taken from EncounterReasonCodes (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)Reason why the encounter takes place. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Alternate Names | Indication, Admission diagnosis | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 236. Encounter.reasonReference | |||||
| Definition | Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. | ||||
| Short | Reason the encounter takes place (reference) | ||||
| Comments | For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis). | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Condition, Procedure, Observation, ImmunizationRecommendation) | ||||
| Summary | true | ||||
| Alternate Names | Indication, Admission diagnosis | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 238. Encounter.diagnosis | |||||
| Definition | Information about diagnoses relevant for the encounter | ||||
| Short | Diagnosen | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | BackboneElement | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 240. Encounter.diagnosis.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 242. Encounter.diagnosis.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.diagnosis.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 244. Encounter.diagnosis.modifierExtension | |||||
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 246. Encounter.diagnosis.condition | |||||
| Definition | VERPFLICHTEND, wenn Diagnosedaten angegeben werden, dann MUSS diese referenziert werden. Es SOLLTE nur die Primärdiagnose referenziert werden. | ||||
| Short | Referenz zu Diagnose-Ressource | ||||
| Comments | For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Condition, Procedure) | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| Alternate Names | Admission diagnosis, discharge diagnosis, indication | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 248. Encounter.diagnosis.use | |||||
| Definition | Attribute wie Aufnahme- oder Entlassdiagnose sind immer im Kontext eines stationären Aufenthaltes zu betrachten
und werden daher als Eigenschaft des Encounters modelliert.
VERPFLICHTEND mindestens die Angabe eines Codings. EMPFOHLEN ist die Angabe mittels Diagnosetyp- und DiagnosesubTyp-Coding.
Weitere Codings OPTIONAL. Extensible Binding auf | ||||
| Short | Diagnosetyp | ||||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from MII VS Fall Diagnosis Use (extensible to https://www.medizininformatik-initiative.de/fhir/core/modul-fall/ValueSet/mii-vs-fall-diagnosis-use)The type of diagnosis this condition represents. | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 250. Encounter.diagnosis.use.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 252. Encounter.diagnosis.use.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.diagnosis.use.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 254. Encounter.diagnosis.use.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 1..* This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Encounter.diagnosis.use.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 256. Encounter.diagnosis.use.coding:Diagnosetyp | |||||
| Slice Name | Diagnosetyp | ||||
| Definition | Einweisungs-/Überweisungsdiagnose | Behandlungsrelevante Diagnosen | ||||
| Short | Diagnosetyp | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from DiagnoseTyp ValueSet (required to http://fhir.de/ValueSet/DiagnoseTyp) | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 258. Encounter.diagnosis.use.coding:DiagnosesubTyp | |||||
| Slice Name | DiagnosesubTyp | ||||
| Definition | Operationsdiagnose | Abteilung Hauptdiagnose | Todesursache | Infektionsschutzdiagnose + | ||||
| Short | Diagnosesubtyp | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from Diagnosesubtyp ValueSet (required to http://fhir.de/ValueSet/Diagnosesubtyp) | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 260. Encounter.diagnosis.use.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 262. Encounter.diagnosis.rank | |||||
| Definition | OPTIONAL, Rangfolge der Diagnose | ||||
| Short | Rangfolge | ||||
| Comments | 32 bit number; for values larger than this, use decimal | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | positiveInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 264. Encounter.account | |||||
| Definition | The set of accounts that may be used for billing for this Encounter. | ||||
| Short | The set of accounts that may be used for billing for this Encounter | ||||
| Comments | The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Account) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 266. Encounter.hospitalization | |||||
| Definition | Details about admission and discharge | ||||
| Short | Klinikaufenthalt | ||||
| Comments | An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included. The duration recorded in the period of this encounter covers the entire scope of this hospitalization record. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | BackboneElement | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 268. Encounter.hospitalization.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 270. Encounter.hospitalization.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.hospitalization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 272. Encounter.hospitalization.modifierExtension | |||||
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 274. Encounter.hospitalization.preAdmissionIdentifier | |||||
| Definition | Pre-admission identifier. | ||||
| Short | Pre-admission identifier | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Identifier | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 276. Encounter.hospitalization.origin | |||||
| Definition | The location/organization from which the patient came before admission. | ||||
| Short | The location/organization from which the patient came before admission | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Location, Organization) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 278. Encounter.hospitalization.admitSource | |||||
| Definition | VERPFLICHTEND, Aufnahmeanlass. Preferred Binding auf http://fhir.de/ValueSet/dgkev/Aufnahmeanlass | ||||
| Short | Aufnahmeanlass | ||||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHOULD be taken from Aufnahmeanlass ValueSet (preferred to http://fhir.de/ValueSet/dgkev/Aufnahmeanlass)From where the patient was admitted. | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 280. Encounter.hospitalization.reAdmission | |||||
| Definition | Whether this hospitalization is a readmission and why if known. | ||||
| Short | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission | ||||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see hl7VS-re-admissionIndicator (example to http://terminology.hl7.org/ValueSet/v2-0092)The reason for re-admission of this hospitalization encounter. | ||||
| Type | CodeableConcept | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 282. Encounter.hospitalization.dietPreference | |||||
| Definition | Diet preferences reported by the patient. | ||||
| Short | Diet preferences reported by the patient | ||||
| Comments | For example, a patient may request both a dairy-free and nut-free diet preference (not mutually exclusive). | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see Diet (example to http://hl7.org/fhir/ValueSet/encounter-diet)Medical, cultural or ethical food preferences to help with catering requirements. | ||||
| Type | CodeableConcept | ||||
| Requirements | Used to track patient's diet restrictions and/or preference. For a complete description of the nutrition needs of a patient during their stay, one should use the nutritionOrder resource which links to Encounter. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 284. Encounter.hospitalization.specialCourtesy | |||||
| Definition | Special courtesies (VIP, board member). | ||||
| Short | Special courtesies (VIP, board member) | ||||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHOULD be taken from SpecialCourtesy (preferred to http://hl7.org/fhir/ValueSet/encounter-special-courtesy)Special courtesies. | ||||
| Type | CodeableConcept | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 286. Encounter.hospitalization.specialArrangement | |||||
| Definition | Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things. | ||||
| Short | Wheelchair, translator, stretcher, etc. | ||||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHOULD be taken from SpecialArrangements (preferred to http://hl7.org/fhir/ValueSet/encounter-special-arrangements)Special arrangements. | ||||
| Type | CodeableConcept | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 288. Encounter.hospitalization.destination | |||||
| Definition | Location/organization to which the patient is discharged. | ||||
| Short | Location/organization to which the patient is discharged | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Location, Organization) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 290. Encounter.hospitalization.dischargeDisposition | |||||
| Definition | OPTIONAL Daten zur Entlassung | ||||
| Short | Entlassung | ||||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see DischargeDisposition (example to http://hl7.org/fhir/ValueSet/encounter-discharge-disposition)Discharge Disposition. | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 292. Encounter.hospitalization.dischargeDisposition.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 294. Encounter.hospitalization.dischargeDisposition.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.hospitalization.dischargeDisposition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 296. Encounter.hospitalization.dischargeDisposition.extension:Entlassungsgrund | |||||
| Slice Name | Entlassungsgrund | ||||
| Definition | OPTIONAL, Entlassungs-/Verlegungsgrund nach § 301 Abs. 3 SGB V | ||||
| Short | Entlassungsgrund | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ExtensionEntlassungsgrund) (Complex Extension) | ||||
| Must Support | true | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 298. Encounter.hospitalization.dischargeDisposition.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 300. Encounter.hospitalization.dischargeDisposition.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 302. Encounter.location | |||||
| Definition | Details about location such as room, bed, ward | ||||
| Short | Kontaktort | ||||
| Comments | Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual". | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | BackboneElement | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Encounter.location. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 304. Encounter.location.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 306. Encounter.location.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 308. Encounter.location.modifierExtension | |||||
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 310. Encounter.location.location | |||||
| Definition | The location where the encounter takes place. | ||||
| Short | Location the encounter takes place | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Location) | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 312. Encounter.location.status | |||||
| Definition | The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time. | ||||
| Short | planned | active | reserved | completed | ||||
| Comments | When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from EncounterLocationStatus (required to http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1)The status of the location. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 314. Encounter.location.physicalType | |||||
| Definition | SOLL, extensible Binding auf https://www.medizininformatik-initiative.de/fhir/core/modul-fall/ValueSet/location-physical-type | ||||
| Short | Kontaktorttyp | ||||
| Comments | This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query. There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from MII VS Fall Location Physical Type (extensible to https://www.medizininformatik-initiative.de/fhir/core/modul-fall/ValueSet/location-physical-type)Physical form of the location. | ||||
| Type | CodeableConcept | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 316. Encounter.location.period | |||||
| Definition | Time period during which the patient was present at the location. | ||||
| Short | Time period during which the patient was present at the location | ||||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Period | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end)) | ||||
| 318. Encounter.location:Zimmer | |||||
| Slice Name | Zimmer | ||||
| Definition | Von Patient oder Patientin während des Kontaktes belegtes Zimmer auf einer Station. | ||||
| Short | Zimmer | ||||
| Comments | Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual". | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | BackboneElement | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 320. Encounter.location:Zimmer.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 322. Encounter.location:Zimmer.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 324. Encounter.location:Zimmer.modifierExtension | |||||
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 326. Encounter.location:Zimmer.location | |||||
| Definition | The location where the encounter takes place. | ||||
| Short | Location the encounter takes place | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Location) | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 328. Encounter.location:Zimmer.status | |||||
| Definition | The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time. | ||||
| Short | planned | active | reserved | completed | ||||
| Comments | When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from EncounterLocationStatus (required to http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1)The status of the location. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 330. Encounter.location:Zimmer.physicalType | |||||
| Definition | This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query. | ||||
| Short | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) | ||||
| Comments | This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query. There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see LocationType (example to http://hl7.org/fhir/ValueSet/location-physical-type)Physical form of the location. | ||||
| Type | CodeableConcept | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 332. Encounter.location:Zimmer.period | |||||
| Definition | Time period during which the patient was present at the location. | ||||
| Short | Time period during which the patient was present at the location | ||||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Period | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end)) | ||||
| 334. Encounter.location:Bett | |||||
| Slice Name | Bett | ||||
| Definition | Von Patient oder Patientin während des Kontaktes belegter Bettenstellplatz. | ||||
| Short | Bett | ||||
| Comments | Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual". | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | BackboneElement | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 336. Encounter.location:Bett.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 338. Encounter.location:Bett.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 340. Encounter.location:Bett.modifierExtension | |||||
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 342. Encounter.location:Bett.location | |||||
| Definition | The location where the encounter takes place. | ||||
| Short | Location the encounter takes place | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Location) | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 344. Encounter.location:Bett.status | |||||
| Definition | The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time. | ||||
| Short | planned | active | reserved | completed | ||||
| Comments | When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from EncounterLocationStatus (required to http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1)The status of the location. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 346. Encounter.location:Bett.physicalType | |||||
| Definition | This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query. | ||||
| Short | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) | ||||
| Comments | This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query. There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see LocationType (example to http://hl7.org/fhir/ValueSet/location-physical-type)Physical form of the location. | ||||
| Type | CodeableConcept | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 348. Encounter.location:Bett.period | |||||
| Definition | Time period during which the patient was present at the location. | ||||
| Short | Time period during which the patient was present at the location | ||||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Period | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end)) | ||||
| 350. Encounter.location:Station | |||||
| Slice Name | Station | ||||
| Definition | Die Station, auf welcher der Patient oder die Patientin während des Kontaktes behandelt wurde. | ||||
| Short | Station | ||||
| Comments | Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual". | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | BackboneElement | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 352. Encounter.location:Station.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 354. Encounter.location:Station.extension | |||||
| 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Encounter.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 356. Encounter.location:Station.modifierExtension | |||||
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 358. Encounter.location:Station.location | |||||
| Definition | The location where the encounter takes place. | ||||
| Short | Location the encounter takes place | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Location) | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 360. Encounter.location:Station.status | |||||
| Definition | The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time. | ||||
| Short | planned | active | reserved | completed | ||||
| Comments | When the patient is no longer active at a location, then the period end date is entered, and the status may be changed to completed. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from EncounterLocationStatus (required to http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1)The status of the location. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 362. Encounter.location:Station.physicalType | |||||
| Definition | This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query. | ||||
| Short | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) | ||||
| Comments | This information is de-normalized from the Location resource to support the easier understanding of the encounter resource and processing in messaging or query. There may be many levels in the hierachy, and this may only pic specific levels that are required for a specific usage scenario. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see LocationType (example to http://hl7.org/fhir/ValueSet/location-physical-type)Physical form of the location. | ||||
| Type | CodeableConcept | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 364. Encounter.location:Station.period | |||||
| Definition | Time period during which the patient was present at the location. | ||||
| Short | Time period during which the patient was present at the location | ||||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Period | ||||
| Standard Status | Normative (from Trial Use) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end)) | ||||
| 366. Encounter.serviceProvider | |||||
| Definition | Service provider responsible for the encounter. | ||||
| Short | Leistungserbringer | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Organization) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 368. Encounter.partOf | |||||
| Definition | Hierarchy between encounter levels by referencing further encounters. | ||||
| Short | Teil von Kontakt | ||||
| Comments | This is also used for associating a child's encounter back to the mother's encounter. Refer to the Notes section in the Patient resource for further details. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Encounter) | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||