CH.FHIR.IG.CH-CORE\Human Name - Definitions

This page is part of the CH Core (R4) (v3.0.0: STU 3) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Data Type Profile: CHCoreHumanName - Detailed Descriptions

Active as of 2018-11-21

Definitions for the ch-core-humanname data type profile.

Guidance on how to interpret the contents of this table can be found here.

1. HumanName
Invariants	Defined on this element ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official (: family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').exists() and use='official')) ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden (: family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').exists() and use='maiden'))) ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name (: descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()) ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name (: descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count())
2. HumanName.family
Alternate Names	surname
3. HumanName.family.extension
Control	0..?
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: value @ url
4. HumanName.family.extension:ech11name
SliceName	ech11name
Control	0..1
Type	Extension(ECH011Name) (Extension Type: code)
5. HumanName.given
Alternate Names	first name, middle name
6. HumanName.given.extension
Control	0..?
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: value @ url
7. HumanName.given.extension:ech11firstname
SliceName	ech11firstname
Control	0..1
Type	Extension(ECH011FirstName) (Extension Type: code)
8. HumanName.prefix
9. HumanName.prefix.extension
Control	0..?
Slicing	This element introduces a set of slices on HumanName.prefix.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
10. HumanName.prefix.extension:salutationandtitle
SliceName	salutationandtitle
Control	0..*
Type	Extension(EN-qualifier) (Extension Type: code)

Guidance on how to interpret the contents of this table can be found here.

1. HumanName
Definition	A human's name with the ability to identify parts and usage.
Control	0..* This element is affected by the following invariants: ele-1
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 might or might 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.
Invariants	Defined on this element ch-core-hm-1: if officalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is official (: family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='officialName').exists() and use='official')) ch-core-hm-2: if orginalName with eCH-011 Extension is specified, it can only be put on a name where use attribute is maiden (: family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and valueCode='originalName').exists() and use='maiden'))) ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name (: descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()=family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name').count()) ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name (: descendants().extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()=given.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname').count()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. HumanName.use
Definition	Identifies the purpose for this name.
Control	0..1
Binding	The codes SHALL be taken from NameUse The use of a human name.
Type	code
Is Modifier	true
Summary	true
Requirements	Allows the appropriate name for a particular context of use to be selected from among a set of names.
Comments	Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. 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.
Control	0..1
Type	string
Summary	true
Alternate Names	surname
Comments	Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. HumanName.family.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
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.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
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: value @ url
5. HumanName.family.extension:ech11name
SliceName	ech11name
Definition	Extension for eCH-0011 - namedatatype
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(ECH011Name) (Extension Type: code)
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
6. HumanName.given
Definition	Given name.
Control	0..*
Type	string
Summary	true
Alternate Names	first name, middle name
Comments	If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. HumanName.given.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
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.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
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: value @ url
8. HumanName.given.extension:ech11firstname
SliceName	ech11firstname
Definition	eCH-0011: Extension to define first name type
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(ECH011FirstName) (Extension Type: code)
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. 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.
Control	0..*
Type	string
Summary	true
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. HumanName.prefix.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
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.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on HumanName.prefix.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
11. HumanName.prefix.extension:salutationandtitle
SliceName	salutationandtitle
Definition	A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(EN-qualifier) (Extension Type: code)
Comments	Used to indicate additional information about the name part and how it should be used.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())

Guidance on how to interpret the contents of this table can be found here.

1. HumanName
Definition	A human's name with the ability to identify parts and usage.
Control	0..* This element is affected by the following invariants: ele-1
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 might or might 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.
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.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
3. HumanName.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
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.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
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: value @ url
4. HumanName.use
Definition	Identifies the purpose for this name.
Control	0..1
Binding	The codes SHALL be taken from NameUse The use of a human name
Type	code
Is Modifier	true
Summary	true
Requirements	Allows the appropriate name for a particular context of use to be selected from among a set of names.
Comments	Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. HumanName.text
Definition	Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
Control	0..1
Type	string
Summary	true
Requirements	A renderable, unencoded form.
Comments	Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. 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.
Control	0..1
Type	string
Summary	true
Alternate Names	surname
Comments	Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. HumanName.family.id
Definition	unique id for the element within a resource (for internal references)
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
8. HumanName.family.extension
Definition	An Extension
Control	0..*
Type	Extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
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: value @ url
9. HumanName.family.extension:ech11name
SliceName	ech11name
Definition	Extension for eCH-0011 - namedatatype
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(ECH011Name) (Extension Type: code)
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. HumanName.family.value
Definition	The actual value
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Max Length	1048576
11. HumanName.given
Definition	Given name.
Control	0..*
Type	string
Summary	true
Alternate Names	first name, middle name
Comments	If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. HumanName.given.id
Definition	unique id for the element within a resource (for internal references)
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
13. HumanName.given.extension
Definition	An Extension
Control	0..*
Type	Extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
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: value @ url
14. HumanName.given.extension:ech11firstname
SliceName	ech11firstname
Definition	eCH-0011: Extension to define first name type
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(ECH011FirstName) (Extension Type: code)
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. HumanName.given.value
Definition	The actual value
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Max Length	1048576
16. 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.
Control	0..*
Type	string
Summary	true
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. HumanName.prefix.id
Definition	unique id for the element within a resource (for internal references)
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
18. HumanName.prefix.extension
Definition	An Extension
Control	0..*
Type	Extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on HumanName.prefix.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
19. HumanName.prefix.extension:salutationandtitle
SliceName	salutationandtitle
Definition	A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(EN-qualifier) (Extension Type: code)
Comments	Used to indicate additional information about the name part and how it should be used.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
20. HumanName.prefix.value
Definition	The actual value
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Max Length	1048576
21. 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.
Control	0..*
Type	string
Summary	true
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. HumanName.period
Definition	Indicates the period of time when this name was valid for the named person.
Control	0..1
Type	Period
Summary	true
Requirements	Allows names to be placed in historical context.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))