Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions

Extension nl-core-humanname - Detailed Descriptions

Detailed Descriptions for the elements in the extension.

HumanName
Definition

A human's name with the ability to identify parts and usage.

Control0..*
TypeHumanName
Comments

Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.

A Dutch HumanName is a proper FHIR HumanName. Systems that do not understand any of the extensions, will be able to render and work with a Dutch name. Dutch names make certain name parts seaprately communicable. These parts are required for use in true Dutch systems when dealing with Dutch names, but may not have value for international systems when information gets sent abroad.

To have true compatibility an implementer SHOULD use the core HumanName parts as intended. To have names work for Dutch context, the implementer SHOULD in addition use the extension elements.

The extension elements cover birth name (NL: eigennaam) and partner 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, the the extension do not have explicit names like "prefix spouse", because a person may not have a spouse, or may not have assumed their names. Each extension supports a qualifier to mark 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-name-part1 = "Jongeneel" (qualifier=BR) family-name-part2-prefix = "de " (qualifier=VV) family-name-part2-prefix = "Haas" (qualifier=SP)

HumanName.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
HumanName.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open at End
  • discriminators: url
HumanName.extension (http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname-prefix)
Definition

Extension element for family name prefix

Control0..*
TypeElement (Extension Type: string)
Alternate Namesvoorvoegsel
Comments

Officially recognized family name prefixes may be found in BRP/GBA Table 36 "Voorvoegsels"

HumanName.extension (http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname)
Definition

Family name without family name prefix

Control0..*
TypeElement (Extension Type: string)
HumanName.extension (http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname-prefix)
Definition

Extension element for family name prefix

Control0..*
TypeElement (Extension Type: string)
Alternate Namesvoorvoegsel
Comments

Officially recognized family name prefixes may be found in BRP/GBA Table 36 "Voorvoegsels"

HumanName.extension (http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname)
Definition

Family name without family name prefix

Control0..*
TypeElement (Extension Type: string)
HumanName.use
Definition

Identifies the purpose for this name.

Control0..1
BindingThe use of a human name
The codes SHALL be taken from NameUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.

HumanName.text
Definition

A full text representation of the name.

Control0..1
Typestring
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and structured parts.

HumanName.family
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.

Control0..*
Typestring
Alternate Namessurname
Comments

For family name, hyphenated names such as "Smith-Jones" are a single name, but names with spaces such as "Smith Jones" are broken into multiple parts.

HumanName.given
Definition

Given name.

Control0..*
Typestring
Alternate Namesfirst name, middle name
Comments

If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first.

HumanName.prefix
Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Control0..*
Typestring
HumanName.suffix
Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Control0..*
Typestring
HumanName.period
Definition

Indicates the period of time when this name was valid for the named person.

Control0..1
TypePeriod
Requirements

Allows names to be placed in historical context.