NL Core Humanname
This extension is used in the following profiles:
The canonical URL for this profile is:
http://fhir.nl/fhir/StructureDefinition/nl-core-humanname
| HumanName | 0..* | HumanName | Element Id
HumanName Name of a human - parts and usage DefinitionA human's name with the ability to identify parts and usage. 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 / geslachtsnaam) 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" humanname-own-name = "Jongeneel" humanname-partner-prefix = "de " humanname-partner-name = "Haas"
Structured HumanName (preferred above unstructured)
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order",
"valueCode": "NL4"
}
],
"use": "official",
"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
{
"use": "official",
"text": "Irma Jongeneel-de Haas"
}
Mappings
|
|
| extension | 0..* | Extension | Element Id
HumanName.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Constraints
|
|
| humannameAssemblyOrder | 0..1 | Extension(code) | Element Id
HumanName.extension:humannameAssemblyOrder Preferred display order of name parts Alternate namesextensions, user content, Voorkeursvolgorde van de naamdelen. DefinitionA code that represents the preferred display order of the components of this human name. 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. http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Constraints
|
|
| use | Σ ?! | 0..1 | codeBinding | Element Id
HumanName.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. 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.
|
| text | Σ | 0..1 | string | Element Id
HumanName.text Text representation of the full name DefinitionA full text representation of the name. A renderable, unencoded form. Can provide both a text representation and structured parts.
|
| family | Σ | 0..1 | string | Element Id
HumanName.family Surname Alternate namessurname, Achternaam DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
| extension | 0..* | Extension | Element Id
HumanName.family.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Constraints
|
|
| humannameOwnPrefix | 0..1 | Extension(string) | Element Id
HumanName.family.extension:humannameOwnPrefix PrefixOwnName Alternate namesextensions, user content, VoorvoegselGeslachtsnaam DefinitionThe prefix portion (e.g. voorvoegsel) inclusive of the space between the prefix and the surname, if applicable, 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. 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. http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Constraints
|
|
| url | 1..1 | uriFixed Value | Element Id
HumanName.family.extension:humannameOwnPrefix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
|
|
| valueString | 0..1 | string | Element Id
HumanName.family.extension:humannameOwnPrefix.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| humannameOwnName | 0..1 | Extension(string) | Element Id
HumanName.family.extension:humannameOwnName OwnName Alternate namesextensions, user content, Geslachtsnaam DefinitionThe person’s official last name. 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. 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". http://hl7.org/fhir/StructureDefinition/humanname-own-name Constraints
|
|
| url | 1..1 | uriFixed Value | Element Id
HumanName.family.extension:humannameOwnName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/humanname-own-name
|
|
| valueString | 0..1 | string | Element Id
HumanName.family.extension:humannameOwnName.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| humannamePartnerPrefix | 0..1 | Extension(string) | Element Id
HumanName.family.extension:humannamePartnerPrefix PrefixSurname Alternate namesextensions, user content, VoorvoegselGeslachtsnaamPartner DefinitionVoorvoegsel derived from person's partner's surname inclusive of the space between the prefix and the surname, if applicable. 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. http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix Constraints
|
|
| url | 1..1 | uriFixed Value | Element Id
HumanName.family.extension:humannamePartnerPrefix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
|
|
| valueString | 0..1 | string | Element Id
HumanName.family.extension:humannamePartnerPrefix.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| humannamePartnerName | 0..1 | Extension(string) | Element Id
HumanName.family.extension:humannamePartnerName LastNamePartner Alternate namesextensions, user content, GeslachtsnaamPartner DefinitionPartner’s official last name. 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. 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". http://hl7.org/fhir/StructureDefinition/humanname-partner-name Constraints
|
|
| url | 1..1 | uriFixed Value | Element Id
HumanName.family.extension:humannamePartnerName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/humanname-partner-name
|
|
| valueString | 0..1 | string | Element Id
HumanName.family.extension:humannamePartnerName.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| given | Σ | 0..* | string | Element Id
HumanName.given Given Alternate namesfirst name, middle name, Voornamen, Initialen, Roepnaam DefinitionNote that in order to mark the type of a given name, that you use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. To be conformant to the Zib for NameInformation, at least the following qualifiers SHALL be supported: BR, IN and CL. The qualifier 'BR' maps to the Zib concept FirstNames, 'IN' maps to Initials and 'CL' to GivenName.
|
| extension | 0..* | Extension | Element Id
HumanName.given.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Constraints
|
|
| iso21090EnQualifier | 0..1 | Extension(code) | Element Id
HumanName.given.extension:iso21090EnQualifier LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV Alternate namesextensions, user content DefinitionA set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Used to indicate additional information about the name part and how it should be used. http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints
|
|
| url | 1..1 | uriFixed Value | Element Id
HumanName.given.extension:iso21090EnQualifier.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
|
|
| valueCode | 0..1 | codeBinding | Element Id
HumanName.given.extension:iso21090EnQualifier.valueCode:valueCode Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded EntityNamePartQualifier (required) Constraints
|
|
| prefix | Σ | 0..* | string | Element Id
HumanName.prefix Parts that come before the name DefinitionPart 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. Note that FHIR strings may not exceed 1MB in size
|
| suffix | Σ | 0..* | string | Element Id
HumanName.suffix Parts that come after the name DefinitionPart 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. Note that FHIR strings may not exceed 1MB in size
|
| period | Σ | 0..1 | Period | Element Id
HumanName.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.
|
See the profile on simplifier.net for additional details.