| Active as of 2026-06-10 |
Definitions for the ISiKPatient resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Patient | |
| Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
| Short | Information about an individual or animal receiving health care services |
| Control | 0..* |
| Is Modifier | false |
| Summary | false |
| Alternate Names | SubjectOfCare Client Resident |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) isik-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden ( gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()) |
| 2. Patient.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | serverseitige, interne ID des DatensatzesLogical id of this artifact |
| Comments | bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine 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. Patient.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 | Verweis auf die Regeln, nach denen die Ressource erstellt wurdeA set of rules under which this content was created |
| Comments | Begründung Constraint: In ISiK existiert kein Use-Case für dieses Element. Da es sich um ein Modifying Element handelt, wird es daher ausgeschlossen. Darüber hinaus werden die Regeln als URI vorgehalten. Dies führt dazu, dass sich hinter der URI eine beliebige Menge an Regeln befinden kann; wodurch nicht sichergestellt werden kann, dass alle Clients die Regeln korrekt interpretieren können. 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..01 |
| 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())) |
| 6. Patient.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..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Summary | false |
| 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()) |
| 8. Patient.identifier | |
| Definition | An identifier for this patient. |
| Short | An identifier for this patient |
| Comments | Eindeutiger Identifier des Patienten |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 10..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Patients are almost always assigned specific numerical identifiers. |
| 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 Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. Patient.identifier:VersichertenId | |
| Slice Name | VersichertenId |
| Definition | An identifier for this patient. |
| Short | Lebenslange KrankenversichertennummerAn identifier for this patient |
| Comments | Die als 'KVZ10' kodierte Versichertennummer ist der 10-stellige,
unveränderbare Teil der Versichertennummer,
der lesbar auf die Elektronische Gesundheitskarte aufgedruckt ist.
Er gilt für alle Krankenversichertennummern,
unabhängig davon, ob es sich um GKV, PKV oder Sonderkostenträger handelt. Für eine Weiterverarbeitung einer Patient-Ressource in der ePA ist dieser Identifier im EPAPatient-Profil ein Pflichtfeld. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* |
| Type | Identifier(Identifier-Profil für die 10-stellige Krankenversichertennummer) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Patients are almost always assigned specific numerical identifiers. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Patient.identifier:VersichertenId.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())) |
| 14. Patient.identifier:VersichertenId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Art des IdentifiersDescription of identifier |
| Comments | Hier ist stets der Code 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 | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Identifier Type Kvid DeBasis ValueSethttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1 (required to http://fhir.de/ValueSet/identifier-type-kvid-de-basis)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 |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) kvid-2: Die type Codes 'GKV' und 'PKV' haben den Status 'retired', daher sollen diese nicht mehr verwendet werden ( ($this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='GKV') or $this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='PKV')).not()) |
| 16. Patient.identifier:VersichertenId.system | |
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
| Short | Namensraum der VersichertennummerThe namespace for the identifier value |
| Comments | Hier ist stets der Wert 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. |
| Fixed Value | http://fhir.de/sid/gkv/kvid-10 |
| 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())) |
| 18. Patient.identifier:VersichertenId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Lebenslange KrankenversichertennummerThe value that is unique |
| Comments | Enthält den eigentlichen Wert des Identifiers. 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())) kvid-1: Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen ( matches('^[A-Z][0-9]{9}$')) |
| 20. Patient.identifier:Patientennummer | |
| Slice Name | Patientennummer |
| Definition | An identifier for this patient. |
| Short | Organisationsinterner Patienten-Identifier (PID)An identifier for this patient |
| Comments | Organisationsintere Patienten-Identifier werden von z.B. von KIS-Systemen vergeben
und dienen innerhalb einer Einreichtung meist als primäres Identifikationsmerkmal für Patienten,
u.A. in der HL7 V2-Kommunikation. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 10..* |
| Type | Identifier(Identifier-Profil für die Abbildung einer Patienten-ID) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Patients are almost always assigned specific numerical identifiers. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. Patient.identifier:Patientennummer.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())) |
| 24. Patient.identifier:Patientennummer.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Art des IdentifiersDescription of identifier |
| Comments | Hier ist stets der Code 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 Identifier Type DeBasis ValueSethttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1 (extensible to http://fhir.de/ValueSet/identifier-type-de-basis)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 |
| 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())) |
| 26. Patient.identifier:Patientennummer.system | |
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
| Short | Namensraum des IdentifiersThe namespace for the identifier value |
| Comments | Hier ist stets der eindeutige Name (URL) des Namensraums anzugeben,
aus dem der Identifier stammt.
Hinweise zur Festlegung der URLs für lokale Namensräume sind in den
Deutschen Basisprofilen beschrieben. 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())) |
| 28. Patient.identifier:Patientennummer.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 | Enthält den eigentlichen Wert des Identifiers. 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())) |
| 30. Patient.identifier:Versichertennummer_PKV | |
| Slice Name | Versichertennummer_PKV |
| Definition | An identifier for this patient. |
| Short | Private KrankenversichertennummerAn identifier for this patient |
| Comments | Für Privatpatienten, die noch nicht über eine lebenslange, unveränderliche Krankenversichertennummer (KVNR) verfügen,
können bis auf weiteres noch die versicherungsspezifischen PKV-Nummern angegeben werden.
Da bei diesen der Bezeichner des vom Kostenträger verwendeten Namensraums meist nicht ermittelt werden kann,
ist statt dessen der Name des Kostenträgers in |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* |
| Type | Identifier(Identifier-Profil für die Abbildung einer Privatversichertennummer) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Patients are almost always assigned specific numerical identifiers. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. Patient.identifier:Versichertennummer_PKV.use | |
| Definition | The purpose of this identifier. |
| Short | Verwendungszeck des Identifiersusual | official | temp | secondary | old (If known) |
| Comments | Hier ist stets der Wert 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 |
| Must Support | true |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | secondary |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. Patient.identifier:Versichertennummer_PKV.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Art des IdentifiersDescription of identifier |
| Comments | Hier ist stets der Code 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 Identifier Type DeBasis ValueSethttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1 (extensible to http://fhir.de/ValueSet/identifier-type-de-basis)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 |
| 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())) |
| 36. Patient.identifier:Versichertennummer_PKV.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Private KrankenversichertennummerThe value that is unique |
| Comments | Enthält den eigentlichen Wert des Identifiers. 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())) |
| 38. Patient.identifier:Versichertennummer_PKV.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 | 10..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(Organization, Organization) |
| 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())) 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'))) |
| 40. Patient.identifier:Versichertennummer_PKV.assigner.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 0..1 This element is affected by the following invariants: ele-1, ref-1 |
| Type | string |
| Is Modifier | false |
| 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())) |
| 42. Patient.identifier:Versichertennummer_PKV.assigner.identifier | |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | An identifier intended for computationLogical reference, when literal reference is not known |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
| 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(Identifier-Profil für die Abbildung eines Institutionskennzeichens (IKNR)) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. Patient.identifier:Versichertennummer_PKV.assigner.identifier.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())) |
| 46. Patient.identifier:Versichertennummer_PKV.assigner.identifier.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 | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSethttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1 (extensible to http://fhir.de/ValueSet/identifier-type-de-basis)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 |
| 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())) |
| 48. Patient.identifier:Versichertennummer_PKV.assigner.identifier.system | |
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
| Short | Namensraum des IdentifiersThe namespace for the identifier value |
| Comments | Hier ist stets der Wert 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. |
| Fixed Value | http://fhir.de/sid/arge-ik/iknr |
| 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())) |
| 50. Patient.identifier:Versichertennummer_PKV.assigner.identifier.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | IK-Nummer des KostenträgersThe value that is unique |
| Comments | IK-Nummer des Kostenträgers, aus dessen Nummernkreis die PKV-Nummer stammt. 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())) ik-1: Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein ( matches('^[0-9]{9}$')) |
| 52. Patient.identifier:Versichertennummer_PKV.assigner.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Name des KostenträgersText alternative for the resource |
| Comments | Name des Kostenträgers, aus dessen Nummernkreis die PKV-Nummer stammt. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. Patient.active | |
| Definition | Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. |
| Short | Status des DatensatzesWhether this patient's record is in active use |
| Comments |
If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record 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 |
| Requirements | Need to be able to mark a patient record as not to be used because it was created in error. |
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 56. Patient.name | |
| Definition | A name associated with the individual. |
| Short | A name associated with the patient |
| Comments | Angabe der Namen A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. |
| Control | 10..* |
| Type | HumanName |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
| 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 Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 58. Patient.name:Name | |
| Slice Name | Name |
| Definition | A name associated with the individual. |
| Short | Offizieller NameA name associated with the patient |
| Comments | Offizieller Name des Patienten, wie er z.B. in Ausweis oder Versicherungsdokumenten erscheint.
Begründung Pflichtfeld: Der offizielle Name des Patienten ist unerlässlich, um Verwechlungen zu vermeiden und den Patienten im Versorgungskontext korrekt anzusprechen.
Wenn kein Name vorliegt, MUSS die data-absent-reason-Extension eingesetzt werden. A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. |
| Control | 10..1* |
| Type | HumanName(HumanName, deutsches Basisprofil) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 60. Patient.name:Name.use | |
| Definition | Identifies the purpose for this name. |
| Short | Verwendungszweckusual | official | temp | nickname | anonymous | old | maiden |
| Comments | Hier ist stets der Wert Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)The use of a human name. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. Patient.name:Name.family | |
| Definition | Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt. The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. |
| Short | NachnameFamily name (often called 'Surname') |
| Comments | Vollständiger Nachname bzw. Familienname der Person, einschließlich Vor- und Zusätze. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
| 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 |
| Alternate Names | surname |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 64. Patient.name:Name.family.extension:namenszusatz | |
| Slice Name | namenszusatz |
| Definition | Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst |
| Short | Namenszusatz |
| Comments | Enthält ehem. Adelstitel wie z.B. 'Graf', 'Baronesse', 'Freiherr'... |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Extension zur Erfassung der VSDM Namensbestandteile) (Extension Type: string) |
| Must Support | true |
| 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()) |
| 66. Patient.name:Name.family.extension:nachname | |
| Slice Name | nachname |
| Definition | The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. |
| Short | Nachname |
| Comments | Nachname ohne Vor- und Zusätze. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Own Name) (Extension Type: string) |
| Must Support | true |
| 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()) |
| 68. Patient.name:Name.family.extension:vorsatzwort | |
| Slice Name | vorsatzwort |
| Definition | The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. |
| Short | Voorvoegsel derived from person's own surname |
| Comments | Enthält Vorsätze, die vor dem Nachnamen stehen, z.B. 'von', 'van', 'zu'... |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Own Prefix) (Extension Type: string) |
| Must Support | true |
| 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()) |
| 70. Patient.name:Name.given | |
| Definition | Vorname der Person Given name. |
| Short | VornameGiven names (not always 'first'). Includes middle names |
| Comments | Kann mehrfach verwendet werden, um den Rufnamen sowie weitere Vornamen, Mittelnamen oder Mittel-Initialen abzubilden. Begründung Pflichtfeld: Ein offizieller Name ist nur zulässig, wenn der Nachname und mindestens ein Vorname angegeben sind. If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. |
| Control | 10..* 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 |
| Alternate Names | first name, middle name |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. Patient.name:Name.prefix | |
| Definition | Namensteile vor dem Vornamen, z.B. akademischer Titel. Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. |
| Short | PräfixParts that come before the name |
| Comments | Präfix, z.B. akademischer Titel od. militärischer Rang |
| Control | 0..* 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. Patient.name:Name.prefix.extension:prefix-qualifier | |
| Slice Name | prefix-qualifier |
| Definition | A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. |
| Short | Extension, um das Präfix als akademischen Titel zu qualifizieren |
| Comments | Hier ist stets der Wert |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(EN Qualifier) (Extension Type: code) |
| Is Modifier | false |
| Must Support | true |
| 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()) |
| 76. Patient.name:Name.prefix.extension:prefix-qualifier.extension | |
| Definition | An Extension 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 | ExtensionAdditional 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* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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 Patient.name.prefix.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 78. Patient.name:Name.prefix.extension:prefix-qualifier.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. |
| Summary | false |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier |
| 80. Patient.name:Name.prefix.extension:prefix-qualifier.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 | 10..1 |
| Binding | The codes SHALL be taken from For codes, see EntityNamePartQualifier (required to http://hl7.org/fhir/ValueSet/name-part-qualifier) |
| Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Fixed Value | AC |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. Patient.name:Geburtsname | |
| Slice Name | Geburtsname |
| Definition | A name associated with the individual. |
| Short | GeburtsnameA name associated with the patient |
| Comments | Familienname zum Zeitpunkt der Geburt, sofern abweichend vom offiziellen Namen. A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. |
| Control | 0..1* |
| Type | HumanName(HumanName, deutsches Basisprofil) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 84. Patient.name:Geburtsname.use | |
| Definition | Identifies the purpose for this name. |
| Short | Verwendungszweckusual | official | temp | nickname | anonymous | old | maiden |
| Comments | Hier ist stets der Wert Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)The use of a human name. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 86. Patient.name:Geburtsname.family | |
| Definition | Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt. The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. |
| Short | NachnameFamily name (often called 'Surname') |
| Comments | Vollständiger Nachname bzw. Familienname des Patienten, einschließlich Vor- und Zusätze. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
| 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 |
| Alternate Names | surname |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 88. Patient.name:Geburtsname.family.extension:namenszusatz | |
| Slice Name | namenszusatz |
| Definition | Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst |
| Short | Namenszusatz |
| Comments | Enthält ehem. Adelstitel wie z.B. 'Graf', 'Baronesse', 'Freiherr'... |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Extension zur Erfassung der VSDM Namensbestandteile) (Extension Type: string) |
| Must Support | true |
| 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()) |
| 90. Patient.name:Geburtsname.family.extension:nachname | |
| Slice Name | nachname |
| Definition | The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. |
| Short | Nachname |
| Comments | Nachname ohne Vor- und Zusätze. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Own Name) (Extension Type: string) |
| Must Support | true |
| 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()) |
| 92. Patient.name:Geburtsname.family.extension:vorsatzwort | |
| Slice Name | vorsatzwort |
| Definition | The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. |
| Short | Voorvoegsel derived from person's own surname |
| Comments | Enthält Vorsätze, die vor dem Nachnamen stehen, z.B. 'von', 'van', 'zu'... |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Own Prefix) (Extension Type: string) |
| Must Support | true |
| 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()) |
| 94. Patient.name:Geburtsname.given | |
| Definition | Vorname der Person Given name. |
| Short | VornameGiven names (not always 'first'). Includes middle names |
| Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. |
| Control | 0..0* 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 |
| Summary | true |
| Alternate Names | first name, middle name |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 96. Patient.name:Geburtsname.prefix | |
| Definition | Namensteile vor dem Vornamen, z.B. akademischer Titel. Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. |
| Short | Namensteile vor dem VornamenParts that come before the name |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..0* 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 |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 99. Patient.telecom | |
| Definition | A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
| Short | Angabe der KontaktdatenA contact detail for the individual |
| Comments | Angabe der Kontaktdaten des Patienten, z.B. Telefonnummer oder E-Mail-Adresse. Bedingtes MS: Kontaktdaten sind im Kontext der Terminplanung unerlässlich, z.B. für Terminvereinbarungen oder Rückfragen. Das Must-Support gilt ausschließlich für Systeme, die Kontaktdaten persistieren. A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). |
| Control | 0..* |
| Type | ContactPoint |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | People have (primary) ways to contact them in some way such as phone, email. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 101. Patient.telecom.system | |
| Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
| Short | Art der Kontaktdatenphone | fax | email | pager | url | sms | other |
| Comments | Hier ist der Art der Kontaktdaten anzugeben, z.B. |
| Control | 10..1 This element is affected by the following invariants: cpt-2 |
| Binding | The codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)Telecommunications form for contact point. |
| 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 103. Patient.telecom.value | |
| Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
| Short | Wert der KontaktdatenThe actual contact point details |
| Comments | Enthält den eigentlichen Wert der Kontaktdaten, z.B. die Telefonnummer oder E-Mail-Adresse. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
| Control | 10..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 |
| Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 105. Patient.telecom.use | |
| Definition | Identifies the purpose for the contact point. |
| Short | home | work | temp | old | mobile - purpose of this contact point |
| Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)Use of contact point. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 107. Patient.gender | |
| Definition | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. |
| Short | Administratives Geschlechtmale | female | other | unknown |
| Comments | Für die Geschlechtskennzeichen 'unbestimmt' und 'divers' ist der international vereinbarte code
The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)The gender of a person used for administrative purposes. |
| 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 | Needed for identification of the individual, in combination with (at least) name and birth date. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 109. Patient.gender.extension | |
| Definition | An Extension 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 | ExtensionAdditional 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..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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 Patient.gender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 111. Patient.gender.extension:Geschlecht-Administrativ | |
| Slice Name | Geschlecht-Administrativ |
| Definition | Optional Extension Element - found in all resources. |
| Short | Extension zur Differenzierung des Geschlechtskennzeichens |
| Comments | Diese Extension darf nur in Verbindung mit dem Geschlechtskennzeichen |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Differenzierung des administrativen Geschlechts 'other') (Extension Type: Coding) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| 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()) |
| 113. Patient.birthDate | |
| Definition | The date of birth for the individual. |
| Short | GeburtsdatumThe date of birth for the individual |
| Comments | Tages-, monats- oder jahresgenaues Geburtsdatum. At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). |
| Control | 10..1 |
| Type | date |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Age of the individual drives many clinical processes. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| LOINC Code | 21112-8 |
| 115. Patient.birthDate.extension | |
| Definition | An Extension 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 | ExtensionAdditional 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..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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 Patient.birthDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 117. Patient.birthDate.extension:Data-Absent-Reason | |
| Slice Name | Data-Absent-Reason |
| Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
| Short | Begründung für fehlende Information |
| Comments | ToDo |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Data Absent Reason) (Extension Type: code) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| 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()) |
| 119. Patient.birthDate.extension:Data-Absent-Reason.extension | |
| Definition | An Extension 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 | ExtensionAdditional 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* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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 Patient.birthDate.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 121. Patient.birthDate.extension:Data-Absent-Reason.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. |
| Summary | false |
| Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
| 123. Patient.birthDate.extension:Data-Absent-Reason.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 | 10..1 |
| Binding | The codes SHALL be taken from For codes, see DataAbsentReason (required to http://hl7.org/fhir/ValueSet/data-absent-reason) |
| Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | false |
| Fixed Value | unknown |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 125. Patient.deceased[x] | |
| Definition | Indicates if the individual is deceased or not. |
| Short | Indicates if the individual is deceased or not |
| Comments | Einschränkung der übergreifenden MS-Definition: Die Implementierung dieses Elements ist für Server optional. Die Kennzeichnung als Must-Support erfolgt, da es sich um ein als Modifier-Element markiertes Feld in der Kernspezifikation handelt.
If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. |
| Control | 0..1 |
| Type | Choice of: boolean, dateTime |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 127. Patient.address | |
| Definition | An address for the individual. |
| Short | An address for the individual |
| Comments | Angabe der Adressen Patient may have multiple addresses with different uses or applicable periods. |
| Control | 0..* |
| Type | Address |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. |
| 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 Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 129. Patient.address:Strassenanschrift | |
| Slice Name | Strassenanschrift |
| Definition | An address for the individual. |
| Short | StraßenanschriftAn address for the individual |
| Comments | Wohn- oder Aufenthaltsort des Patienten Patient may have multiple addresses with different uses or applicable periods. |
| Control | 0..* |
| Type | Address(Adresse, deutsches Basisprofil) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) address-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. ( country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))) |
| 131. Patient.address:Strassenanschrift.extension:Stadtteil | |
| Slice Name | Stadtteil |
| Definition | A subsection of a municipality. |
| Short | precinct |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP Precinct) (Extension Type: string) |
| Must Support | true |
| 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()) |
| 133. Patient.address:Strassenanschrift.use | |
| Definition | The purpose of this address. |
| Short | home | work | temp | old | billing - purpose of this address |
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)The use of an address. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows an appropriate address to be chosen from a list of many. |
| Example | General: home |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 135. Patient.address:Strassenanschrift.type | |
| Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
| Short | Adresstyppostal | physical | both |
| Comments | Hier ist stets der Wert The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)The type of an address (physical / postal). |
| 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 |
| Example | General: both |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 137. Patient.address:Strassenanschrift.line | |
| Definition | Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können. This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
| Short | AdresszeileStreet name, number, direction & P.O. Box etc. |
| Comments | Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, c/o
sowie weitere Zustellungshinweise enthalten.
Die Informationen können in mehrere line-Komponenten aufgeteilt werden.
Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln,
müssen diese Informationen stets vollständig auch in der line-Komponente,
die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen,
auf diese Informationen zugreifen zu können. |
| Control | 10..3* 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: 137 Nowhere Street Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 139. Patient.address:Strassenanschrift.line.extension:Strasse | |
| Slice Name | Strasse |
| Definition | streetName. |
| Short | Strassenname |
| Comments | Strassenname (ohne Hausnummer).
Bei Angabe einer Strasse in dieser Extension muss diese auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP Street Name) (Extension Type: string) |
| Must Support | true |
| 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()) |
| 141. Patient.address:Strassenanschrift.line.extension:Hausnummer | |
| Slice Name | Hausnummer |
| Definition | The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. |
| Short | houseNumber |
| Comments | Hausnummer, sowie Zusätze (Appartmentnummer, Etage...).
Bei Angabe einer Hausnummer in dieser Extension muss diese auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP House Number) (Extension Type: string) |
| Must Support | true |
| 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()) |
| 143. Patient.address:Strassenanschrift.line.extension:Adresszusatz | |
| Slice Name | Adresszusatz |
| Definition | This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). |
| Short | additionalLocator |
| Comments | Zusätzliche Informationen, wie z.B. '3. Etage', 'Appartment C'.
Bei Angabe einer Zusatzinformation in dieser Extension muss diese auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP Additional Locator) (Extension Type: string) |
| Must Support | true |
| 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()) |
| 145. Patient.address:Strassenanschrift.line.extension:Postfach | |
| Slice Name | Postfach |
| Definition | A numbered box located in a post station. |
| Short | Postfachnummer |
| Comments | Postfach-Adresse. Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
Eine Postfach-Adresse darf nicht in Verbindung mit Address.type |
| Control | 0..0 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP Post Box) (Extension Type: string) |
| 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()) |
| 147. Patient.address:Strassenanschrift.city | |
| Definition | The name of the city, town, suburb, village or other community or delivery center. |
| Short | StadtName of city, town etc. |
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. |
| 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 |
| Alternate Names | Municpality |
| Example | General: Erewhon |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 149. Patient.address:Strassenanschrift.district | |
| Definition | The name of the administrative area (county). |
| Short | District name (aka county) |
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
| Control | 0..01 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 |
| Summary | true |
| Alternate Names | County |
| Example | General: Madison |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 151. Patient.address:Strassenanschrift.postalCode | |
| Definition | Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen A postal code designating a region defined by the postal service. |
| Short | PostleitzahlPostal code for area |
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. |
| 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 |
| Alternate Names | Zip |
| Example | General: 9132 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 153. Patient.address:Strassenanschrift.country | |
| Definition | Staatsangabe (ohne festgeschriebenen Wertevorrat) Country - a nation as commonly understood or generally accepted. |
| Short | LandCountry (e.g. can be ISO 3166 2 or 3 letter code) |
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. ISO 3166 3 letter codes can be used in place of a human readable country name. |
| 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 | Beispiel für textuelle Landesangabe: Deutschland |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 155. Patient.address:Strassenanschrift.country.extension:countryCode | |
| Slice Name | countryCode |
| Definition | Kodierte Angabe des Länderkennzeichens nach ISO 3166-1. |
| Short | Länderkennzeichen nach ISO 3166-1 |
| Comments | Diese Abbildung entspricht der auf EU-Ebene in Abstimmung befindlichen Profilierung zur Kodierung der Landesangabe. Durch die Verwendung der internationalen Kodierung wird die interoperable Verwendung der Adressangabe erleichtert. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Coded string) (Extension Type: Coding) |
| Alternate Names | extensions, user content |
| Example | Beispiel für kodierte Landesangabe: { "system" : "urn:iso:std:iso:3166", "code" : "DE", "display" : "Deutschland" } |
| 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()) |
| 157. Patient.address:Strassenanschrift.country.extension:countryCode.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 |
| 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 Patient.address.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 159. Patient.address:Strassenanschrift.country.extension:countryCode.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://hl7.org/fhir/StructureDefinition/iso21090-codedString |
| 161. Patient.address:Strassenanschrift.country.extension:countryCode.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 | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from For codes, see Iso3166-1-2 (required to http://hl7.org/fhir/ValueSet/iso3166-1-2)A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. |
| Type | Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 163. Patient.address:Postfach | |
| Slice Name | Postfach |
| Definition | An address for the individual. |
| Short | PostfachadresseAn address for the individual |
| Comments | Adresse, die nur für postalische Zustellung genutzt werden kann. Patient may have multiple addresses with different uses or applicable periods. |
| Control | 0..* |
| Type | Address(Adresse, deutsches Basisprofil) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) address-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. ( country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))) |
| 165. Patient.address:Postfach.extension:Stadtteil | |
| Slice Name | Stadtteil |
| Definition | A subsection of a municipality. |
| Short | Stadt- oder Ortsteil |
| 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(ADXP Precinct) (Extension Type: string) |
| 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()) |
| 167. Patient.address:Postfach.use | |
| Definition | The purpose of this address. |
| Short | home | work | temp | old | billing - purpose of this address |
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)The use of an address. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows an appropriate address to be chosen from a list of many. |
| Example | General: home |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 169. Patient.address:Postfach.type | |
| Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
| Short | Adresstyppostal | physical | both |
| Comments | Hier ist stets der Wert The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)The type of an address (physical / postal). |
| 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 |
| Example | General: both |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 171. Patient.address:Postfach.line | |
| Definition | Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können. This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
| Short | AdresszeileStreet name, number, direction & P.O. Box etc. |
| Comments | Diese Komponente enthält die Postfachadresse als String der Form 'Postfach: 12345'.
Bei Verwendung der Postfach-Extension, um die Postfachnummer strukturiert zu übermitteln,
müssen diese Informationen stets vollständig auch in der line-Komponente,
die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen,
auf diese Informationen zugreifen zu können. |
| Control | 10..3* 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: 137 Nowhere Street Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 173. Patient.address:Postfach.line.extension:Strasse | |
| Slice Name | Strasse |
| Definition | streetName. |
| Short | streetName |
| Control | 0..0 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP Street Name) (Extension Type: string) |
| 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()) |
| 175. Patient.address:Postfach.line.extension:Hausnummer | |
| Slice Name | Hausnummer |
| Definition | The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. |
| Short | houseNumber |
| Control | 0..0 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP House Number) (Extension Type: string) |
| 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()) |
| 177. Patient.address:Postfach.line.extension:Adresszusatz | |
| Slice Name | Adresszusatz |
| Definition | This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). |
| Short | additionalLocator |
| Control | 0..0 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP Additional Locator) (Extension Type: string) |
| 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()) |
| 179. Patient.address:Postfach.line.extension:Postfach | |
| Slice Name | Postfach |
| Definition | A numbered box located in a post station. |
| Short | Postfachnummer |
| Comments | Postfach-Adresse. Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
Eine Postfach-Adresse darf nicht in Verbindung mit Address.type |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(ADXP Post Box) (Extension Type: string) |
| Must Support | true |
| 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()) |
| 181. Patient.address:Postfach.city | |
| Definition | The name of the city, town, suburb, village or other community or delivery center. |
| Short | StadtName of city, town etc. |
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. |
| 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 |
| Alternate Names | Municpality |
| Example | General: Erewhon |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 183. Patient.address:Postfach.district | |
| Definition | The name of the administrative area (county). |
| Short | District name (aka county) |
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
| Control | 0..01 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 |
| Summary | true |
| Alternate Names | County |
| Example | General: Madison |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 185. Patient.address:Postfach.postalCode | |
| Definition | Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen A postal code designating a region defined by the postal service. |
| Short | PostleitzahlPostal code for area |
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. |
| 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 |
| Alternate Names | Zip |
| Example | General: 9132 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 187. Patient.address:Postfach.country | |
| Definition | Staatsangabe (ohne festgeschriebenen Wertevorrat) Country - a nation as commonly understood or generally accepted. |
| Short | LandCountry (e.g. can be ISO 3166 2 or 3 letter code) |
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. ISO 3166 3 letter codes can be used in place of a human readable country name. |
| 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 | Beispiel für textuelle Landesangabe: Deutschland |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 189. Patient.address:Postfach.country.extension:countryCode | |
| Slice Name | countryCode |
| Definition | Kodierte Angabe des Länderkennzeichens nach ISO 3166-1. |
| Short | Länderkennzeichen nach ISO 3166-1 |
| Comments | Diese Abbildung entspricht der auf EU-Ebene in Abstimmung befindlichen Profilierung zur Kodierung der Landesangabe. Durch die Verwendung der internationalen Kodierung wird die interoperable Verwendung der Adressangabe erleichtert. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Coded string) (Extension Type: Coding) |
| Alternate Names | extensions, user content |
| Example | Beispiel für kodierte Landesangabe: { "system" : "urn:iso:std:iso:3166", "code" : "DE", "display" : "Deutschland" } |
| 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()) |
| 191. Patient.address:Postfach.country.extension:countryCode.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 |
| 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 Patient.address.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 193. Patient.address:Postfach.country.extension:countryCode.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://hl7.org/fhir/StructureDefinition/iso21090-codedString |
| 195. Patient.address:Postfach.country.extension:countryCode.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 | 10..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from For codes, see Iso3166-1-2 (required to http://hl7.org/fhir/ValueSet/iso3166-1-2)A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. |
| Type | Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 197. Patient.link | |
| Definition | Link to another patient resource that concerns the same actual patient. |
| Short | LinkLink to another patient resource that concerns the same actual person |
| Comments | Dieses und untergeordnete Elemente KÖNNEN bei einem erfolgten Patient merge entsprechend der Festlegungen unter Patient-merge befüllt werden. Da das Element der Unterstützung der Patient merge Notification dient, MUSS es im Rahmen des Bestätigungsverfahrens NICHT unterstützt werden (Stand: Stufe 4). There is no assumption that linked patient records have mutual links. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | true because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by' |
| Must Support | true |
| Summary | true |
| Requirements | There are multiple use cases:
|
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 199. Patient.link.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..* |
| 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()) |
| 201. Patient.link.other | |
| Definition | The other patient resource that the link refers to. |
| Short | The other patient or related person resource that the link refers to |
| Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. |
| Control | 1..1 |
| Type | Reference(Patient, RelatedPerson) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 203. Patient.link.other.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| Comments | Logischer Verweis auf Identifier[Patientennummer] When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier |
| 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())) |
| 205. Patient.link.type | |
| Definition | The type of link between this patient resource and another patient resource. |
| Short | replaced-by | replaces | refer | seealso |
| Control | 1..1 |
| Binding | The codes SHALL be taken from LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)The type of link between this patient resource and another patient resource. |
| 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Patient | |
| Invariants | isik-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden (gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()) |
| 2. Patient.id | |
| Short | serverseitige, interne ID des Datensatzes |
| Comments | bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine |
| Must Support | true |
| 4. Patient.meta | |
| 6. Patient.meta.versionId | |
| Short | Eindeutiger Name der serverseitigen Version des Datensatzes |
| Comments | Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine |
| 8. Patient.meta.lastUpdated | |
| Short | Zeitpunkt der letzten Änderung |
| Comments | Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein |
| 10. Patient.implicitRules | |
| Short | Verweis auf die Regeln, nach denen die Ressource erstellt wurde |
| Comments | Begründung Constraint: In ISiK existiert kein Use-Case für dieses Element. Da es sich um ein Modifying Element handelt, wird es daher ausgeschlossen. Darüber hinaus werden die Regeln als URI vorgehalten. Dies führt dazu, dass sich hinter der URI eine beliebige Menge an Regeln befinden kann; wodurch nicht sichergestellt werden kann, dass alle Clients die Regeln korrekt interpretieren können. |
| Control | 0..0 |
| 12. Patient.identifier | |
| Comments | Eindeutiger Identifier des Patienten |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..? |
| Must Support | true |
| Slicing | This element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 14. Patient.identifier:VersichertenId | |
| Slice Name | VersichertenId |
| Short | Lebenslange Krankenversichertennummer |
| Comments | Die als 'KVZ10' kodierte Versichertennummer ist der 10-stellige,
unveränderbare Teil der Versichertennummer,
der lesbar auf die Elektronische Gesundheitskarte aufgedruckt ist.
Er gilt für alle Krankenversichertennummern,
unabhängig davon, ob es sich um GKV, PKV oder Sonderkostenträger handelt. Für eine Weiterverarbeitung einer Patient-Ressource in der ePA ist dieser Identifier im EPAPatient-Profil ein Pflichtfeld. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier(Identifier-Profil für die 10-stellige Krankenversichertennummer) |
| Must Support | true |
| Pattern Value | { |
| 16. Patient.identifier:VersichertenId.type | |
| Short | Art des Identifiers |
| Comments | Hier ist stets der Code |
| Control | 1..? |
| Must Support | true |
| 18. Patient.identifier:VersichertenId.system | |
| Short | Namensraum der Versichertennummer |
| Comments | Hier ist stets der Wert |
| Must Support | true |
| 20. Patient.identifier:VersichertenId.value | |
| Short | Lebenslange Krankenversichertennummer |
| Comments | Enthält den eigentlichen Wert des Identifiers. |
| Must Support | true |
| 22. Patient.identifier:Patientennummer | |
| Slice Name | Patientennummer |
| Short | Organisationsinterner Patienten-Identifier (PID) |
| Comments | Organisationsintere Patienten-Identifier werden von z.B. von KIS-Systemen vergeben
und dienen innerhalb einer Einreichtung meist als primäres Identifikationsmerkmal für Patienten,
u.A. in der HL7 V2-Kommunikation. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..* |
| Type | Identifier(Identifier-Profil für die Abbildung einer Patienten-ID) |
| Must Support | true |
| Pattern Value | { |
| 24. Patient.identifier:Patientennummer.type | |
| Short | Art des Identifiers |
| Comments | Hier ist stets der Code |
| Must Support | true |
| 26. Patient.identifier:Patientennummer.system | |
| Short | Namensraum des Identifiers |
| Comments | Hier ist stets der eindeutige Name (URL) des Namensraums anzugeben,
aus dem der Identifier stammt.
Hinweise zur Festlegung der URLs für lokale Namensräume sind in den
Deutschen Basisprofilen beschrieben. |
| Must Support | true |
| 28. Patient.identifier:Patientennummer.value | |
| Comments | Enthält den eigentlichen Wert des Identifiers. |
| Must Support | true |
| 30. Patient.identifier:Versichertennummer_PKV | |
| Slice Name | Versichertennummer_PKV |
| Short | Private Krankenversichertennummer |
| Comments | Für Privatpatienten, die noch nicht über eine lebenslange, unveränderliche Krankenversichertennummer (KVNR) verfügen,
können bis auf weiteres noch die versicherungsspezifischen PKV-Nummern angegeben werden.
Da bei diesen der Bezeichner des vom Kostenträger verwendeten Namensraums meist nicht ermittelt werden kann,
ist statt dessen der Name des Kostenträgers in |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier(Identifier-Profil für die Abbildung einer Privatversichertennummer) |
| Must Support | false |
| Pattern Value | { |
| 32. Patient.identifier:Versichertennummer_PKV.use | |
| Short | Verwendungszeck des Identifiers |
| Comments | Hier ist stets der Wert |
| Must Support | true |
| 34. Patient.identifier:Versichertennummer_PKV.type | |
| Short | Art des Identifiers |
| Comments | Hier ist stets der Code |
| Control | 1..? |
| Must Support | true |
| 36. Patient.identifier:Versichertennummer_PKV.value | |
| Short | Private Krankenversichertennummer |
| Comments | Enthält den eigentlichen Wert des Identifiers. |
| Must Support | true |
| 38. Patient.identifier:Versichertennummer_PKV.assigner | |
| Must Support | true |
| 40. Patient.identifier:Versichertennummer_PKV.assigner.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| 42. Patient.identifier:Versichertennummer_PKV.assigner.identifier.system | |
| Short | Namensraum des Identifiers |
| Comments | Hier ist stets der Wert |
| Must Support | true |
| 44. Patient.identifier:Versichertennummer_PKV.assigner.identifier.value | |
| Short | IK-Nummer des Kostenträgers |
| Comments | IK-Nummer des Kostenträgers, aus dessen Nummernkreis die PKV-Nummer stammt. |
| Must Support | true |
| 46. Patient.identifier:Versichertennummer_PKV.assigner.display | |
| Short | Name des Kostenträgers |
| Comments | Name des Kostenträgers, aus dessen Nummernkreis die PKV-Nummer stammt. |
| Must Support | true |
| 48. Patient.active | |
| Short | Status des Datensatzes |
| Comments |
|
| Must Support | true |
| 50. Patient.name | |
| Comments | Angabe der Namen |
| Control | 1..? |
| Must Support | true |
| Slicing | This element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 52. Patient.name:Name | |
| Slice Name | Name |
| Short | Offizieller Name |
| Comments | Offizieller Name des Patienten, wie er z.B. in Ausweis oder Versicherungsdokumenten erscheint.
Begründung Pflichtfeld: Der offizielle Name des Patienten ist unerlässlich, um Verwechlungen zu vermeiden und den Patienten im Versorgungskontext korrekt anzusprechen.
Wenn kein Name vorliegt, MUSS die data-absent-reason-Extension eingesetzt werden. |
| Control | 1..1 |
| Type | HumanName(HumanName, deutsches Basisprofil) |
| Must Support | true |
| Pattern Value | { |
| 54. Patient.name:Name.use | |
| Short | Verwendungszweck |
| Comments | Hier ist stets der Wert |
| Control | 1..? |
| Must Support | true |
| 56. Patient.name:Name.family | |
| Short | Nachname |
| Comments | Vollständiger Nachname bzw. Familienname der Person, einschließlich Vor- und Zusätze. |
| Control | 1..? |
| Must Support | true |
| 58. Patient.name:Name.family.extension:namenszusatz | |
| Slice Name | namenszusatz |
| Short | Namenszusatz |
| Comments | Enthält ehem. Adelstitel wie z.B. 'Graf', 'Baronesse', 'Freiherr'... |
| Must Support | true |
| 60. Patient.name:Name.family.extension:nachname | |
| Slice Name | nachname |
| Short | Nachname |
| Comments | Nachname ohne Vor- und Zusätze. |
| Must Support | true |
| 62. Patient.name:Name.family.extension:vorsatzwort | |
| Slice Name | vorsatzwort |
| Comments | Enthält Vorsätze, die vor dem Nachnamen stehen, z.B. 'von', 'van', 'zu'... |
| Must Support | true |
| 64. Patient.name:Name.given | |
| Comments | Kann mehrfach verwendet werden, um den Rufnamen sowie weitere Vornamen, Mittelnamen oder Mittel-Initialen abzubilden. Begründung Pflichtfeld: Ein offizieller Name ist nur zulässig, wenn der Nachname und mindestens ein Vorname angegeben sind. |
| Control | 1..? |
| Must Support | true |
| 66. Patient.name:Name.prefix | |
| Short | Präfix |
| Comments | Präfix, z.B. akademischer Titel od. militärischer Rang |
| Must Support | true |
| 68. Patient.name:Name.prefix.extension:prefix-qualifier | |
| Slice Name | prefix-qualifier |
| Short | Extension, um das Präfix als akademischen Titel zu qualifizieren |
| Comments | Hier ist stets der Wert |
| Must Support | true |
| 70. Patient.name:Name.prefix.extension:prefix-qualifier.value[x] | |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Fixed Value | AC |
| 72. Patient.name:Geburtsname | |
| Slice Name | Geburtsname |
| Short | Geburtsname |
| Comments | Familienname zum Zeitpunkt der Geburt, sofern abweichend vom offiziellen Namen. |
| Control | 0..1 |
| Type | HumanName(HumanName, deutsches Basisprofil) |
| Must Support | true |
| Pattern Value | { |
| 74. Patient.name:Geburtsname.use | |
| Short | Verwendungszweck |
| Comments | Hier ist stets der Wert |
| Control | 1..? |
| Must Support | true |
| 76. Patient.name:Geburtsname.family | |
| Short | Nachname |
| Comments | Vollständiger Nachname bzw. Familienname des Patienten, einschließlich Vor- und Zusätze. |
| Control | 1..? |
| Must Support | true |
| 78. Patient.name:Geburtsname.family.extension:namenszusatz | |
| Slice Name | namenszusatz |
| Short | Namenszusatz |
| Comments | Enthält ehem. Adelstitel wie z.B. 'Graf', 'Baronesse', 'Freiherr'... |
| Must Support | true |
| 80. Patient.name:Geburtsname.family.extension:nachname | |
| Slice Name | nachname |
| Short | Nachname |
| Comments | Nachname ohne Vor- und Zusätze. |
| Must Support | true |
| 82. Patient.name:Geburtsname.family.extension:vorsatzwort | |
| Slice Name | vorsatzwort |
| Comments | Enthält Vorsätze, die vor dem Nachnamen stehen, z.B. 'von', 'van', 'zu'... |
| Must Support | true |
| 84. Patient.name:Geburtsname.given | |
| Control | 0..0 |
| 86. Patient.name:Geburtsname.prefix | |
| Control | 0..0 |
| 88. Patient.telecom | |
| Short | Angabe der Kontaktdaten |
| Comments | Angabe der Kontaktdaten des Patienten, z.B. Telefonnummer oder E-Mail-Adresse. Bedingtes MS: Kontaktdaten sind im Kontext der Terminplanung unerlässlich, z.B. für Terminvereinbarungen oder Rückfragen. Das Must-Support gilt ausschließlich für Systeme, die Kontaktdaten persistieren. |
| Must Support | true |
| 90. Patient.telecom.system | |
| Short | Art der Kontaktdaten |
| Comments | Hier ist der Art der Kontaktdaten anzugeben, z.B. |
| Control | 1..? |
| Must Support | true |
| 92. Patient.telecom.value | |
| Short | Wert der Kontaktdaten |
| Comments | Enthält den eigentlichen Wert der Kontaktdaten, z.B. die Telefonnummer oder E-Mail-Adresse. |
| Control | 1..? |
| Must Support | true |
| 94. Patient.gender | |
| Short | Administratives Geschlecht |
| Comments | Für die Geschlechtskennzeichen 'unbestimmt' und 'divers' ist der international vereinbarte code
|
| Control | 1..? |
| Must Support | true |
| 96. Patient.gender.extension | |
| Slicing | This element introduces a set of slices on Patient.gender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 98. Patient.gender.extension:Geschlecht-Administrativ | |
| Slice Name | Geschlecht-Administrativ |
| Short | Extension zur Differenzierung des Geschlechtskennzeichens |
| Comments | Diese Extension darf nur in Verbindung mit dem Geschlechtskennzeichen |
| Control | 0..1 |
| Type | Extension(Differenzierung des administrativen Geschlechts 'other') (Extension Type: Coding) |
| Must Support | true |
| 100. Patient.birthDate | |
| Short | Geburtsdatum |
| Comments | Tages-, monats- oder jahresgenaues Geburtsdatum. |
| Control | 1..? |
| Must Support | true |
| LOINC Code | |
| 102. Patient.birthDate.extension | |
| Slicing | This element introduces a set of slices on Patient.birthDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 104. Patient.birthDate.extension:Data-Absent-Reason | |
| Slice Name | Data-Absent-Reason |
| Short | Begründung für fehlende Information |
| Comments | ToDo |
| Control | 0..1 |
| Type | Extension(Data Absent Reason) (Extension Type: code) |
| Must Support | true |
| 106. Patient.birthDate.extension:Data-Absent-Reason.value[x] | |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Must Support | true |
| Fixed Value | unknown |
| 108. Patient.deceased[x] | |
| Comments | Einschränkung der übergreifenden MS-Definition: Die Implementierung dieses Elements ist für Server optional. Die Kennzeichnung als Must-Support erfolgt, da es sich um ein als Modifier-Element markiertes Feld in der Kernspezifikation handelt.
|
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Must Support | true |
| 110. Patient.address | |
| Comments | Angabe der Adressen |
| Must Support | true |
| Slicing | This element introduces a set of slices on Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 112. Patient.address:Strassenanschrift | |
| Slice Name | Strassenanschrift |
| Short | Straßenanschrift |
| Comments | Wohn- oder Aufenthaltsort des Patienten |
| Control | 0..* |
| Type | Address(Adresse, deutsches Basisprofil) |
| Must Support | true |
| Pattern Value | { |
| Invariants | address-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. (country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))) |
| 114. Patient.address:Strassenanschrift.extension:Stadtteil | |
| Slice Name | Stadtteil |
| Must Support | true |
| 116. Patient.address:Strassenanschrift.type | |
| Short | Adresstyp |
| Comments | Hier ist stets der Wert |
| Control | 1..? |
| Must Support | true |
| 118. Patient.address:Strassenanschrift.line | |
| Short | Adresszeile |
| Comments | Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, c/o
sowie weitere Zustellungshinweise enthalten.
Die Informationen können in mehrere line-Komponenten aufgeteilt werden.
Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln,
müssen diese Informationen stets vollständig auch in der line-Komponente,
die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen,
auf diese Informationen zugreifen zu können. |
| Control | 1..? |
| Must Support | true |
| 120. Patient.address:Strassenanschrift.line.extension:Strasse | |
| Slice Name | Strasse |
| Short | Strassenname |
| Comments | Strassenname (ohne Hausnummer).
Bei Angabe einer Strasse in dieser Extension muss diese auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. |
| Must Support | true |
| 122. Patient.address:Strassenanschrift.line.extension:Hausnummer | |
| Slice Name | Hausnummer |
| Comments | Hausnummer, sowie Zusätze (Appartmentnummer, Etage...).
Bei Angabe einer Hausnummer in dieser Extension muss diese auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. |
| Must Support | true |
| 124. Patient.address:Strassenanschrift.line.extension:Adresszusatz | |
| Slice Name | Adresszusatz |
| Comments | Zusätzliche Informationen, wie z.B. '3. Etage', 'Appartment C'.
Bei Angabe einer Zusatzinformation in dieser Extension muss diese auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. |
| Must Support | true |
| 126. Patient.address:Strassenanschrift.line.extension:Postfach | |
| Slice Name | Postfach |
| Short | Postfachnummer |
| Comments | Postfach-Adresse. Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
Eine Postfach-Adresse darf nicht in Verbindung mit Address.type |
| Control | 0..0 |
| 128. Patient.address:Strassenanschrift.city | |
| Short | Stadt |
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. |
| Control | 1..? |
| Must Support | true |
| 130. Patient.address:Strassenanschrift.postalCode | |
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. |
| Control | 1..? |
| Must Support | true |
| 132. Patient.address:Strassenanschrift.country | |
| Short | Land |
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. |
| Control | 1..? |
| Must Support | true |
| 134. Patient.address:Postfach | |
| Slice Name | Postfach |
| Short | Postfachadresse |
| Comments | Adresse, die nur für postalische Zustellung genutzt werden kann. |
| Control | 0..* |
| Type | Address(Adresse, deutsches Basisprofil) |
| Must Support | true |
| Pattern Value | { |
| Invariants | address-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. (country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))) |
| 136. Patient.address:Postfach.type | |
| Short | Adresstyp |
| Comments | Hier ist stets der Wert |
| Control | 1..? |
| Must Support | true |
| 138. Patient.address:Postfach.line | |
| Short | Adresszeile |
| Comments | Diese Komponente enthält die Postfachadresse als String der Form 'Postfach: 12345'.
Bei Verwendung der Postfach-Extension, um die Postfachnummer strukturiert zu übermitteln,
müssen diese Informationen stets vollständig auch in der line-Komponente,
die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen,
auf diese Informationen zugreifen zu können. |
| Control | 1..? |
| Must Support | true |
| 140. Patient.address:Postfach.line.extension:Strasse | |
| Slice Name | Strasse |
| Control | 0..0 |
| 142. Patient.address:Postfach.line.extension:Hausnummer | |
| Slice Name | Hausnummer |
| Control | 0..0 |
| 144. Patient.address:Postfach.line.extension:Adresszusatz | |
| Slice Name | Adresszusatz |
| Control | 0..0 |
| 146. Patient.address:Postfach.line.extension:Postfach | |
| Slice Name | Postfach |
| Short | Postfachnummer |
| Comments | Postfach-Adresse. Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
Eine Postfach-Adresse darf nicht in Verbindung mit Address.type |
| Must Support | true |
| 148. Patient.address:Postfach.city | |
| Short | Stadt |
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. |
| Control | 1..? |
| Must Support | true |
| 150. Patient.address:Postfach.postalCode | |
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. |
| Control | 1..? |
| Must Support | true |
| 152. Patient.address:Postfach.country | |
| Short | Land |
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. |
| Control | 1..? |
| Must Support | true |
| 154. Patient.link | |
| Short | Link |
| Comments | Dieses und untergeordnete Elemente KÖNNEN bei einem erfolgten Patient merge entsprechend der Festlegungen unter Patient-merge befüllt werden. Da das Element der Unterstützung der Patient merge Notification dient, MUSS es im Rahmen des Bestätigungsverfahrens NICHT unterstützt werden (Stand: Stufe 4). |
| Must Support | true |
| 156. Patient.link.other | |
| Must Support | true |
| 158. Patient.link.other.identifier | |
| Comments | Logischer Verweis auf Identifier[Patientennummer] |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Must Support | true |
| 160. Patient.link.type | |
| Must Support | true |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Patient | |||||
| Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. | ||||
| Short | Information about an individual or animal receiving health care services | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | SubjectOfCare Client Resident | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())isik-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden ( gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists()) | ||||
| 2. Patient.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | serverseitige, interne ID des Datensatzes | ||||
| Comments | bedingtes Pflichtfeld/bedingtes MS: Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| 4. Patient.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. Patient.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 | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 8. Patient.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..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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 Patient.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 10. Patient.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 | Eindeutiger Name der serverseitigen Version des Datensatzes | ||||
| Comments | Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| 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. Patient.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | Zeitpunkt der letzten Änderung | ||||
| Comments | Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| 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. Patient.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 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 16. Patient.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..* | ||||
| Type | canonical(StructureDefinition) | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 18. Patient.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..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 20. Patient.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..* | ||||
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. Patient.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 | Verweis auf die Regeln, nach denen die Ressource erstellt wurde | ||||
| Comments | Begründung Constraint: In ISiK existiert kein Use-Case für dieses Element. Da es sich um ein Modifying Element handelt, wird es daher ausgeschlossen. Darüber hinaus werden die Regeln als URI vorgehalten. Dies führt dazu, dass sich hinter der URI eine beliebige Menge an Regeln befinden kann; wodurch nicht sichergestellt werden kann, dass alle Clients die Regeln korrekt interpretieren können. | ||||
| Control | 0..0 | ||||
| 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. Patient.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 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. Patient.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 | ||||
| Type | Narrative | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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. Patient.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 | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 30. Patient.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..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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()) | ||||
| 32. Patient.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..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Summary | false | ||||
| 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()) | ||||
| 34. Patient.identifier | |||||
| Definition | An identifier for this patient. | ||||
| Short | An identifier for this patient | ||||
| Comments | Eindeutiger Identifier des Patienten | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 1..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| 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 Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 36. Patient.identifier:VersichertenId | |||||
| Slice Name | VersichertenId | ||||
| Definition | An identifier for this patient. | ||||
| Short | Lebenslange Krankenversichertennummer | ||||
| Comments | Die als 'KVZ10' kodierte Versichertennummer ist der 10-stellige,
unveränderbare Teil der Versichertennummer,
der lesbar auf die Elektronische Gesundheitskarte aufgedruckt ist.
Er gilt für alle Krankenversichertennummern,
unabhängig davon, ob es sich um GKV, PKV oder Sonderkostenträger handelt. Für eine Weiterverarbeitung einer Patient-Ressource in der ePA ist dieser Identifier im EPAPatient-Profil ein Pflichtfeld. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier(Identifier-Profil für die 10-stellige Krankenversichertennummer) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 38. Patient.identifier:VersichertenId.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. | ||||
| 40. Patient.identifier:VersichertenId.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 | ||||
| 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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 42. Patient.identifier:VersichertenId.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())) | ||||
| 44. Patient.identifier:VersichertenId.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Art des Identifiers | ||||
| Comments | Hier ist stets der Code | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from Identifier Type Kvid DeBasis ValueSet (required to http://fhir.de/ValueSet/identifier-type-kvid-de-basis)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 | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))kvid-2: Die type Codes 'GKV' und 'PKV' haben den Status 'retired', daher sollen diese nicht mehr verwendet werden ( ($this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='GKV') or $this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='PKV')).not()) | ||||
| 46. Patient.identifier:VersichertenId.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | Namensraum der Versichertennummer | ||||
| Comments | Hier ist stets der Wert | ||||
| 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. | ||||
| Fixed Value | http://fhir.de/sid/gkv/kvid-10 | ||||
| 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())) | ||||
| 48. Patient.identifier:VersichertenId.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | Lebenslange Krankenversichertennummer | ||||
| Comments | Enthält den eigentlichen Wert des Identifiers. | ||||
| 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()))kvid-1: Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen ( matches('^[A-Z][0-9]{9}$')) | ||||
| 50. Patient.identifier:VersichertenId.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 | ||||
| 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)) | ||||
| 52. Patient.identifier:VersichertenId.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) | ||||
| 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'))) | ||||
| 54. Patient.identifier:Patientennummer | |||||
| Slice Name | Patientennummer | ||||
| Definition | An identifier for this patient. | ||||
| Short | Organisationsinterner Patienten-Identifier (PID) | ||||
| Comments | Organisationsintere Patienten-Identifier werden von z.B. von KIS-Systemen vergeben
und dienen innerhalb einer Einreichtung meist als primäres Identifikationsmerkmal für Patienten,
u.A. in der HL7 V2-Kommunikation. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 1..* | ||||
| Type | Identifier(Identifier-Profil für die Abbildung einer Patienten-ID) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 56. Patient.identifier:Patientennummer.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. | ||||
| 58. Patient.identifier:Patientennummer.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 | ||||
| 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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 60. Patient.identifier:Patientennummer.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())) | ||||
| 62. Patient.identifier:Patientennummer.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Art des Identifiers | ||||
| Comments | Hier ist stets der Code | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSet (extensible to http://fhir.de/ValueSet/identifier-type-de-basis)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 | ||||
| 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())) | ||||
| 64. Patient.identifier:Patientennummer.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | Namensraum des Identifiers | ||||
| Comments | Hier ist stets der eindeutige Name (URL) des Namensraums anzugeben,
aus dem der Identifier stammt.
Hinweise zur Festlegung der URLs für lokale Namensräume sind in den
Deutschen Basisprofilen beschrieben. | ||||
| 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())) | ||||
| 66. Patient.identifier:Patientennummer.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 | Enthält den eigentlichen Wert des Identifiers. | ||||
| 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())) | ||||
| 68. Patient.identifier:Patientennummer.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 | ||||
| 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)) | ||||
| 70. Patient.identifier:Patientennummer.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) | ||||
| 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'))) | ||||
| 72. Patient.identifier:Versichertennummer_PKV | |||||
| Slice Name | Versichertennummer_PKV | ||||
| Definition | An identifier for this patient. | ||||
| Short | Private Krankenversichertennummer | ||||
| Comments | Für Privatpatienten, die noch nicht über eine lebenslange, unveränderliche Krankenversichertennummer (KVNR) verfügen,
können bis auf weiteres noch die versicherungsspezifischen PKV-Nummern angegeben werden.
Da bei diesen der Bezeichner des vom Kostenträger verwendeten Namensraums meist nicht ermittelt werden kann,
ist statt dessen der Name des Kostenträgers in | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier(Identifier-Profil für die Abbildung einer Privatversichertennummer) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 74. Patient.identifier:Versichertennummer_PKV.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. | ||||
| 76. Patient.identifier:Versichertennummer_PKV.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 | ||||
| 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 Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 78. Patient.identifier:Versichertennummer_PKV.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | Verwendungszeck des Identifiers | ||||
| Comments | Hier ist stets der Wert | ||||
| 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 | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Fixed Value | secondary | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 80. Patient.identifier:Versichertennummer_PKV.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Art des Identifiers | ||||
| Comments | Hier ist stets der Code | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSet (extensible to http://fhir.de/ValueSet/identifier-type-de-basis)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 | ||||
| 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())) | ||||
| 82. Patient.identifier:Versichertennummer_PKV.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 | 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 | ||||
| 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())) | ||||
| 84. Patient.identifier:Versichertennummer_PKV.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | Private Krankenversichertennummer | ||||
| Comments | Enthält den eigentlichen Wert des Identifiers. | ||||
| 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())) | ||||
| 86. Patient.identifier:Versichertennummer_PKV.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 | ||||
| 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)) | ||||
| 88. Patient.identifier:Versichertennummer_PKV.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 | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Organization) | ||||
| Must Support | true | ||||
| 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'))) | ||||
| 90. Patient.identifier:Versichertennummer_PKV.assigner.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. Patient.identifier:Versichertennummer_PKV.assigner.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 | ||||
| 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 Patient.identifier.assigner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 94. Patient.identifier:Versichertennummer_PKV.assigner.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1, ref-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())) | ||||
| 96. Patient.identifier:Versichertennummer_PKV.assigner.type | |||||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
| Short | Type the reference refers to (e.g. "Patient") | ||||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types)Aa resource (or, for logical models, the URI of the logical model). | ||||
| Type | uri | ||||
| 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())) | ||||
| 98. Patient.identifier:Versichertennummer_PKV.assigner.identifier | |||||
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | ||||
| Short | An identifier intended for computation | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
| 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(Identifier-Profil für die Abbildung eines Institutionskennzeichens (IKNR)) | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 100. Patient.identifier:Versichertennummer_PKV.assigner.identifier.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. | ||||
| 102. Patient.identifier:Versichertennummer_PKV.assigner.identifier.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 | ||||
| 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 Patient.identifier.assigner.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 104. Patient.identifier:Versichertennummer_PKV.assigner.identifier.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())) | ||||
| 106. Patient.identifier:Versichertennummer_PKV.assigner.identifier.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 | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSet (extensible to http://fhir.de/ValueSet/identifier-type-de-basis)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| 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())) | ||||
| 108. Patient.identifier:Versichertennummer_PKV.assigner.identifier.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | Namensraum des Identifiers | ||||
| Comments | Hier ist stets der Wert | ||||
| 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. | ||||
| Fixed Value | http://fhir.de/sid/arge-ik/iknr | ||||
| 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())) | ||||
| 110. Patient.identifier:Versichertennummer_PKV.assigner.identifier.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | IK-Nummer des Kostenträgers | ||||
| Comments | IK-Nummer des Kostenträgers, aus dessen Nummernkreis die PKV-Nummer stammt. | ||||
| 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()))ik-1: Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein ( matches('^[0-9]{9}$')) | ||||
| 112. Patient.identifier:Versichertennummer_PKV.assigner.identifier.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 | ||||
| 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)) | ||||
| 114. Patient.identifier:Versichertennummer_PKV.assigner.identifier.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) | ||||
| 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'))) | ||||
| 116. Patient.identifier:Versichertennummer_PKV.assigner.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Name des Kostenträgers | ||||
| Comments | Name des Kostenträgers, aus dessen Nummernkreis die PKV-Nummer stammt. | ||||
| 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 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 118. Patient.active | |||||
| Definition | Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. | ||||
| Short | Status des Datensatzes | ||||
| Comments |
| ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record 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 | ||||
| Requirements | Need to be able to mark a patient record as not to be used because it was created in error. | ||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 120. Patient.name | |||||
| Definition | A name associated with the individual. | ||||
| Short | A name associated with the patient | ||||
| Comments | Angabe der Namen | ||||
| Control | 1..* | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| 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 Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 122. Patient.name:Name | |||||
| Slice Name | Name | ||||
| Definition | A name associated with the individual. | ||||
| Short | Offizieller Name | ||||
| Comments | Offizieller Name des Patienten, wie er z.B. in Ausweis oder Versicherungsdokumenten erscheint.
Begründung Pflichtfeld: Der offizielle Name des Patienten ist unerlässlich, um Verwechlungen zu vermeiden und den Patienten im Versorgungskontext korrekt anzusprechen.
Wenn kein Name vorliegt, MUSS die data-absent-reason-Extension eingesetzt werden. | ||||
| Control | 1..1 | ||||
| Type | HumanName(HumanName, deutsches Basisprofil) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 124. Patient.name:Name.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. | ||||
| 126. Patient.name:Name.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 | ||||
| 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 Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 128. Patient.name:Name.use | |||||
| Definition | Identifies the purpose for this name. | ||||
| Short | Verwendungszweck | ||||
| Comments | Hier ist stets der Wert | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)The use of a human name. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 130. Patient.name:Name.text | |||||
| Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. | ||||
| Short | Text representation of the full name | ||||
| Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||
| 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 | A renderable, unencoded form. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 132. Patient.name:Name.family | |||||
| Definition | Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt. | ||||
| Short | Nachname | ||||
| Comments | Vollständiger Nachname bzw. Familienname der Person, einschließlich Vor- und Zusätze. | ||||
| 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 | ||||
| Alternate Names | surname | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 134. Patient.name:Name.family.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. | ||||
| 136. Patient.name:Name.family.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 | ||||
| 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 Patient.name.family.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 138. Patient.name:Name.family.extension:namenszusatz | |||||
| Slice Name | namenszusatz | ||||
| Definition | Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst | ||||
| Short | Namenszusatz | ||||
| Comments | Enthält ehem. Adelstitel wie z.B. 'Graf', 'Baronesse', 'Freiherr'... | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Extension zur Erfassung der VSDM Namensbestandteile) (Extension Type: string) | ||||
| Must Support | true | ||||
| 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()) | ||||
| 140. Patient.name:Name.family.extension:nachname | |||||
| Slice Name | nachname | ||||
| Definition | The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. | ||||
| Short | Nachname | ||||
| Comments | Nachname ohne Vor- und Zusätze. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Own Name) (Extension Type: string) | ||||
| Must Support | true | ||||
| 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()) | ||||
| 142. Patient.name:Name.family.extension:vorsatzwort | |||||
| Slice Name | vorsatzwort | ||||
| Definition | The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. | ||||
| Short | Voorvoegsel derived from person's own surname | ||||
| Comments | Enthält Vorsätze, die vor dem Nachnamen stehen, z.B. 'von', 'van', 'zu'... | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Own Prefix) (Extension Type: string) | ||||
| Must Support | true | ||||
| 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()) | ||||
| 144. Patient.name:Name.family.value | |||||
| Definition | Primitive value for string | ||||
| Short | Primitive value for string | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Max Length: | 1048576 | ||||
| 146. Patient.name:Name.given | |||||
| Definition | Vorname der Person | ||||
| Short | Vorname | ||||
| Comments | Kann mehrfach verwendet werden, um den Rufnamen sowie weitere Vornamen, Mittelnamen oder Mittel-Initialen abzubilden. Begründung Pflichtfeld: Ein offizieller Name ist nur zulässig, wenn der Nachname und mindestens ein Vorname angegeben sind. | ||||
| Control | 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 | ||||
| Alternate Names | first name, middle name | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 148. Patient.name:Name.prefix | |||||
| Definition | Namensteile vor dem Vornamen, z.B. akademischer Titel. | ||||
| Short | Präfix | ||||
| Comments | Präfix, z.B. akademischer Titel od. militärischer Rang | ||||
| Control | 0..* 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 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 150. Patient.name:Name.prefix.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. | ||||
| 152. Patient.name:Name.prefix.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 | ||||
| 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 Patient.name.prefix.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 154. Patient.name:Name.prefix.extension:prefix-qualifier | |||||
| Slice Name | prefix-qualifier | ||||
| Definition | A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. | ||||
| Short | Extension, um das Präfix als akademischen Titel zu qualifizieren | ||||
| Comments | Hier ist stets der Wert | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(EN Qualifier) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| 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()) | ||||
| 156. Patient.name:Name.prefix.extension:prefix-qualifier.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 | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 158. Patient.name:Name.prefix.extension:prefix-qualifier.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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 Patient.name.prefix.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 160. Patient.name:Name.prefix.extension:prefix-qualifier.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. | ||||
| Summary | false | ||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier | ||||
| 162. Patient.name:Name.prefix.extension:prefix-qualifier.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 | 1..1 | ||||
| Binding | The codes SHALL be taken from EntityNamePartQualifier (required to http://hl7.org/fhir/ValueSet/name-part-qualifier) | ||||
| Type | code | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Fixed Value | AC | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 164. Patient.name:Name.prefix.value | |||||
| Definition | Primitive value for string | ||||
| Short | Primitive value for string | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Max Length: | 1048576 | ||||
| 166. Patient.name:Name.suffix | |||||
| Definition | Namensteile nach dem Nachnamen | ||||
| Short | Namensteile nach dem Nachnamen | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..* 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())) | ||||
| 168. Patient.name:Name.period | |||||
| Definition | Indicates the period of time when this name was valid for the named person. | ||||
| Short | Time period when name was/is in 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 | ||||
| Summary | true | ||||
| Requirements | Allows names to be placed in historical context. | ||||
| 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)) | ||||
| 170. Patient.name:Geburtsname | |||||
| Slice Name | Geburtsname | ||||
| Definition | A name associated with the individual. | ||||
| Short | Geburtsname | ||||
| Comments | Familienname zum Zeitpunkt der Geburt, sofern abweichend vom offiziellen Namen. | ||||
| Control | 0..1 | ||||
| Type | HumanName(HumanName, deutsches Basisprofil) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 172. Patient.name:Geburtsname.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. | ||||
| 174. Patient.name:Geburtsname.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 | ||||
| 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 Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 176. Patient.name:Geburtsname.use | |||||
| Definition | Identifies the purpose for this name. | ||||
| Short | Verwendungszweck | ||||
| Comments | Hier ist stets der Wert | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)The use of a human name. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 178. Patient.name:Geburtsname.text | |||||
| Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. | ||||
| Short | Text representation of the full name | ||||
| Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||
| 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 | A renderable, unencoded form. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 180. Patient.name:Geburtsname.family | |||||
| Definition | Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt. | ||||
| Short | Nachname | ||||
| Comments | Vollständiger Nachname bzw. Familienname des Patienten, einschließlich Vor- und Zusätze. | ||||
| 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 | ||||
| Alternate Names | surname | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 182. Patient.name:Geburtsname.family.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. Patient.name:Geburtsname.family.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 | ||||
| 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 Patient.name.family.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 186. Patient.name:Geburtsname.family.extension:namenszusatz | |||||
| Slice Name | namenszusatz | ||||
| Definition | Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst | ||||
| Short | Namenszusatz | ||||
| Comments | Enthält ehem. Adelstitel wie z.B. 'Graf', 'Baronesse', 'Freiherr'... | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Extension zur Erfassung der VSDM Namensbestandteile) (Extension Type: string) | ||||
| Must Support | true | ||||
| 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()) | ||||
| 188. Patient.name:Geburtsname.family.extension:nachname | |||||
| Slice Name | nachname | ||||
| Definition | The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. | ||||
| Short | Nachname | ||||
| Comments | Nachname ohne Vor- und Zusätze. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Own Name) (Extension Type: string) | ||||
| Must Support | true | ||||
| 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()) | ||||
| 190. Patient.name:Geburtsname.family.extension:vorsatzwort | |||||
| Slice Name | vorsatzwort | ||||
| Definition | The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. | ||||
| Short | Voorvoegsel derived from person's own surname | ||||
| Comments | Enthält Vorsätze, die vor dem Nachnamen stehen, z.B. 'von', 'van', 'zu'... | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Own Prefix) (Extension Type: string) | ||||
| Must Support | true | ||||
| 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()) | ||||
| 192. Patient.name:Geburtsname.family.value | |||||
| Definition | Primitive value for string | ||||
| Short | Primitive value for string | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Max Length: | 1048576 | ||||
| 194. Patient.name:Geburtsname.given | |||||
| Definition | Vorname der Person | ||||
| Short | Vorname | ||||
| Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. | ||||
| Control | 0..0 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 | ||||
| Alternate Names | first name, middle name | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 196. Patient.name:Geburtsname.prefix | |||||
| Definition | Namensteile vor dem Vornamen, z.B. akademischer Titel. | ||||
| Short | Namensteile vor dem Vornamen | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 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())) | ||||
| 202. Patient.name:Geburtsname.suffix | |||||
| Definition | Namensteile nach dem Nachnamen | ||||
| Short | Namensteile nach dem Nachnamen | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..* 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())) | ||||
| 204. Patient.name:Geburtsname.period | |||||
| Definition | Indicates the period of time when this name was valid for the named person. | ||||
| Short | Time period when name was/is in 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 | ||||
| Summary | true | ||||
| Requirements | Allows names to be placed in historical context. | ||||
| 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)) | ||||
| 206. Patient.telecom | |||||
| Definition | A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. | ||||
| Short | Angabe der Kontaktdaten | ||||
| Comments | Angabe der Kontaktdaten des Patienten, z.B. Telefonnummer oder E-Mail-Adresse. Bedingtes MS: Kontaktdaten sind im Kontext der Terminplanung unerlässlich, z.B. für Terminvereinbarungen oder Rückfragen. Das Must-Support gilt ausschließlich für Systeme, die Kontaktdaten persistieren. | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 208. Patient.telecom.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 | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 210. Patient.telecom.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..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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 Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 212. Patient.telecom.system | |||||
| Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||
| Short | Art der Kontaktdaten | ||||
| Comments | Hier ist der Art der Kontaktdaten anzugeben, z.B. | ||||
| Control | 1..1 This element is affected by the following invariants: cpt-2 | ||||
| Binding | The codes SHALL be taken from ContactPointSystem (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)Telecommunications form for contact point. | ||||
| 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 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 214. Patient.telecom.value | |||||
| Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). | ||||
| Short | Wert der Kontaktdaten | ||||
| Comments | Enthält den eigentlichen Wert der Kontaktdaten, z.B. die Telefonnummer oder E-Mail-Adresse. | ||||
| Control | 1..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 | ||||
| Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 216. Patient.telecom.use | |||||
| Definition | Identifies the purpose for the contact point. | ||||
| Short | home | work | temp | old | mobile - purpose of this contact point | ||||
| Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from ContactPointUse (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)Use of contact point. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 218. Patient.telecom.rank | |||||
| Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. | ||||
| Short | Specify preferred order of use (1 = highest) | ||||
| Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. | ||||
| Control | 0..1 | ||||
| Type | positiveInt | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 220. Patient.telecom.period | |||||
| Definition | Time period when the contact point was/is in use. | ||||
| Short | Time period when the contact point was/is in use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 222. Patient.gender | |||||
| Definition | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. | ||||
| Short | Administratives Geschlecht | ||||
| Comments | Für die Geschlechtskennzeichen 'unbestimmt' und 'divers' ist der international vereinbarte code
| ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)The gender of a person used for administrative purposes. | ||||
| 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 | Needed for identification of the individual, in combination with (at least) name and birth date. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 224. Patient.gender.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 226. Patient.gender.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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 Patient.gender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 228. Patient.gender.extension:Geschlecht-Administrativ | |||||
| Slice Name | Geschlecht-Administrativ | ||||
| Definition | Optional Extension Element - found in all resources. | ||||
| Short | Extension zur Differenzierung des Geschlechtskennzeichens | ||||
| Comments | Diese Extension darf nur in Verbindung mit dem Geschlechtskennzeichen | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Differenzierung des administrativen Geschlechts 'other') (Extension Type: Coding) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| 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()) | ||||
| 230. Patient.gender.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 232. Patient.birthDate | |||||
| Definition | The date of birth for the individual. | ||||
| Short | Geburtsdatum | ||||
| Comments | Tages-, monats- oder jahresgenaues Geburtsdatum. | ||||
| Control | 1..1 | ||||
| Type | date | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Age of the individual drives many clinical processes. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| LOINC Code | 21112-8 | ||||
| 234. Patient.birthDate.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 236. Patient.birthDate.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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 Patient.birthDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 238. Patient.birthDate.extension:Data-Absent-Reason | |||||
| Slice Name | Data-Absent-Reason | ||||
| Definition | Provides a reason why the expected value or elements in the element that is extended are missing. | ||||
| Short | Begründung für fehlende Information | ||||
| Comments | ToDo | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Data Absent Reason) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| 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()) | ||||
| 240. Patient.birthDate.extension:Data-Absent-Reason.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 | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 242. Patient.birthDate.extension:Data-Absent-Reason.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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 Patient.birthDate.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 244. Patient.birthDate.extension:Data-Absent-Reason.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. | ||||
| Summary | false | ||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason | ||||
| 246. Patient.birthDate.extension:Data-Absent-Reason.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 | 1..1 | ||||
| Binding | The codes SHALL be taken from DataAbsentReason (required to http://hl7.org/fhir/ValueSet/data-absent-reason) | ||||
| Type | code | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Fixed Value | unknown | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 248. Patient.birthDate.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for date | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 250. Patient.deceased[x] | |||||
| Definition | Indicates if the individual is deceased or not. | ||||
| Short | Indicates if the individual is deceased or not | ||||
| Comments | Einschränkung der übergreifenden MS-Definition: Die Implementierung dieses Elements ist für Server optional. Die Kennzeichnung als Must-Support erfolgt, da es sich um ein als Modifier-Element markiertes Feld in der Kernspezifikation handelt.
| ||||
| Control | 0..1 | ||||
| Type | Choice of: boolean, dateTime | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 252. Patient.address | |||||
| Definition | An address for the individual. | ||||
| Short | An address for the individual | ||||
| Comments | Angabe der Adressen | ||||
| Control | 0..* | ||||
| Type | Address | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. | ||||
| 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 Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 254. Patient.address:Strassenanschrift | |||||
| Slice Name | Strassenanschrift | ||||
| Definition | An address for the individual. | ||||
| Short | Straßenanschrift | ||||
| Comments | Wohn- oder Aufenthaltsort des Patienten | ||||
| Control | 0..* | ||||
| Type | Address(Adresse, deutsches Basisprofil) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))address-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. ( country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))) | ||||
| 256. Patient.address:Strassenanschrift.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. | ||||
| 258. Patient.address:Strassenanschrift.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 | ||||
| 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 Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 260. Patient.address:Strassenanschrift.extension:Stadtteil | |||||
| Slice Name | Stadtteil | ||||
| Definition | A subsection of a municipality. | ||||
| Short | precinct | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ADXP Precinct) (Extension Type: string) | ||||
| Must Support | true | ||||
| 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()) | ||||
| 262. Patient.address:Strassenanschrift.use | |||||
| Definition | The purpose of this address. | ||||
| Short | home | work | temp | old | billing - purpose of this address | ||||
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from AddressUse (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)The use of an address. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows an appropriate address to be chosen from a list of many. | ||||
| Example | General: home | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 264. Patient.address:Strassenanschrift.type | |||||
| Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. | ||||
| Short | Adresstyp | ||||
| Comments | Hier ist stets der Wert | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from AddressType (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)The type of an address (physical / postal). | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Example | General: both | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 266. Patient.address:Strassenanschrift.text | |||||
| Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. | ||||
| Short | Text representation of the address | ||||
| Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||
| 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 | A renderable, unencoded form. | ||||
| Example | General: 137 Nowhere Street, Erewhon 9132 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 268. Patient.address:Strassenanschrift.line | |||||
| Definition | Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können. | ||||
| Short | Adresszeile | ||||
| Comments | Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, c/o
sowie weitere Zustellungshinweise enthalten.
Die Informationen können in mehrere line-Komponenten aufgeteilt werden.
Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln,
müssen diese Informationen stets vollständig auch in der line-Komponente,
die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen,
auf diese Informationen zugreifen zu können. | ||||
| Control | 1..3 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: 137 Nowhere Street Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 270. Patient.address:Strassenanschrift.line.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. | ||||
| 272. Patient.address:Strassenanschrift.line.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 | ||||
| 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 Patient.address.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 274. Patient.address:Strassenanschrift.line.extension:Strasse | |||||
| Slice Name | Strasse | ||||
| Definition | streetName. | ||||
| Short | Strassenname | ||||
| Comments | Strassenname (ohne Hausnummer).
Bei Angabe einer Strasse in dieser Extension muss diese auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ADXP Street Name) (Extension Type: string) | ||||
| Must Support | true | ||||
| 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()) | ||||
| 276. Patient.address:Strassenanschrift.line.extension:Hausnummer | |||||
| Slice Name | Hausnummer | ||||
| Definition | The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. | ||||
| Short | houseNumber | ||||
| Comments | Hausnummer, sowie Zusätze (Appartmentnummer, Etage...).
Bei Angabe einer Hausnummer in dieser Extension muss diese auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ADXP House Number) (Extension Type: string) | ||||
| Must Support | true | ||||
| 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()) | ||||
| 278. Patient.address:Strassenanschrift.line.extension:Adresszusatz | |||||
| Slice Name | Adresszusatz | ||||
| Definition | This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). | ||||
| Short | additionalLocator | ||||
| Comments | Zusätzliche Informationen, wie z.B. '3. Etage', 'Appartment C'.
Bei Angabe einer Zusatzinformation in dieser Extension muss diese auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ADXP Additional Locator) (Extension Type: string) | ||||
| Must Support | true | ||||
| 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()) | ||||
| 280. Patient.address:Strassenanschrift.line.extension:Postfach | |||||
| Slice Name | Postfach | ||||
| Definition | A numbered box located in a post station. | ||||
| Short | Postfachnummer | ||||
| Comments | Postfach-Adresse. Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
Eine Postfach-Adresse darf nicht in Verbindung mit Address.type | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ADXP Post Box) (Extension Type: string) | ||||
| 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()) | ||||
| 282. Patient.address:Strassenanschrift.line.value | |||||
| Definition | Primitive value for string | ||||
| Short | Primitive value for string | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Max Length: | 1048576 | ||||
| 284. Patient.address:Strassenanschrift.city | |||||
| Definition | The name of the city, town, suburb, village or other community or delivery center. | ||||
| Short | Stadt | ||||
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. | ||||
| 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 | ||||
| Alternate Names | Municpality | ||||
| Example | General: Erewhon | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 286. Patient.address:Strassenanschrift.district | |||||
| Definition | The name of the administrative area (county). | ||||
| Short | District name (aka county) | ||||
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. | ||||
| Control | 0..0 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 | ||||
| Alternate Names | County | ||||
| Example | General: Madison | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 288. Patient.address:Strassenanschrift.state | |||||
| Definition | Name (oder Kürzel) des Bundeslandes. | ||||
| Short | Bundesland | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHOULD be taken from ISO-3166-2:de-Laendercodes (preferred to http://fhir.de/ValueSet/iso/bundeslaender) | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Province, Territory | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 290. Patient.address:Strassenanschrift.postalCode | |||||
| Definition | Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen | ||||
| Short | Postleitzahl | ||||
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. | ||||
| 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 | ||||
| Alternate Names | Zip | ||||
| Example | General: 9132 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 292. Patient.address:Strassenanschrift.country | |||||
| Definition | Staatsangabe (ohne festgeschriebenen Wertevorrat) | ||||
| Short | Land | ||||
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. | ||||
| 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 | Beispiel für textuelle Landesangabe: Deutschland | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 294. Patient.address:Strassenanschrift.country.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. | ||||
| 296. Patient.address:Strassenanschrift.country.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 | ||||
| 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 Patient.address.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 298. Patient.address:Strassenanschrift.country.extension:countryCode | |||||
| Slice Name | countryCode | ||||
| Definition | Kodierte Angabe des Länderkennzeichens nach ISO 3166-1. | ||||
| Short | Länderkennzeichen nach ISO 3166-1 | ||||
| Comments | Diese Abbildung entspricht der auf EU-Ebene in Abstimmung befindlichen Profilierung zur Kodierung der Landesangabe. Durch die Verwendung der internationalen Kodierung wird die interoperable Verwendung der Adressangabe erleichtert. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Coded string) (Extension Type: Coding) | ||||
| Alternate Names | extensions, user content | ||||
| Example | Beispiel für kodierte Landesangabe: { "system" : "urn:iso:std:iso:3166", "code" : "DE", "display" : "Deutschland" } | ||||
| 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()) | ||||
| 300. Patient.address:Strassenanschrift.country.extension:countryCode.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. | ||||
| 302. Patient.address:Strassenanschrift.country.extension:countryCode.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 | ||||
| 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 Patient.address.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 304. Patient.address:Strassenanschrift.country.extension:countryCode.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://hl7.org/fhir/StructureDefinition/iso21090-codedString | ||||
| 306. Patient.address:Strassenanschrift.country.extension:countryCode.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 | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from Iso3166-1-2 (required to http://hl7.org/fhir/ValueSet/iso3166-1-2)A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. | ||||
| Type | Coding | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 308. Patient.address:Strassenanschrift.country.value | |||||
| Definition | Primitive value for string | ||||
| Short | Primitive value for string | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Max Length: | 1048576 | ||||
| 310. Patient.address:Strassenanschrift.period | |||||
| Definition | Time period when address was/is in use. | ||||
| Short | Time period when address was/is in 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 | ||||
| Summary | true | ||||
| Requirements | Allows addresses to be placed in historical context. | ||||
| Example | General: { "start" : "2010-03-23", "end" : "2010-07-01" } | ||||
| 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)) | ||||
| 312. Patient.address:Postfach | |||||
| Slice Name | Postfach | ||||
| Definition | An address for the individual. | ||||
| Short | Postfachadresse | ||||
| Comments | Adresse, die nur für postalische Zustellung genutzt werden kann. | ||||
| Control | 0..* | ||||
| Type | Address(Adresse, deutsches Basisprofil) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))address-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. ( country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))) | ||||
| 314. Patient.address:Postfach.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. | ||||
| 316. Patient.address:Postfach.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 | ||||
| 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 Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 318. Patient.address:Postfach.extension:Stadtteil | |||||
| Slice Name | Stadtteil | ||||
| Definition | A subsection of a municipality. | ||||
| Short | Stadt- oder Ortsteil | ||||
| 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(ADXP Precinct) (Extension Type: string) | ||||
| 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()) | ||||
| 320. Patient.address:Postfach.use | |||||
| Definition | The purpose of this address. | ||||
| Short | home | work | temp | old | billing - purpose of this address | ||||
| Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from AddressUse (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)The use of an address. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows an appropriate address to be chosen from a list of many. | ||||
| Example | General: home | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 322. Patient.address:Postfach.type | |||||
| Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. | ||||
| Short | Adresstyp | ||||
| Comments | Hier ist stets der Wert | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from AddressType (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)The type of an address (physical / postal). | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Example | General: both | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 324. Patient.address:Postfach.text | |||||
| Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. | ||||
| Short | Text representation of the address | ||||
| Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||
| 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 | A renderable, unencoded form. | ||||
| Example | General: 137 Nowhere Street, Erewhon 9132 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 326. Patient.address:Postfach.line | |||||
| Definition | Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postleitzahl strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können. | ||||
| Short | Adresszeile | ||||
| Comments | Diese Komponente enthält die Postfachadresse als String der Form 'Postfach: 12345'.
Bei Verwendung der Postfach-Extension, um die Postfachnummer strukturiert zu übermitteln,
müssen diese Informationen stets vollständig auch in der line-Komponente,
die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen,
auf diese Informationen zugreifen zu können. | ||||
| Control | 1..3 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: 137 Nowhere Street Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 328. Patient.address:Postfach.line.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. | ||||
| 330. Patient.address:Postfach.line.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 | ||||
| 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 Patient.address.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 332. Patient.address:Postfach.line.extension:Strasse | |||||
| Slice Name | Strasse | ||||
| Definition | streetName. | ||||
| Short | streetName | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ADXP Street Name) (Extension Type: string) | ||||
| 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()) | ||||
| 334. Patient.address:Postfach.line.extension:Hausnummer | |||||
| Slice Name | Hausnummer | ||||
| Definition | The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. | ||||
| Short | houseNumber | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ADXP House Number) (Extension Type: string) | ||||
| 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()) | ||||
| 336. Patient.address:Postfach.line.extension:Adresszusatz | |||||
| Slice Name | Adresszusatz | ||||
| Definition | This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). | ||||
| Short | additionalLocator | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ADXP Additional Locator) (Extension Type: string) | ||||
| 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()) | ||||
| 338. Patient.address:Postfach.line.extension:Postfach | |||||
| Slice Name | Postfach | ||||
| Definition | A numbered box located in a post station. | ||||
| Short | Postfachnummer | ||||
| Comments | Postfach-Adresse. Bei Angabe eines Postfaches in dieser Extension muss das Postfach auch in Address.line angegeben werden,
um die Interoperabilität mit Systemen zu gewährleisten, die diese Extension nicht verwenden.
Eine Postfach-Adresse darf nicht in Verbindung mit Address.type | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ADXP Post Box) (Extension Type: string) | ||||
| Must Support | true | ||||
| 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()) | ||||
| 340. Patient.address:Postfach.line.value | |||||
| Definition | Primitive value for string | ||||
| Short | Primitive value for string | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Max Length: | 1048576 | ||||
| 342. Patient.address:Postfach.city | |||||
| Definition | The name of the city, town, suburb, village or other community or delivery center. | ||||
| Short | Stadt | ||||
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. | ||||
| 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 | ||||
| Alternate Names | Municpality | ||||
| Example | General: Erewhon | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 344. Patient.address:Postfach.district | |||||
| Definition | The name of the administrative area (county). | ||||
| Short | District name (aka county) | ||||
| Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. | ||||
| Control | 0..0 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 | ||||
| Alternate Names | County | ||||
| Example | General: Madison | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 346. Patient.address:Postfach.state | |||||
| Definition | Name (oder Kürzel) des Bundeslandes. | ||||
| Short | Bundesland | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHOULD be taken from ISO-3166-2:de-Laendercodes (preferred to http://fhir.de/ValueSet/iso/bundeslaender) | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Province, Territory | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 348. Patient.address:Postfach.postalCode | |||||
| Definition | Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen | ||||
| Short | Postleitzahl | ||||
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. | ||||
| 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 | ||||
| Alternate Names | Zip | ||||
| Example | General: 9132 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 350. Patient.address:Postfach.country | |||||
| Definition | Staatsangabe (ohne festgeschriebenen Wertevorrat) | ||||
| Short | Land | ||||
| Comments | Begründung Pflichtfeld: Ohne diese Angabe ist die Adresse nicht zustellbar. | ||||
| 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 | Beispiel für textuelle Landesangabe: Deutschland | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 352. Patient.address:Postfach.country.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. Patient.address:Postfach.country.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 | ||||
| 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 Patient.address.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 356. Patient.address:Postfach.country.extension:countryCode | |||||
| Slice Name | countryCode | ||||
| Definition | Kodierte Angabe des Länderkennzeichens nach ISO 3166-1. | ||||
| Short | Länderkennzeichen nach ISO 3166-1 | ||||
| Comments | Diese Abbildung entspricht der auf EU-Ebene in Abstimmung befindlichen Profilierung zur Kodierung der Landesangabe. Durch die Verwendung der internationalen Kodierung wird die interoperable Verwendung der Adressangabe erleichtert. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Coded string) (Extension Type: Coding) | ||||
| Alternate Names | extensions, user content | ||||
| Example | Beispiel für kodierte Landesangabe: { "system" : "urn:iso:std:iso:3166", "code" : "DE", "display" : "Deutschland" } | ||||
| 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. Patient.address:Postfach.country.extension:countryCode.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. | ||||
| 360. Patient.address:Postfach.country.extension:countryCode.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 | ||||
| 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 Patient.address.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 362. Patient.address:Postfach.country.extension:countryCode.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://hl7.org/fhir/StructureDefinition/iso21090-codedString | ||||
| 364. Patient.address:Postfach.country.extension:countryCode.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 | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from Iso3166-1-2 (required to http://hl7.org/fhir/ValueSet/iso3166-1-2)A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. | ||||
| Type | Coding | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 366. Patient.address:Postfach.country.value | |||||
| Definition | Primitive value for string | ||||
| Short | Primitive value for string | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Max Length: | 1048576 | ||||
| 368. Patient.address:Postfach.period | |||||
| Definition | Time period when address was/is in use. | ||||
| Short | Time period when address was/is in 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 | ||||
| Summary | true | ||||
| Requirements | Allows addresses to be placed in historical context. | ||||
| Example | General: { "start" : "2010-03-23", "end" : "2010-07-01" } | ||||
| 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)) | ||||
| 370. Patient.maritalStatus | |||||
| Definition | This field contains a patient's most recent marital (civil) status. | ||||
| Short | Marital (civil) status of a patient | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Marital Status Codes (extensible to http://hl7.org/fhir/ValueSet/marital-status|4.0.1)The domestic partnership status of a person. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Most, if not all systems capture it. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 372. Patient.multipleBirth[x] | |||||
| Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). | ||||
| Short | Whether patient is part of a multiple birth | ||||
| Comments | Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). | ||||
| Control | 0..1 | ||||
| Type | Choice of: boolean, integer | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 374. Patient.photo | |||||
| Definition | Image of the patient. | ||||
| Short | Image of the patient | ||||
| Comments | Guidelines:
| ||||
| Control | 0..* | ||||
| Type | Attachment | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 376. Patient.contact | |||||
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||
| Short | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| Comments | Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Need to track people you can contact about the patient. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))pat-1: SHALL at least contain a contact's details or a reference to an organization ( name.exists() or telecom.exists() or address.exists() or organization.exists()) | ||||
| 378. Patient.contact.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 | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 380. Patient.contact.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..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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()) | ||||
| 382. Patient.contact.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..* | ||||
| 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()) | ||||
| 384. Patient.contact.relationship | |||||
| Definition | The nature of the relationship between the patient and the contact person. | ||||
| Short | The kind of relationship | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from PatientContactRelationship (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1)The nature of the relationship between a patient and a contact person for that patient. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 386. Patient.contact.name | |||||
| Definition | A name associated with the contact person. | ||||
| Short | A name associated with the contact person | ||||
| Control | 0..1 | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 388. Patient.contact.telecom | |||||
| Definition | A contact detail for the person, e.g. a telephone number or an email address. | ||||
| Short | A contact detail for the person | ||||
| Comments | Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 390. Patient.contact.address | |||||
| Definition | Address for the contact person. | ||||
| Short | Address for the contact person | ||||
| Control | 0..1 | ||||
| Type | Address | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 392. Patient.contact.gender | |||||
| Definition | Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. | ||||
| Short | male | female | other | unknown | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)The gender of a person used for administrative purposes. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | Needed to address the person correctly. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 394. Patient.contact.organization | |||||
| Definition | Organization on behalf of which the contact is acting or for which the contact is working. | ||||
| Short | Organization that is associated with the contact | ||||
| Control | 0..1 This element is affected by the following invariants: pat-1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | For guardians or business related contacts, the organization is relevant. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 396. Patient.contact.period | |||||
| Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. | ||||
| Short | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 398. Patient.communication | |||||
| Definition | A language which may be used to communicate with the patient about his or her health. | ||||
| Short | A language which may be used to communicate with the patient about his or her health | ||||
| Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 400. Patient.communication.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 | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 402. Patient.communication.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..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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()) | ||||
| 404. Patient.communication.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..* | ||||
| 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()) | ||||
| 406. Patient.communication.language | |||||
| Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. | ||||
| Short | The language which can be used to communicate with the patient about his or her health | ||||
| Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 408. Patient.communication.preferred | |||||
| Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). | ||||
| Short | Language preference indicator | ||||
| Comments | This language is specifically identified for communicating healthcare information. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 410. Patient.generalPractitioner | |||||
| Definition | Patient's nominated care provider. | ||||
| Short | Patient's nominated primary care provider | ||||
| Comments | This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. | ||||
| Control | 0..* | ||||
| Type | Reference(Organization, Practitioner, PractitionerRole) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | careProvider | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 412. Patient.managingOrganization | |||||
| Definition | Organization that is the custodian of the patient record. | ||||
| Short | Organization that is the custodian of the patient record | ||||
| Comments | There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Need to know who recognizes this patient record, manages and updates it. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 414. Patient.link | |||||
| Definition | Link to another patient resource that concerns the same actual patient. | ||||
| Short | Link | ||||
| Comments | Dieses und untergeordnete Elemente KÖNNEN bei einem erfolgten Patient merge entsprechend der Festlegungen unter Patient-merge befüllt werden. Da das Element der Unterstützung der Patient merge Notification dient, MUSS es im Rahmen des Bestätigungsverfahrens NICHT unterstützt werden (Stand: Stufe 4). | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | true because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by' | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are multiple use cases:
| ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 416. Patient.link.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 | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 418. Patient.link.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..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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()) | ||||
| 420. Patient.link.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..* | ||||
| 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()) | ||||
| 422. Patient.link.other | |||||
| Definition | The other patient resource that the link refers to. | ||||
| Short | The other patient or related person resource that the link refers to | ||||
| Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. | ||||
| Control | 1..1 | ||||
| Type | Reference(Patient, RelatedPerson) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 424. Patient.link.other.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 | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 426. Patient.link.other.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..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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 Patient.link.other.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 428. Patient.link.other.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 430. Patient.link.other.type | |||||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
| Short | Type the reference refers to (e.g. "Patient") | ||||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)Aa resource (or, for logical models, the URI of the logical model). | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 432. Patient.link.other.identifier | |||||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | Logischer Verweis auf Identifier[Patientennummer] | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| 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())) | ||||
| 434. Patient.link.other.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 436. Patient.link.type | |||||
| Definition | The type of link between this patient resource and another patient resource. | ||||
| Short | replaced-by | replaces | refer | seealso | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from LinkType (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)The type of link between this patient resource and another patient resource. | ||||
| 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 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||