HdBe-NameInformation

Profile	Description	Status	URL
HdBe-NameInformation	Name information includes a person's given names, nickname, last name and possibly the partner's last name.	draft	https://fhir.healthdata.be/StructureDefinition/HdBe-NameInformation

Instructions

Instructions
This datatype defines a common basis for expressing all name information around the world, but adds extensions to express names specifically, according to the CBB NameInformation. A CBB NameInformation name still is a proper FHIR HumanName, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. To have true compatibility an implementer SHOULD use the core HumanName parts as intended. The implementer SHOULD in addition use the extension elements. Furthermore, it is encouraged to provide a representation of the full name in the `HumanName.text` element. Separate name parts The extension elements cover birth name (NL: achternaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around. For this reason, there are extensions for marking each part for what it is. Example: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas. `family` = "Jongeneel-de Haas" `given` = "Irma" `family.extension:lastName` = "Jongeneel" `family.extension:partnerPrefix` = "de " `family.extension:partnerLastName` = "Haas" The `HumanName.use` element The use of element `HumanName.use` is discouraged because the CBB model does not contain a corresponding concept. If `.use` is populated, its value SHALL match the semantics of the other elements. To illustrate: if `.use` is set to official, it is not expected that the zib concept 'GivenName' (NL: roepnaam) is populated because this is not part of an official name. If the `.use` element is populated, it is likely that a full name can only be communicated using multiple instances of this profile, one for each purpose of `.use`. Receiving systems SHOULD be able to handle multiple instances of this datatype profile in an instance. The CBB concept 'titles' The CBB concept 'titles' for noble and scientific titles cannot be fully mapped to FHIR. Sending systems should make an effort to provide title information in the best way possible using the `.prefix` and `.suffix` elements conform the definition of FHIR. However, if it is not possible to break down the titles properly, it can be communicated as-is using the `.prefix` element . Receiving systems should be resilient for a broader range of information in the `.prefix` element than stated by its definition. See the guidance on the `.prefix` and `.suffix` elements for more information.

This datatype defines a common basis for expressing all name information around the world, but adds extensions to express names specifically, according to the CBB NameInformation. A CBB NameInformation name still is a proper FHIR HumanName, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype.

To have true compatibility an implementer SHOULD use the core HumanName parts as intended. The implementer SHOULD in addition use the extension elements. Furthermore, it is encouraged to provide a representation of the full name in the HumanName.text element.

Separate name parts The extension elements cover birth name (NL: achternaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around. For this reason, there are extensions for marking each part for what it is.

Example: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas.

family = "Jongeneel-de Haas"
given = "Irma"
family.extension:lastName = "Jongeneel"
family.extension:partnerPrefix = "de "
family.extension:partnerLastName = "Haas"

The HumanName.use element

The use of element HumanName.use is discouraged because the CBB model does not contain a corresponding concept. If .use is populated, its value SHALL match the semantics of the other elements. To illustrate: if .use is set to official, it is not expected that the zib concept 'GivenName' (NL: roepnaam) is populated because this is not part of an official name.

If the .use element is populated, it is likely that a full name can only be communicated using multiple instances of this profile, one for each purpose of .use. Receiving systems SHOULD be able to handle multiple instances of this datatype profile in an instance.

The CBB concept 'titles'

The CBB concept 'titles' for noble and scientific titles cannot be fully mapped to FHIR. Sending systems should make an effort to provide title information in the best way possible using the .prefix and .suffix elements conform the definition of FHIR. However, if it is not possible to break down the titles properly, it can be communicated as-is using the .prefix element . Receiving systems should be resilient for a broader range of information in the .prefix element than stated by its definition. See the guidance on the .prefix and .suffix elements for more information.

HumanName	I		HumanName	Element Id HumanName Short description NameInformation Alternate names Naamgegevens Definition Name information includes a person's given names, nickname, last name and possibly the partner's last name. Comments This datatype defines a common basis for expressing all name information around the world, but adds extensions to express names specifically, according to the CBB NameInformation. A CBB NameInformation name still is a proper FHIR HumanName, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. To have true compatibility an implementer SHOULD use the core HumanName parts as intended. The implementer SHOULD in addition use the extension elements. Furthermore, it is encouraged to provide a representation of the full name in the `HumanName.text` element. Separate name parts The extension elements cover birth name (NL: achternaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around. For this reason, there are extensions for marking each part for what it is. Example: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas. `family` = "Jongeneel-de Haas" `given` = "Irma" `family.extension:lastName` = "Jongeneel" `family.extension:partnerPrefix` = "de " `family.extension:partnerLastName` = "Haas" The `HumanName.use` element The use of element `HumanName.use` is discouraged because the CBB model does not contain a corresponding concept. If `.use` is populated, its value SHALL match the semantics of the other elements. To illustrate: if `.use` is set to official, it is not expected that the zib concept 'GivenName' (NL: roepnaam) is populated because this is not part of an official name. If the `.use` element is populated, it is likely that a full name can only be communicated using multiple instances of this profile, one for each purpose of `.use`. Receiving systems SHOULD be able to handle multiple instances of this datatype profile in an instance. The CBB concept 'titles' The CBB concept 'titles' for noble and scientific titles cannot be fully mapped to FHIR. Sending systems should make an effort to provide title information in the best way possible using the `.prefix` and `.suffix` elements conform the definition of FHIR. However, if it is not possible to break down the titles properly, it can be communicated as-is using the `.prefix` element . Receiving systems should be resilient for a broader range of information in the `.prefix` element than stated by its definition. See the guidance on the `.prefix` and `.suffix` elements for more information. Data Type HumanName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a familiy name is specified, the family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2:If the prefix for a partner family name is specified, the partner family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` zib-NameInformation-3:If the name is specified as 'official' then the name is expected to contain only official parts `use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()` Examples Structured HumanName (preferred above unstructured) { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "text": "Irma Jongeneel-de Haas", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } Unstructured HumanName { "text": "Irma Jongeneel-de Haas" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName zib-nameinformation-v1.1-2020EN:NL-CM:20.4.1 HdBe-NameInformation:name_information
extension	I	0..*	Extension	Element Id HumanName.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
humannameAssemblyOrder	I	0..1	Extension(code)	Element Id HumanName.extension:humannameAssemblyOrder Short description Preferred display order of name parts Alternate names extensions, user content Definition A code that represents the preferred display order of the components of this human name. 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. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Constraints 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
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.extension:humannameAssemblyOrder.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Mappings rim:N/A
value[x]		1..1	Binding	Element Id HumanName.extension:humannameAssemblyOrder.value[x] Short description NameUsage Alternate names Naamgebruik, Voorkeursvolgorde van de naamdelen Definition This concept indicates the last name or order of last names with which the person is to be addressed. Binding Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder HumanNameAssemblyOrder (required) Permitted Values NameUsage_to_HumanNameAssemblyOrder Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.7 HdBe-NameInformation:name_usage
valueCode			code	There are no (further) constraints on this element Data Type code
use	Σ ?!	0..1	codeBinding	Element Id HumanName.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments This use of this element is discouraged because the CBB model does not contain a corresponding concept. If `use` is provided, it SHOULD align with the semantics of the other elements. To illustrate: if `use` is official it is not expected that the concept 'GivenName' (NL: roepnaam) is present in the HumanName container because this is not part of an official name. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose
text	Σ	0..1	string	There are no (further) constraints on this element Element Id HumanName.text Short description Text representation of the full name 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. Requirements A renderable, unencoded form. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	Σ	0..1	string	There are no (further) constraints on this element Element Id HumanName.family Short description Family name (often called 'Surname') Alternate names surname Definition 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. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName
extension	I	0..*	Extension	Element Id HumanName.family.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
prefix	I	0..1	Extension(string)	Element Id HumanName.family.extension:prefix Short description Voorvoegsel derived from person's own surname Alternate names extensions, user content 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. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Constraints 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 v2:FN.2 rim:ENXP where Qualifiers = (VV, R)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.family.extension:prefix.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Mappings rim:N/A
value[x]		1..1		Element Id HumanName.family.extension:prefix.value[x] Short description Prefix Alternate names Voorvoegsels Definition Prefix to the person’s own last name if not provided in LastName. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.11 HdBe-NameInformation:last_name.prefix
valueString			string	There are no (further) constraints on this element Data Type string
lastName	I	0..1	Extension(string)	Element Id HumanName.family.extension:lastName Short description Portion derived from person's own surname Alternate names extensions, user content 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. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-name Constraints 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 v2:FN.3 rim:ENXP where Qualifiers = (BR)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.family.extension:lastName.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-own-name Mappings rim:N/A
value[x]		1..1		Element Id HumanName.family.extension:lastName.value[x] Short description LastName Alternate names Achternaam Definition The person’s official last name. Preferrably, the last name prefix is captured using the `prefix` extension. It may however be included here for systems that do not record this separately. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.10 HdBe-NameInformation:last_name.last_name
valueString			string	There are no (further) constraints on this element Data Type string
partnerPrefix	I	0..1	Extension(string)	Element Id HumanName.family.extension:partnerPrefix Short description Voorvoegsel derived from person's partner's surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix Constraints 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 v2:FN.4 rim:ENXP where Qualifiers = (VV, SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.family.extension:partnerPrefix.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix Mappings rim:N/A
value[x]		1..1		Element Id HumanName.family.extension:partnerPrefix.value[x] Short description PartnerPrefix Alternate names VoorvoegselsPartner Definition Prefix to the partner’s last name if not provided in PartnerLastName. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.9 HdBe-NameInformation:last_name_partner.partner_prefix
valueString			string	There are no (further) constraints on this element Data Type string
partnerLastName	I	0..1	Extension(string)	Element Id HumanName.family.extension:partnerLastName Short description Portion derived from person's partner's surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-name Constraints 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 v2:FN.5 rim:ENXP where Qualifiers = (SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.family.extension:partnerLastName.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-partner-name Mappings rim:N/A
value[x]		1..1		Element Id HumanName.family.extension:partnerLastName.value[x] Short description PartnerLastName Alternate names AchternaamPartner Definition Partner’s official last name. Preferrably, the partner' last name prefix is captured using the `partnerPrefix` extension. It may however be included here for systems that do not record this separately. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.8 HdBe-NameInformation:last_name_partner.partner_last_name
valueString			string	There are no (further) constraints on this element Data Type string
given	Σ	0..*	string	Element Id HumanName.given Short description Given names (not always 'first'). Includes middle names Alternate names first name, middle name Definition Given name. Comments To be conformant to the CBB for NameInformation, at least the following 'ISO 21090 EN Qualifiers' SHALL be supported: BR, IN and CL. The qualifier BR maps to the CBB concept FirstNames, IN maps to Initials and CL to GivenName. Data Type string Sliced: Unordered, Open, by extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').value(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames
firstNames	Σ	0..1	string	Element Id HumanName.given:firstNames Short description FirstNames Alternate names first name, middle name, Voornamen Definition The person’s official first 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.4 HdBe-NameInformation:first_names
extension	I	1..*	Extension	Element Id HumanName.given:firstNames.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
iso21090EnQualifier	I	1..1	Extension(code)	Element Id HumanName.given:firstNames.extension:iso21090EnQualifier Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints 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 rim:ENXP.qualifier
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.given:firstNames.extension:iso21090EnQualifier.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Mappings rim:N/A
value[x]		1..1	Binding	Element Id HumanName.given:firstNames.extension:iso21090EnQualifier.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. EntityNamePartQualifier (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern BR Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
initials	Σ	0..1	string	Element Id HumanName.given:initials Short description Initials Alternate names first name, middle name, Initialen Definition The person’s initials. Comments Each initial is expected to be delimited by a dot. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.5 HdBe-NameInformation:initials
extension	I	1..*	Extension	Element Id HumanName.given:initials.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
iso21090EnQualifier	I	1..1	Extension(code)	Element Id HumanName.given:initials.extension:iso21090EnQualifier Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints 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 rim:ENXP.qualifier
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.given:initials.extension:iso21090EnQualifier.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Mappings rim:N/A
value[x]		1..1	Binding	Element Id HumanName.given:initials.extension:iso21090EnQualifier.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. EntityNamePartQualifier (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern IN Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
givenName	Σ	0..1	string	Element Id HumanName.given:givenName Short description GivenName Alternate names first name, middle name, Roepnaam Definition The name normally used to address the person. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.6 HdBe-NameInformation:given_name
extension	I	1..*	Extension	Element Id HumanName.given:givenName.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
iso21090EnQualifier	I	1..1	Extension(code)	Element Id HumanName.given:givenName.extension:iso21090EnQualifier Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints 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 rim:ENXP.qualifier
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.given:givenName.extension:iso21090EnQualifier.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Mappings rim:N/A
value[x]		1..1	Binding	Element Id HumanName.given:givenName.extension:iso21090EnQualifier.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. EntityNamePartQualifier (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern CL Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
prefix	Σ	0..*	string	Element Id HumanName.prefix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:titles
suffix	Σ	0..*	string	Element Id HumanName.suffix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX] zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:titles
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id HumanName.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. 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. Data Type Period Constraints 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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate

HumanName	I		HumanName	Element Id HumanName Short description NameInformation Alternate names Naamgegevens Definition Name information includes a person's given names, nickname, last name and possibly the partner's last name. Comments This datatype defines a common basis for expressing all name information around the world, but adds extensions to express names specifically, according to the CBB NameInformation. A CBB NameInformation name still is a proper FHIR HumanName, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. To have true compatibility an implementer SHOULD use the core HumanName parts as intended. The implementer SHOULD in addition use the extension elements. Furthermore, it is encouraged to provide a representation of the full name in the `HumanName.text` element. Separate name parts The extension elements cover birth name (NL: achternaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around. For this reason, there are extensions for marking each part for what it is. Example: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas. `family` = "Jongeneel-de Haas" `given` = "Irma" `family.extension:lastName` = "Jongeneel" `family.extension:partnerPrefix` = "de " `family.extension:partnerLastName` = "Haas" The `HumanName.use` element The use of element `HumanName.use` is discouraged because the CBB model does not contain a corresponding concept. If `.use` is populated, its value SHALL match the semantics of the other elements. To illustrate: if `.use` is set to official, it is not expected that the zib concept 'GivenName' (NL: roepnaam) is populated because this is not part of an official name. If the `.use` element is populated, it is likely that a full name can only be communicated using multiple instances of this profile, one for each purpose of `.use`. Receiving systems SHOULD be able to handle multiple instances of this datatype profile in an instance. The CBB concept 'titles' The CBB concept 'titles' for noble and scientific titles cannot be fully mapped to FHIR. Sending systems should make an effort to provide title information in the best way possible using the `.prefix` and `.suffix` elements conform the definition of FHIR. However, if it is not possible to break down the titles properly, it can be communicated as-is using the `.prefix` element . Receiving systems should be resilient for a broader range of information in the `.prefix` element than stated by its definition. See the guidance on the `.prefix` and `.suffix` elements for more information. Data Type HumanName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a familiy name is specified, the family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2:If the prefix for a partner family name is specified, the partner family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` zib-NameInformation-3:If the name is specified as 'official' then the name is expected to contain only official parts `use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()` Examples Structured HumanName (preferred above unstructured) { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "text": "Irma Jongeneel-de Haas", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } Unstructured HumanName { "text": "Irma Jongeneel-de Haas" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName zib-nameinformation-v1.1-2020EN:NL-CM:20.4.1 HdBe-NameInformation:name_information
extension	I	0..*	Extension	Element Id HumanName.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
humannameAssemblyOrder	I	0..1	Extension(code)	Element Id HumanName.extension:humannameAssemblyOrder Short description Preferred display order of name parts Alternate names extensions, user content Definition A code that represents the preferred display order of the components of this human name. 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. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Constraints 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
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.extension:humannameAssemblyOrder.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Mappings rim:N/A
value[x]		1..1	Binding	Element Id HumanName.extension:humannameAssemblyOrder.value[x] Short description NameUsage Alternate names Naamgebruik, Voorkeursvolgorde van de naamdelen Definition This concept indicates the last name or order of last names with which the person is to be addressed. Binding Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder HumanNameAssemblyOrder (required) Permitted Values NameUsage_to_HumanNameAssemblyOrder Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.7 HdBe-NameInformation:name_usage
valueCode			code	There are no (further) constraints on this element Data Type code
use	Σ ?!	0..1	codeBinding	Element Id HumanName.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments This use of this element is discouraged because the CBB model does not contain a corresponding concept. If `use` is provided, it SHOULD align with the semantics of the other elements. To illustrate: if `use` is official it is not expected that the concept 'GivenName' (NL: roepnaam) is present in the HumanName container because this is not part of an official name. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose
text	Σ	0..1	string	There are no (further) constraints on this element Element Id HumanName.text Short description Text representation of the full name 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. Requirements A renderable, unencoded form. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	Σ	0..1	string	There are no (further) constraints on this element Element Id HumanName.family Short description Family name (often called 'Surname') Alternate names surname Definition 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. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName
extension	I	0..*	Extension	Element Id HumanName.family.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
prefix	I	0..1	Extension(string)	Element Id HumanName.family.extension:prefix Short description Voorvoegsel derived from person's own surname Alternate names extensions, user content 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. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Constraints 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 v2:FN.2 rim:ENXP where Qualifiers = (VV, R)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.family.extension:prefix.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Mappings rim:N/A
value[x]		1..1		Element Id HumanName.family.extension:prefix.value[x] Short description Prefix Alternate names Voorvoegsels Definition Prefix to the person’s own last name if not provided in LastName. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.11 HdBe-NameInformation:last_name.prefix
valueString			string	There are no (further) constraints on this element Data Type string
lastName	I	0..1	Extension(string)	Element Id HumanName.family.extension:lastName Short description Portion derived from person's own surname Alternate names extensions, user content 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. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-name Constraints 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 v2:FN.3 rim:ENXP where Qualifiers = (BR)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.family.extension:lastName.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-own-name Mappings rim:N/A
value[x]		1..1		Element Id HumanName.family.extension:lastName.value[x] Short description LastName Alternate names Achternaam Definition The person’s official last name. Preferrably, the last name prefix is captured using the `prefix` extension. It may however be included here for systems that do not record this separately. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.10 HdBe-NameInformation:last_name.last_name
valueString			string	There are no (further) constraints on this element Data Type string
partnerPrefix	I	0..1	Extension(string)	Element Id HumanName.family.extension:partnerPrefix Short description Voorvoegsel derived from person's partner's surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix Constraints 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 v2:FN.4 rim:ENXP where Qualifiers = (VV, SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.family.extension:partnerPrefix.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix Mappings rim:N/A
value[x]		1..1		Element Id HumanName.family.extension:partnerPrefix.value[x] Short description PartnerPrefix Alternate names VoorvoegselsPartner Definition Prefix to the partner’s last name if not provided in PartnerLastName. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.9 HdBe-NameInformation:last_name_partner.partner_prefix
valueString			string	There are no (further) constraints on this element Data Type string
partnerLastName	I	0..1	Extension(string)	Element Id HumanName.family.extension:partnerLastName Short description Portion derived from person's partner's surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-name Constraints 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 v2:FN.5 rim:ENXP where Qualifiers = (SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.family.extension:partnerLastName.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-partner-name Mappings rim:N/A
value[x]		1..1		Element Id HumanName.family.extension:partnerLastName.value[x] Short description PartnerLastName Alternate names AchternaamPartner Definition Partner’s official last name. Preferrably, the partner' last name prefix is captured using the `partnerPrefix` extension. It may however be included here for systems that do not record this separately. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.8 HdBe-NameInformation:last_name_partner.partner_last_name
valueString			string	There are no (further) constraints on this element Data Type string
given	Σ	0..*	string	Element Id HumanName.given Short description Given names (not always 'first'). Includes middle names Alternate names first name, middle name Definition Given name. Comments To be conformant to the CBB for NameInformation, at least the following 'ISO 21090 EN Qualifiers' SHALL be supported: BR, IN and CL. The qualifier BR maps to the CBB concept FirstNames, IN maps to Initials and CL to GivenName. Data Type string Sliced: Unordered, Open, by extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').value(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames
firstNames	Σ	0..1	string	Element Id HumanName.given:firstNames Short description FirstNames Alternate names first name, middle name, Voornamen Definition The person’s official first 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.4 HdBe-NameInformation:first_names
extension	I	1..*	Extension	Element Id HumanName.given:firstNames.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
iso21090EnQualifier	I	1..1	Extension(code)	Element Id HumanName.given:firstNames.extension:iso21090EnQualifier Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints 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 rim:ENXP.qualifier
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.given:firstNames.extension:iso21090EnQualifier.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Mappings rim:N/A
value[x]		1..1	Binding	Element Id HumanName.given:firstNames.extension:iso21090EnQualifier.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. EntityNamePartQualifier (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern BR Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
initials	Σ	0..1	string	Element Id HumanName.given:initials Short description Initials Alternate names first name, middle name, Initialen Definition The person’s initials. Comments Each initial is expected to be delimited by a dot. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.5 HdBe-NameInformation:initials
extension	I	1..*	Extension	Element Id HumanName.given:initials.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
iso21090EnQualifier	I	1..1	Extension(code)	Element Id HumanName.given:initials.extension:iso21090EnQualifier Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints 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 rim:ENXP.qualifier
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.given:initials.extension:iso21090EnQualifier.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Mappings rim:N/A
value[x]		1..1	Binding	Element Id HumanName.given:initials.extension:iso21090EnQualifier.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. EntityNamePartQualifier (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern IN Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
givenName	Σ	0..1	string	Element Id HumanName.given:givenName Short description GivenName Alternate names first name, middle name, Roepnaam Definition The name normally used to address the person. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.6 HdBe-NameInformation:given_name
extension	I	1..*	Extension	Element Id HumanName.given:givenName.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
iso21090EnQualifier	I	1..1	Extension(code)	Element Id HumanName.given:givenName.extension:iso21090EnQualifier Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints 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 rim:ENXP.qualifier
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.given:givenName.extension:iso21090EnQualifier.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Mappings rim:N/A
value[x]		1..1	Binding	Element Id HumanName.given:givenName.extension:iso21090EnQualifier.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. EntityNamePartQualifier (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern CL Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
prefix	Σ	0..*	string	Element Id HumanName.prefix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:titles
suffix	Σ	0..*	string	Element Id HumanName.suffix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX] zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:titles
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id HumanName.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. 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. Data Type Period Constraints 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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate

HumanName	I		HumanName	Element Id HumanName Short description NameInformation Alternate names Naamgegevens Definition Name information includes a person's given names, nickname, last name and possibly the partner's last name. Comments This datatype defines a common basis for expressing all name information around the world, but adds extensions to express names specifically, according to the CBB NameInformation. A CBB NameInformation name still is a proper FHIR HumanName, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. To have true compatibility an implementer SHOULD use the core HumanName parts as intended. The implementer SHOULD in addition use the extension elements. Furthermore, it is encouraged to provide a representation of the full name in the `HumanName.text` element. Separate name parts The extension elements cover birth name (NL: achternaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around. For this reason, there are extensions for marking each part for what it is. Example: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas. `family` = "Jongeneel-de Haas" `given` = "Irma" `family.extension:lastName` = "Jongeneel" `family.extension:partnerPrefix` = "de " `family.extension:partnerLastName` = "Haas" The `HumanName.use` element The use of element `HumanName.use` is discouraged because the CBB model does not contain a corresponding concept. If `.use` is populated, its value SHALL match the semantics of the other elements. To illustrate: if `.use` is set to official, it is not expected that the zib concept 'GivenName' (NL: roepnaam) is populated because this is not part of an official name. If the `.use` element is populated, it is likely that a full name can only be communicated using multiple instances of this profile, one for each purpose of `.use`. Receiving systems SHOULD be able to handle multiple instances of this datatype profile in an instance. The CBB concept 'titles' The CBB concept 'titles' for noble and scientific titles cannot be fully mapped to FHIR. Sending systems should make an effort to provide title information in the best way possible using the `.prefix` and `.suffix` elements conform the definition of FHIR. However, if it is not possible to break down the titles properly, it can be communicated as-is using the `.prefix` element . Receiving systems should be resilient for a broader range of information in the `.prefix` element than stated by its definition. See the guidance on the `.prefix` and `.suffix` elements for more information. Data Type HumanName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a familiy name is specified, the family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2:If the prefix for a partner family name is specified, the partner family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` zib-NameInformation-3:If the name is specified as 'official' then the name is expected to contain only official parts `use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()` Examples Structured HumanName (preferred above unstructured) { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "text": "Irma Jongeneel-de Haas", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } Unstructured HumanName { "text": "Irma Jongeneel-de Haas" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName zib-nameinformation-v1.1-2020EN:NL-CM:20.4.1 HdBe-NameInformation:name_information
extension	I	0..*	Extension	Element Id HumanName.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
humannameAssemblyOrder	I	0..1	Extension(code)	Element Id HumanName.extension:humannameAssemblyOrder Short description Preferred display order of name parts Alternate names extensions, user content Definition A code that represents the preferred display order of the components of this human name. 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. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Constraints 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
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.extension:humannameAssemblyOrder.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Mappings rim:N/A
value[x]		1..1	Binding	Element Id HumanName.extension:humannameAssemblyOrder.value[x] Short description NameUsage Alternate names Naamgebruik, Voorkeursvolgorde van de naamdelen Definition This concept indicates the last name or order of last names with which the person is to be addressed. Binding Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder HumanNameAssemblyOrder (required) Permitted Values NameUsage_to_HumanNameAssemblyOrder Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.7 HdBe-NameInformation:name_usage
valueCode			code	There are no (further) constraints on this element Data Type code
use	Σ ?!	0..1	codeBinding	Element Id HumanName.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments This use of this element is discouraged because the CBB model does not contain a corresponding concept. If `use` is provided, it SHOULD align with the semantics of the other elements. To illustrate: if `use` is official it is not expected that the concept 'GivenName' (NL: roepnaam) is present in the HumanName container because this is not part of an official name. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose
text	Σ	0..1	string	There are no (further) constraints on this element Element Id HumanName.text Short description Text representation of the full name 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. Requirements A renderable, unencoded form. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	Σ	0..1	string	There are no (further) constraints on this element Element Id HumanName.family Short description Family name (often called 'Surname') Alternate names surname Definition 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. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName
extension	I	0..*	Extension	Element Id HumanName.family.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
prefix	I	0..1	Extension(string)	Element Id HumanName.family.extension:prefix Short description Voorvoegsel derived from person's own surname Alternate names extensions, user content 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. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Constraints 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 v2:FN.2 rim:ENXP where Qualifiers = (VV, R)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.family.extension:prefix.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Mappings rim:N/A
value[x]		1..1		Element Id HumanName.family.extension:prefix.value[x] Short description Prefix Alternate names Voorvoegsels Definition Prefix to the person’s own last name if not provided in LastName. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.11 HdBe-NameInformation:last_name.prefix
valueString			string	There are no (further) constraints on this element Data Type string
lastName	I	0..1	Extension(string)	Element Id HumanName.family.extension:lastName Short description Portion derived from person's own surname Alternate names extensions, user content 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. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-name Constraints 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 v2:FN.3 rim:ENXP where Qualifiers = (BR)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.family.extension:lastName.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-own-name Mappings rim:N/A
value[x]		1..1		Element Id HumanName.family.extension:lastName.value[x] Short description LastName Alternate names Achternaam Definition The person’s official last name. Preferrably, the last name prefix is captured using the `prefix` extension. It may however be included here for systems that do not record this separately. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.10 HdBe-NameInformation:last_name.last_name
valueString			string	There are no (further) constraints on this element Data Type string
partnerPrefix	I	0..1	Extension(string)	Element Id HumanName.family.extension:partnerPrefix Short description Voorvoegsel derived from person's partner's surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix Constraints 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 v2:FN.4 rim:ENXP where Qualifiers = (VV, SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.family.extension:partnerPrefix.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix Mappings rim:N/A
value[x]		1..1		Element Id HumanName.family.extension:partnerPrefix.value[x] Short description PartnerPrefix Alternate names VoorvoegselsPartner Definition Prefix to the partner’s last name if not provided in PartnerLastName. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.9 HdBe-NameInformation:last_name_partner.partner_prefix
valueString			string	There are no (further) constraints on this element Data Type string
partnerLastName	I	0..1	Extension(string)	Element Id HumanName.family.extension:partnerLastName Short description Portion derived from person's partner's surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-name Constraints 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 v2:FN.5 rim:ENXP where Qualifiers = (SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.family.extension:partnerLastName.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/humanname-partner-name Mappings rim:N/A
value[x]		1..1		Element Id HumanName.family.extension:partnerLastName.value[x] Short description PartnerLastName Alternate names AchternaamPartner Definition Partner’s official last name. Preferrably, the partner' last name prefix is captured using the `partnerPrefix` extension. It may however be included here for systems that do not record this separately. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A zib-nameinformation-v1.1-2020EN:NL-CM:20.4.8 HdBe-NameInformation:last_name_partner.partner_last_name
valueString			string	There are no (further) constraints on this element Data Type string
given	Σ	0..*	string	Element Id HumanName.given Short description Given names (not always 'first'). Includes middle names Alternate names first name, middle name Definition Given name. Comments To be conformant to the CBB for NameInformation, at least the following 'ISO 21090 EN Qualifiers' SHALL be supported: BR, IN and CL. The qualifier BR maps to the CBB concept FirstNames, IN maps to Initials and CL to GivenName. Data Type string Sliced: Unordered, Open, by extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').value(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames
firstNames	Σ	0..1	string	Element Id HumanName.given:firstNames Short description FirstNames Alternate names first name, middle name, Voornamen Definition The person’s official first 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.4 HdBe-NameInformation:first_names
extension	I	1..*	Extension	Element Id HumanName.given:firstNames.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
iso21090EnQualifier	I	1..1	Extension(code)	Element Id HumanName.given:firstNames.extension:iso21090EnQualifier Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints 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 rim:ENXP.qualifier
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.given:firstNames.extension:iso21090EnQualifier.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Mappings rim:N/A
value[x]		1..1	Binding	Element Id HumanName.given:firstNames.extension:iso21090EnQualifier.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. EntityNamePartQualifier (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern BR Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
initials	Σ	0..1	string	Element Id HumanName.given:initials Short description Initials Alternate names first name, middle name, Initialen Definition The person’s initials. Comments Each initial is expected to be delimited by a dot. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.5 HdBe-NameInformation:initials
extension	I	1..*	Extension	Element Id HumanName.given:initials.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
iso21090EnQualifier	I	1..1	Extension(code)	Element Id HumanName.given:initials.extension:iso21090EnQualifier Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints 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 rim:ENXP.qualifier
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.given:initials.extension:iso21090EnQualifier.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Mappings rim:N/A
value[x]		1..1	Binding	Element Id HumanName.given:initials.extension:iso21090EnQualifier.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. EntityNamePartQualifier (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern IN Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
givenName	Σ	0..1	string	Element Id HumanName.given:givenName Short description GivenName Alternate names first name, middle name, Roepnaam Definition The name normally used to address the person. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.6 HdBe-NameInformation:given_name
extension	I	1..*	Extension	Element Id HumanName.given:givenName.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
iso21090EnQualifier	I	1..1	Extension(code)	Element Id HumanName.given:givenName.extension:iso21090EnQualifier Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints 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 rim:ENXP.qualifier
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id HumanName.given:givenName.extension:iso21090EnQualifier.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Mappings rim:N/A
value[x]		1..1	Binding	Element Id HumanName.given:givenName.extension:iso21090EnQualifier.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Binding A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. EntityNamePartQualifier (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern CL Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
prefix	Σ	0..*	string	Element Id HumanName.prefix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:titles
suffix	Σ	0..*	string	Element Id HumanName.suffix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX] zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:titles
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id HumanName.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. 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. Data Type Period Constraints 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)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate

Mapping FHIR profile to CBB

Path	map
HumanName	name_information
HumanName.extension:humannameAssemblyOrder.value[x]	name_usage
HumanName.family.extension:prefix.value[x]	last_name.prefix
HumanName.family.extension:lastName.value[x]	last_name.last_name
HumanName.family.extension:partnerPrefix.value[x]	last_name_partner.partner_prefix
HumanName.family.extension:partnerLastName.value[x]	last_name_partner.partner_last_name
HumanName.given:firstNames	first_names
HumanName.given:initials	initials
HumanName.given:givenName	given_name
HumanName.prefix	titles
HumanName.suffix	titles

HdBe-NameInformation is a datatype profile and can therefore not have an example of its own. Rather, an example is provided within the example of the HdBe-profile(s) that use this datatype profile.

zib-NameInformation difference

Concept	Category	Description
`HumanName`	textual	Made the implementation guidance in the comment more generic and removed Dutch context.
`family.extension:lastName.value[x]`	textual	Added textual guidance that it is allowed to include `prefix` in the `lastName` for systems that do not record the prefix sperately, which is common in Belgium.
`family.extension:lastName.value[x]`	textual	Added textual guidance that it is allowed to include `partnerPrefix` in the `partnerLastName` for systems that do not record the prefix sperately, which is common in Belgium.

Terminology Bindings

Path	Name	Strength	URL	ConceptMap
HumanName.extension.value[x]	name-assembly-order\|4.0.1	required	http://hl7.org/fhir/ValueSet/name-assembly-order\|4.0.1	https://fhir.healthdata.be/ConceptMap/NameUsage-to-HumanNameAssemblyOrder