NameInformation

CBBStatusURL
HdBe-NameInformationdrafthttps://fhir.healthdata.be/StructureDefinition/LogicalModel/HdBe-NameInformation

first_names0..1string
initials0..1string
given_name0..1string
name_usage0..1CodeableConceptBinding
prefix0..1string
last_name1..1string
partner_prefix0..1string
partner_last_name1..1string
titles0..1string

name_information0..*
name_information.first_namesstring0..1
name_information.initialsstring0..1
name_information.given_namestring0..1
name_information.name_usageCodeableConcept0..1
name_information.last_nameBackboneElement0..1
name_information.last_name.prefixstring0..1
name_information.last_name.last_namestring1..1
name_information.last_name_partnerBackboneElement0..1
name_information.last_name_partner.partner_prefixstring0..1
name_information.last_name_partner.partner_last_namestring1..1
name_information.titlesstring0..1



name_information
DefinitionRoot concept of the NameInformation partial information model. This root concept contains all data elements of the NameInformation partial information model.
Cardinality0...*
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
name_information.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
name_information.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim:n/a
  • rim:N/A
name_information.first_names
DefinitionThe person’s official first names.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
name_information.initials
DefinitionThe person’s initials.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
name_information.given_name
DefinitionThe name normally used to address the person.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
name_information.name_usage
DefinitionThis concept indicates the last name or order of last names with which the person is to be addressed.
Cardinality0...1
TypeCodeableConcept
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
name_information.last_name
DefinitionContainer of the LastName concept. This container contains all data elements of the LastName concept.
Cardinality0...1
TypeBackboneElement
Comments
  • 0..1 The person’s own last name or partner’s last name must be entered. Entering both is also allowed.
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
name_information.last_name.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
name_information.last_name.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim:n/a
  • rim:N/A
name_information.last_name.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • 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()
Mappings
  • rim:n/a
  • rim:N/A
name_information.last_name.prefix
DefinitionPrefix to the person’s own last name.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
name_information.last_name.last_name
DefinitionThe 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.
Cardinality1...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
name_information.last_name_partner
DefinitionContainer of the LastNamePartner concept. This container contains all data elements of the LastNamePartner concept.
Cardinality0...1
TypeBackboneElement
Comments
  • 0..1 The person’s own last name or partner’s last name must be entered. Entering both is also allowed.
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
name_information.last_name_partner.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
TypeSystem.String
Mappings
  • rim:n/a
name_information.last_name_partner.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim:n/a
  • rim:N/A
name_information.last_name_partner.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • 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()
Mappings
  • rim:n/a
  • rim:N/A
name_information.last_name_partner.partner_prefix
DefinitionPrefix to the partner’s last name.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
name_information.last_name_partner.partner_last_name
DefinitionPartner’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.
Cardinality1...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
name_information.titles
DefinitionNoble and scientific titles. These can assist in formulating oral and formal addresing titles.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a

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

PathNameStrengthURL
name_usageNameUsagerequiredhttps://fhir.healthdata.be/ValueSet/NameUsage