Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build
Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2024-04-09 |
Definitions for the nl-core-humanname data type profile.
Guidance on how to interpret the contents of this table can be found here
0. HumanName | |
Comments | Dutch names require that certain name parts are separately communicable. For this reason, extensions are added onto the base HumanName element to mark the meaning of each part. A Dutch HumanName is still a proper FHIR HumanName; however, there might be an incompatibilty with the default FHIR mechanism for communicating given names. See the compatibility note below for more information. 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. Incompatibility note: It has come to light that this specification deviates from the way that the HumanName datatype is normally used. This will be fixed in a future release. However, current implementations should be aware of the special considerations regarding the use of this specification. The issue at hand is the way alternative representations of a name, like initials or a nickname, are communicated. Normally this is done using multiple HumanName instances, which are differentiated using the Since multiple implementations are based on this specification, sending systems are advised (but not required) to keep the approach with one HumanName instance, while recieving systems should be able to handle this one-instance approach. More specifically:
Example: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas:
|
Example | <br/><b>Structured HumanName (preferred above unstructured)</b>:{ "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"], "_given" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode" : "CL" }] }] } <br/><b>Unstructured HumanName</b>:{ "text" : "Irma Jongeneel-de Haas" } |
Invariants | nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected (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() )nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected ( 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() ) |
2. HumanName.extension | |
Slicing | This element introduces a set of slices on HumanName.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
4. HumanName.extension:humannameAssemblyOrder | |
Slice Name | humannameAssemblyOrder |
Type | Extension(assembly-order) (Extension Type: code) |
Alternate Names | Voorkeursvolgorde van de naamdelen. |
6. HumanName.text | |
8. HumanName.family | |
Short | Surname |
Alternate Names | Achternaam |
10. HumanName.family.extension | |
Slicing | This element introduces a set of slices on HumanName.family.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
12. HumanName.family.extension:humannameOwnPrefix | |
Slice Name | humannameOwnPrefix |
Definition | The 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. |
Short | PrefixOwnName |
Type | Extension(own-prefix) (Extension Type: string) |
Alternate Names | VoorvoegselGeslachtsnaam |
14. HumanName.family.extension:humannameOwnPrefix.valueString:valueString | |
Slice Name | valueString |
16. HumanName.family.extension:humannameOwnName | |
Slice Name | humannameOwnName |
Definition | The person’s official last name. |
Short | OwnName |
Comments | 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". |
Type | Extension(own-name) (Extension Type: string) |
Alternate Names | Geslachtsnaam |
18. HumanName.family.extension:humannameOwnName.valueString:valueString | |
Slice Name | valueString |
20. HumanName.family.extension:humannamePartnerPrefix | |
Slice Name | humannamePartnerPrefix |
Definition | Voorvoegsel derived from person's partner's surname inclusive of the space between the prefix and the surname, if applicable. |
Short | PrefixSurname |
Type | Extension(partner-prefix) (Extension Type: string) |
Alternate Names | VoorvoegselGeslachtsnaamPartner |
22. HumanName.family.extension:humannamePartnerPrefix.valueString:valueString | |
Slice Name | valueString |
24. HumanName.family.extension:humannamePartnerName | |
Slice Name | humannamePartnerName |
Definition | Partner’s official last name. |
Short | LastNamePartner |
Comments | 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". |
Type | Extension(partner-name) (Extension Type: string) |
Alternate Names | GeslachtsnaamPartner |
26. HumanName.family.extension:humannamePartnerName.valueString:valueString | |
Slice Name | valueString |
28. HumanName.given | |
Definition | Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. |
Short | Given |
Comments | Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. To be conformant to the HCIM for NameInformation, at least the following qualifiers SHALL be supported: BR, IN and CL. The qualifier BRmaps to the HCIM concept FirstNames, IN maps to Initials and CL to GivenName. Please see the compatibility note on the containing element as well! |
Alternate Names | Voornamen, Initialen, Roepnaam |
30. HumanName.given.extension | |
Slicing | This element introduces a set of slices on HumanName.given.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
32. HumanName.given.extension:iso21090EnQualifier | |
Slice Name | iso21090EnQualifier |
Control | 0..1 |
Type | Extension(EN-qualifier) (Extension Type: code) |
34. HumanName.given.extension:iso21090EnQualifier.valueCode:valueCode | |
Slice Name | valueCode |
Guidance on how to interpret the contents of this table can be found here
0. HumanName | |
Definition | A human's name with the ability to identify parts and usage. |
Short | Name of a human - parts and usage |
Comments | Dutch names require that certain name parts are separately communicable. For this reason, extensions are added onto the base HumanName element to mark the meaning of each part. A Dutch HumanName is still a proper FHIR HumanName; however, there might be an incompatibilty with the default FHIR mechanism for communicating given names. See the compatibility note below for more information. 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. Incompatibility note: It has come to light that this specification deviates from the way that the HumanName datatype is normally used. This will be fixed in a future release. However, current implementations should be aware of the special considerations regarding the use of this specification. The issue at hand is the way alternative representations of a name, like initials or a nickname, are communicated. Normally this is done using multiple HumanName instances, which are differentiated using the Since multiple implementations are based on this specification, sending systems are advised (but not required) to keep the approach with one HumanName instance, while recieving systems should be able to handle this one-instance approach. More specifically:
Example: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas:
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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Example | <br/><b>Structured HumanName (preferred above unstructured)</b>:{ "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"], "_given" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode" : "CL" }] }] } <br/><b>Unstructured HumanName</b>:{ "text" : "Irma Jongeneel-de Haas" } |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected ( 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() )nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected ( 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() )ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) |
2. HumanName.extension | |
Definition | An Extension May 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. |
Short | ExtensionAdditional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on HumanName.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
4. HumanName.extension:humannameAssemblyOrder | |
Slice Name | humannameAssemblyOrder |
Definition | A code that represents the preferred display order of the components of this human name. |
Short | Preferred display order of name parts |
Control | 0..* |
Type | Extension(assembly-order) (Extension Type: code) |
Alternate Names | Voorkeursvolgorde van de naamdelen. |
6. HumanName.use | |
Definition | Identifies the purpose for this name. |
Short | usual | official | temp | nickname | anonymous | old | maiden |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use (required to http://hl7.org/fhir/ValueSet/name-use )The use of a human name |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
8. HumanName.text | |
Definition | A full text representation of the name. |
Short | Text representation of the full name |
Comments | Can provide both a text representation and structured parts. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | A renderable, unencoded form. |
10. 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. |
Short | SurnameFamily name (often called 'Surname') |
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | surname, Achternaam |
12. HumanName.family.extension | |
Definition | An Extension May 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. |
Short | ExtensionAdditional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on HumanName.family.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
14. HumanName.family.extension:humannameOwnPrefix | |
Slice Name | humannameOwnPrefix |
Definition | The 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. |
Short | PrefixOwnName |
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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(own-prefix) (Extension Type: string) |
Alternate Names | VoorvoegselGeslachtsnaam |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
16. HumanName.family.extension:humannameOwnPrefix.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/humanname-own-prefix |
18. HumanName.family.extension:humannameOwnPrefix.valueString:valueString | |
Slice Name | valueString |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 0..1 |
Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
20. HumanName.family.extension:humannameOwnName | |
Slice Name | humannameOwnName |
Definition | The person’s official last name. |
Short | OwnName |
Comments | 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". |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(own-name) (Extension Type: string) |
Alternate Names | Geslachtsnaam |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
22. HumanName.family.extension:humannameOwnName.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/humanname-own-name |
24. HumanName.family.extension:humannameOwnName.valueString:valueString | |
Slice Name | valueString |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 0..1 |
Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
26. HumanName.family.extension:humannamePartnerPrefix | |
Slice Name | humannamePartnerPrefix |
Definition | Voorvoegsel derived from person's partner's surname inclusive of the space between the prefix and the surname, if applicable. |
Short | PrefixSurname |
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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(partner-prefix) (Extension Type: string) |
Alternate Names | VoorvoegselGeslachtsnaamPartner |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
28. HumanName.family.extension:humannamePartnerPrefix.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix |
30. HumanName.family.extension:humannamePartnerPrefix.valueString:valueString | |
Slice Name | valueString |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 0..1 |
Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. HumanName.family.extension:humannamePartnerName | |
Slice Name | humannamePartnerName |
Definition | Partner’s official last name. |
Short | LastNamePartner |
Comments | 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". |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(partner-name) (Extension Type: string) |
Alternate Names | GeslachtsnaamPartner |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
34. HumanName.family.extension:humannamePartnerName.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/humanname-partner-name |
36. HumanName.family.extension:humannamePartnerName.valueString:valueString | |
Slice Name | valueString |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 0..1 |
Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. HumanName.given | |
Definition | Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. Given name. |
Short | GivenGiven names (not always 'first'). Includes middle names |
Comments | Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. To be conformant to the HCIM for NameInformation, at least the following qualifiers SHALL be supported: BR, IN and CL. The qualifier BRmaps to the HCIM concept FirstNames, IN maps to Initials and CL to GivenName. Please see the compatibility note on the containing element as well! 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. |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | first name, middle name, Voornamen, Initialen, Roepnaam |
40. HumanName.given.extension | |
Definition | An Extension May 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. |
Short | ExtensionAdditional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on HumanName.given.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
42. HumanName.given.extension:iso21090EnQualifier | |
Slice Name | iso21090EnQualifier |
Definition | A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. |
Short | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV |
Comments | Used to indicate additional information about the name part and how it should be used. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(EN-qualifier) (Extension Type: code) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
44. HumanName.given.extension:iso21090EnQualifier.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier |
46. HumanName.given.extension:iso21090EnQualifier.valueCode:valueCode | |
Slice Name | valueCode |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 0..1 |
Binding | The codes SHALL be taken from For codes, see EntityNamePartQualifier (required to http://hl7.org/fhir/ValueSet/name-part-qualifier )A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type |
Type | code, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. HumanName | |
Definition | A human's name with the ability to identify parts and usage. |
Short | Name of a human - parts and usage |
Comments | Dutch names require that certain name parts are separately communicable. For this reason, extensions are added onto the base HumanName element to mark the meaning of each part. A Dutch HumanName is still a proper FHIR HumanName; however, there might be an incompatibilty with the default FHIR mechanism for communicating given names. See the compatibility note below for more information. 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. Incompatibility note: It has come to light that this specification deviates from the way that the HumanName datatype is normally used. This will be fixed in a future release. However, current implementations should be aware of the special considerations regarding the use of this specification. The issue at hand is the way alternative representations of a name, like initials or a nickname, are communicated. Normally this is done using multiple HumanName instances, which are differentiated using the Since multiple implementations are based on this specification, sending systems are advised (but not required) to keep the approach with one HumanName instance, while recieving systems should be able to handle this one-instance approach. More specifically:
Example: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas:
|
Control | 0..* This element is affected by the following invariants: ele-1 |
Example | <br/><b>Structured HumanName (preferred above unstructured)</b>:{ "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"], "_given" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode" : "CL" }] }] } <br/><b>Unstructured HumanName</b>:{ "text" : "Irma Jongeneel-de Haas" } |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected ( 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() )nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected ( 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() ) |
2. HumanName.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
4. HumanName.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices on HumanName.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
6. HumanName.extension:humannameAssemblyOrder | |
Slice Name | humannameAssemblyOrder |
Definition | A code that represents the preferred display order of the components of this human name. |
Short | Preferred display order of name parts |
Control | 0..* |
Type | Extension(assembly-order) (Extension Type: code) |
Alternate Names | Voorkeursvolgorde van de naamdelen. |
8. HumanName.use | |
Definition | Identifies the purpose for this name. |
Short | usual | official | temp | nickname | anonymous | old | maiden |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use )The use of a human name |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
10. HumanName.text | |
Definition | A full text representation of the name. |
Short | Text representation of the full name |
Comments | Can provide both a text representation and structured parts. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | A renderable, unencoded form. |
12. 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. |
Short | Surname |
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | surname, Achternaam |
14. HumanName.family.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
16. HumanName.family.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices on HumanName.family.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
18. HumanName.family.extension:humannameOwnPrefix | |
Slice Name | humannameOwnPrefix |
Definition | The 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. |
Short | PrefixOwnName |
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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(own-prefix) (Extension Type: string) |
Alternate Names | VoorvoegselGeslachtsnaam |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
20. HumanName.family.extension:humannameOwnPrefix.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
22. HumanName.family.extension:humannameOwnPrefix.extension | |
Definition | May 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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on HumanName.family.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
24. HumanName.family.extension:humannameOwnPrefix.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/humanname-own-prefix |
26. HumanName.family.extension:humannameOwnPrefix.valueString:valueString | |
Slice Name | valueString |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. HumanName.family.extension:humannameOwnName | |
Slice Name | humannameOwnName |
Definition | The person’s official last name. |
Short | OwnName |
Comments | 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". |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(own-name) (Extension Type: string) |
Alternate Names | Geslachtsnaam |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
30. HumanName.family.extension:humannameOwnName.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
32. HumanName.family.extension:humannameOwnName.extension | |
Definition | May 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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on HumanName.family.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
34. HumanName.family.extension:humannameOwnName.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/humanname-own-name |
36. HumanName.family.extension:humannameOwnName.valueString:valueString | |
Slice Name | valueString |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. HumanName.family.extension:humannamePartnerPrefix | |
Slice Name | humannamePartnerPrefix |
Definition | Voorvoegsel derived from person's partner's surname inclusive of the space between the prefix and the surname, if applicable. |
Short | PrefixSurname |
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. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(partner-prefix) (Extension Type: string) |
Alternate Names | VoorvoegselGeslachtsnaamPartner |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
40. HumanName.family.extension:humannamePartnerPrefix.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
42. HumanName.family.extension:humannamePartnerPrefix.extension | |
Definition | May 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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on HumanName.family.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
44. HumanName.family.extension:humannamePartnerPrefix.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix |
46. HumanName.family.extension:humannamePartnerPrefix.valueString:valueString | |
Slice Name | valueString |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. HumanName.family.extension:humannamePartnerName | |
Slice Name | humannamePartnerName |
Definition | Partner’s official last name. |
Short | LastNamePartner |
Comments | 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". |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(partner-name) (Extension Type: string) |
Alternate Names | GeslachtsnaamPartner |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
50. HumanName.family.extension:humannamePartnerName.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
52. HumanName.family.extension:humannamePartnerName.extension | |
Definition | May 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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on HumanName.family.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
54. HumanName.family.extension:humannamePartnerName.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/humanname-partner-name |
56. HumanName.family.extension:humannamePartnerName.valueString:valueString | |
Slice Name | valueString |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
58. HumanName.family.value | |
Definition | The actual value |
Short | Primitive value for string |
Control | 0..1 |
Type | string |
XML Format | In the XML format, this property is represented as an attribute. |
Max Length | 1048576 |
60. HumanName.given | |
Definition | Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. |
Short | Given |
Comments | Note that in order to mark the type of a given name, the FHIR standard extension for ISO 21090 EN Qualifiers is to be used. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. To be conformant to the HCIM for NameInformation, at least the following qualifiers SHALL be supported: BR, IN and CL. The qualifier BRmaps to the HCIM concept FirstNames, IN maps to Initials and CL to GivenName. Please see the compatibility note on the containing element as well! |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | first name, middle name, Voornamen, Initialen, Roepnaam |
62. HumanName.given.id | |
Definition | unique id for the element within a resource (for internal references) |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
64. HumanName.given.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Slicing | This element introduces a set of slices on HumanName.given.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
66. HumanName.given.extension:iso21090EnQualifier | |
Slice Name | iso21090EnQualifier |
Definition | A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. |
Short | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV |
Comments | Used to indicate additional information about the name part and how it should be used. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(EN-qualifier) (Extension Type: code) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
68. HumanName.given.extension:iso21090EnQualifier.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | xml:id (or equivalent in JSON) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
70. HumanName.given.extension:iso21090EnQualifier.extension | |
Definition | May 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. |
Short | Additional Content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Slicing | This element introduces a set of slices on HumanName.given.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
72. HumanName.given.extension:iso21090EnQualifier.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier |
74. HumanName.given.extension:iso21090EnQualifier.valueCode:valueCode | |
Slice Name | valueCode |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityNamePartQualifier (required to http://hl7.org/fhir/ValueSet/name-part-qualifier )A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
76. HumanName.given.value | |
Definition | The actual value |
Short | Primitive value for string |
Control | 0..1 |
Type | string |
XML Format | In the XML format, this property is represented as an attribute. |
Max Length | 1048576 |
78. 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. |
Short | Parts that come before the name |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
80. 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. |
Short | Parts that come after the name |
Control | 0..* |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
82. HumanName.period | |
Definition | Indicates the period of time when this name was valid for the named person. |
Short | Time period when name was/is in use |
Control | 0..1 |
Type | Period |
Summary | true |
Requirements | Allows names to be placed in historical context. |