CH ELM (R4), published by Federal Office of Public Health FOPH. This guide is not an authorized publication; it is the continuous build for version 1.16.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/ch-elm/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Data Type Profile: Human Name

Usages:

• Use this DataType Profile: CH ELM Patient

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HumanName	C	0..*	CHCoreHumanName	Name of a human - parts and usage Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4
HumanName.Slices for extension				Content/Rules for all slices
HumanName.Slices for extension.extension:vctcode		0..1	string	CH ELM Extension: VCT Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-vct-code
HumanName.Slices for extension.extension:hivcode		0..1	string	CH ELM Extension: HIV Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
HumanName.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
HumanName.use	Base	required	NameUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ch-core-hm-1	error	HumanName	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 value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')
ch-core-hm-2	error	HumanName	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 value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))
ch-core-hm-3	error	HumanName	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	error	HumanName	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	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 CHCoreHumanName

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HumanName			CHCoreHumanName
HumanName.Slices for extension				Content/Rules for all slices
HumanName.Slices for extension.extension:vctcode		0..1	string	CH ELM Extension: VCT Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-vct-code
HumanName.Slices for extension.extension:hivcode		0..1	string	CH ELM Extension: HIV Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
HumanName.family
HumanName.family.Slices for extension				Content/Rules for all slices
HumanName.family.Slices for extension.extension:dataabsentreason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
HumanName.given
HumanName.given.Slices for extension				Content/Rules for all slices
HumanName.given.Slices for extension.extension:dataabsentreason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HumanName	C	0..*	CHCoreHumanName	Name of a human - parts and usage Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4
HumanName.id		0..1	string	Unique id for inter-element referencing
HumanName.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
HumanName.Slices for extension.extension:vctcode		0..1	string	CH ELM Extension: VCT Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-vct-code
HumanName.Slices for extension.extension:hivcode		0..1	string	CH ELM Extension: HIV Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
HumanName.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
HumanName.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
HumanName.family	Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname')
HumanName.family.id		0..1	string	xml:id (or equivalent in JSON)
HumanName.family.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HumanName.family.Slices for extension.extension:ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (required)
HumanName.family.Slices for extension.extension:dataabsentreason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
HumanName.family.value		0..1	string	Primitive value for string Max Length:1048576
HumanName.given	Σ This element is included in summaries.	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
HumanName.given.id		0..1	string	xml:id (or equivalent in JSON)
HumanName.given.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HumanName.given.Slices for extension.extension:ech11firstname		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (required)
HumanName.given.Slices for extension.extension:dataabsentreason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
HumanName.given.value		0..1	string	Primitive value for string Max Length:1048576
HumanName.prefix	Σ This element is included in summaries.	0..*	string	For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. This repeating element order: Prefixes appear in the correct order for presenting the name
HumanName.prefix.id		0..1	string	xml:id (or equivalent in JSON)
HumanName.prefix.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HumanName.prefix.Slices for extension.extension:salutationandtitle		0..*	code	For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required)
HumanName.prefix.value		0..1	string	Primitive value for string Max Length:1048576
HumanName.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
HumanName.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
HumanName.use	Base	required	NameUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ch-core-hm-1	error	HumanName	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 value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')
ch-core-hm-2	error	HumanName	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 value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))
ch-core-hm-3	error	HumanName	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	error	HumanName	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	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 CHCoreHumanName

Summary

Extensions

This structure refers to these extensions:

• http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-vct-code
• http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
• http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.3.0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HumanName	C	0..*	CHCoreHumanName	Name of a human - parts and usage Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4
HumanName.Slices for extension				Content/Rules for all slices
HumanName.Slices for extension.extension:vctcode		0..1	string	CH ELM Extension: VCT Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-vct-code
HumanName.Slices for extension.extension:hivcode		0..1	string	CH ELM Extension: HIV Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
HumanName.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
HumanName.use	Base	required	NameUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ch-core-hm-1	error	HumanName	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 value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')
ch-core-hm-2	error	HumanName	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 value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))
ch-core-hm-3	error	HumanName	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	error	HumanName	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	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()

Differential View

This structure is derived from CHCoreHumanName

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HumanName			CHCoreHumanName
HumanName.Slices for extension				Content/Rules for all slices
HumanName.Slices for extension.extension:vctcode		0..1	string	CH ELM Extension: VCT Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-vct-code
HumanName.Slices for extension.extension:hivcode		0..1	string	CH ELM Extension: HIV Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
HumanName.family
HumanName.family.Slices for extension				Content/Rules for all slices
HumanName.family.Slices for extension.extension:dataabsentreason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
HumanName.given
HumanName.given.Slices for extension				Content/Rules for all slices
HumanName.given.Slices for extension.extension:dataabsentreason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HumanName	C	0..*	CHCoreHumanName	Name of a human - parts and usage Constraints: ch-core-hm-1, ch-core-hm-2, ch-core-hm-3, ch-core-hm-4
HumanName.id		0..1	string	Unique id for inter-element referencing
HumanName.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
HumanName.Slices for extension.extension:vctcode		0..1	string	CH ELM Extension: VCT Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-vct-code
HumanName.Slices for extension.extension:hivcode		0..1	string	CH ELM Extension: HIV Code URL: http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
HumanName.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
HumanName.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
HumanName.family	Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname')
HumanName.family.id		0..1	string	xml:id (or equivalent in JSON)
HumanName.family.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HumanName.family.Slices for extension.extension:ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (required)
HumanName.family.Slices for extension.extension:dataabsentreason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
HumanName.family.value		0..1	string	Primitive value for string Max Length:1048576
HumanName.given	Σ This element is included in summaries.	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
HumanName.given.id		0..1	string	xml:id (or equivalent in JSON)
HumanName.given.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HumanName.given.Slices for extension.extension:ech11firstname		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (required)
HumanName.given.Slices for extension.extension:dataabsentreason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
HumanName.given.value		0..1	string	Primitive value for string Max Length:1048576
HumanName.prefix	Σ This element is included in summaries.	0..*	string	For a salutation use a prefix without the iso21090-EN-qualifier extension. For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. This repeating element order: Prefixes appear in the correct order for presenting the name
HumanName.prefix.id		0..1	string	xml:id (or equivalent in JSON)
HumanName.prefix.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HumanName.prefix.Slices for extension.extension:salutationandtitle		0..*	code	For academical titles and legal status use the http://hl7.org/fhir/ExtensionDefinition/iso21090-EN-qualifier with the codes AC, LS. URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required)
HumanName.prefix.value		0..1	string	Primitive value for string Max Length:1048576
HumanName.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
HumanName.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
HumanName.use	Base	required	NameUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ch-core-hm-1	error	HumanName	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 value='officialName').empty() or (family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='officialName').exists() and use='official')
ch-core-hm-2	error	HumanName	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 value='originalName').empty() or ((family.extension.where(url='http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name' and value='originalName').exists() and use='maiden'))
ch-core-hm-3	error	HumanName	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	error	HumanName	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	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 CHCoreHumanName

Summary

Extensions

This structure refers to these extensions:

• http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-vct-code
• http://fhir.ch/ig/ch-elm/StructureDefinition/ch-elm-ext-hiv-code
• http://hl7.org/fhir/StructureDefinition/data-absent-reason|5.3.0

Other representations of profile: CSV, Excel, Schematron