HL7 Europe Base Profiles, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/base/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.eu/fhir/base/StructureDefinition/HumanName-eu | Version: 0.0.1-ci | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: HumanNameEu | ||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
This profile extends the HumanName data type for supporting multiple family names.
This profile of the HumanName allows for expressing multiple family names, as requested by some jurisdictions.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from HumanName
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HumanName | 0..* | HumanName | Name of a human - parts and usage | |
family | 0..1 | string | Family name (often called 'Surname') Example spanish name: Valero Iglesias | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
fathersFamily | 0..* | string | Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family Example spanish name: Valero | |
mothersFamily | 0..* | string | Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family Example spanish name: Iglesias | |
given | 0..* | string | Given names (not always 'first'). Includes middle names Example spanish name: Borja | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HumanName | 0..* | HumanName | Name of a human - parts and usage ele-1: All FHIR elements must have a @value or children | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
family | Σ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children Example spanish name: Valero Iglesias |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
fathersFamily | 0..* | string | Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Valero | |
mothersFamily | 0..* | string | Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Iglesias | |
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HumanName.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HumanName | 0..* | HumanName | Name of a human - parts and usage | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
text | Σ | 0..1 | string | Text representation of the full name |
family | Σ | 0..1 | string | Family name (often called 'Surname') Example spanish name: Valero Iglesias |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
fathersFamily | 0..* | string | Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family Example spanish name: Valero | |
mothersFamily | 0..* | string | Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family Example spanish name: Iglesias | |
value | 0..1 | string | Primitive value for string Max Length:1048576 | |
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja |
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
period | Σ | 0..1 | Period | Time period when name was/is in use |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HumanName.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from HumanName
Summary
Extensions
This structure refers to these extensions:
Maturity: 2
Differential View
This structure is derived from HumanName
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HumanName | 0..* | HumanName | Name of a human - parts and usage | |
family | 0..1 | string | Family name (often called 'Surname') Example spanish name: Valero Iglesias | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
fathersFamily | 0..* | string | Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family Example spanish name: Valero | |
mothersFamily | 0..* | string | Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family Example spanish name: Iglesias | |
given | 0..* | string | Given names (not always 'first'). Includes middle names Example spanish name: Borja | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HumanName | 0..* | HumanName | Name of a human - parts and usage ele-1: All FHIR elements must have a @value or children | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children |
family | Σ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children Example spanish name: Valero Iglesias |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
fathersFamily | 0..* | string | Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Valero | |
mothersFamily | 0..* | string | Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Example spanish name: Iglesias | |
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HumanName.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HumanName | 0..* | HumanName | Name of a human - parts and usage | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
text | Σ | 0..1 | string | Text representation of the full name |
family | Σ | 0..1 | string | Family name (often called 'Surname') Example spanish name: Valero Iglesias |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
fathersFamily | 0..* | string | Portion of family name derived from father URL: http://hl7.org/fhir/StructureDefinition/humanname-fathers-family Example spanish name: Valero | |
mothersFamily | 0..* | string | Portion of family name derived from mother URL: http://hl7.org/fhir/StructureDefinition/humanname-mothers-family Example spanish name: Iglesias | |
value | 0..1 | string | Primitive value for string Max Length:1048576 | |
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name Example spanish name: Borja |
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
period | Σ | 0..1 | Period | Time period when name was/is in use |
Documentation for this format |
Path | Conformance | ValueSet | URI |
HumanName.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from HumanName
Summary
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron