NameInformation
CBB | Status | URL |
---|---|---|
HdBe-NameInformation | draft | https://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-NameInformation |
name_information | name_information | ||
first_names | 0..1 | string | |
initials | 0..1 | string | |
given_name | 0..1 | string | |
name_usage | 0..1 | CodeableConceptBinding | |
last_name | 0..1 | BackboneElement | |
prefix | 0..1 | string | |
last_name | 1..1 | string | |
last_name_partner | 0..1 | BackboneElement | |
partner_prefix | 0..1 | string | |
partner_last_name | 1..1 | string | |
titles | 0..1 | string |
name_information | 0..* | |
name_information.first_names | string | 0..1 |
name_information.initials | string | 0..1 |
name_information.given_name | string | 0..1 |
name_information.name_usage | CodeableConcept | 0..1 |
name_information.last_name | BackboneElement | 0..1 |
name_information.last_name.prefix | string | 0..1 |
name_information.last_name.last_name | string | 1..1 |
name_information.last_name_partner | BackboneElement | 0..1 |
name_information.last_name_partner.partner_prefix | string | 0..1 |
name_information.last_name_partner.partner_last_name | string | 1..1 |
name_information.titles | string | 0..1 |
name_information | |
Definition | Root concept of the NameInformation partial information model. This root concept contains all data elements of the NameInformation partial information model. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
name_information.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
name_information.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
name_information.first_names | |
Definition | The person’s official first names. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
name_information.initials | |
Definition | The person’s initials. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
name_information.given_name | |
Definition | The name normally used to address the person. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
name_information.name_usage | |
Definition | This concept indicates the last name or order of last names with which the person is to be addressed. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | NameUsage codes NameUsage (required) |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
name_information.last_name | |
Definition | Container of the LastName concept. This container contains all data elements of the LastName concept. |
Cardinality | 0...1 |
Type | BackboneElement |
Comments |
|
Invariants |
|
Mappings |
|
name_information.last_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. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
name_information.last_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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
name_information.last_name.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
name_information.last_name.prefix | |
Definition | Prefix to the person’s own last name. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
name_information.last_name.last_name | |
Definition | The person’s official last name. Preferrably, the last name prefix is captured using the `.prefix` element. It may however be included here for systems that do not record this separately. |
Cardinality | 1...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
name_information.last_name_partner | |
Definition | Container of the LastNamePartner concept. This container contains all data elements of the LastNamePartner concept. |
Cardinality | 0...1 |
Type | BackboneElement |
Comments |
|
Invariants |
|
Mappings |
|
name_information.last_name_partner.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
name_information.last_name_partner.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
name_information.last_name_partner.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
name_information.last_name_partner.partner_prefix | |
Definition | Prefix to the partner’s last name. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
name_information.last_name_partner.partner_last_name | |
Definition | Partner’s official last name. Preferrably, the partner' last name prefix is captured using the `.partner_prefix` element. It may however be included here for systems that do not record this separately. |
Cardinality | 1...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
name_information.titles | |
Definition | Noble and scientific titles. These can assist in formulating oral and formal addresing titles. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Example instances
name_information | |
---|---|
first_names | Johanna Petronella Maria |
initials | J.P.M. |
given_name | Jo |
name_usage | Eigen familienaam gevolgd door familienaam partner |
last_name.prefix | Van |
last_name.last_name | Putten |
last_name_partner.partner_prefix | van der |
last_name_partner.partner_last_name | Giessen |
titles |
zib NameInformation-v1.1 difference
Concept | Category | Description |
---|---|---|
name_usage |
textual | Renamed Geslachtsnaam to Familienaam in example. |
name_usage |
terminology | Renamed Geslachtsnaam to Familienaam in ValueSet-NameUsage. |
last_name |
textual | Renamed Geslachtsnaam to Familienaam. |
last_name.last_name |
textual | Added textual guidance that it is allowed to include .prefix in the .last_name for systems that do not record the prefix sperately, which is common in Belgium. |
last_name_partner |
textual | Renamed GeslachtsnaamPartner to FamilienaamPartner. |
last_name_partner.last_name_partner |
textual | Added textual guidance that it is allowed to include .partner_prefix in the .partner_last_name for systems that do not record the prefix sperately, which is common in Belgium. |
Terminology Bindings
Path | Name | Strength | URL |
---|---|---|---|
name_usage | NameUsage | required | https://fhir.healthdata.be/ValueSet/NameUsage |