This page is part of the CH EPR FHIR (R4) (v4.0.1: DSTU 4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings

Data Type Profile: CH EPR FHIR BirthName

The birthname with the ISO 21090 qualifier https://www.hl7.org/fhir/extension-iso21090-en-qualifier.html BR

Usage:

• Use this DataType Constraint: CH PDQm Patient Profile for $match Input and CH PDQm Patient

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

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

This structure is derived from CHCoreHumanName

Name	Flags	Card.	Type	Description & Constraints
HumanName		0..*	CHCoreHumanName	BirthName
family	S	1..1	string	The birthname of the patient
Slices for extension		1..2	Extension	Extension Slice: Unordered, Closed by value:url
iso21090-EN-qualifier		1..1	(Complex)	LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
valueCode		1..1	code	BR (Birth) Fixed Value: BR
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
HumanName	C	0..*	CHCoreHumanName	BirthName ele-1: All FHIR elements must have a @value or children 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 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 ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
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	SΣ	1..1	string	The birthname of the patient ele-1: All FHIR elements must have a @value or children
Slices for extension		1..2	Extension	Extension Slice: Unordered, Closed 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
ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
iso21090-EN-qualifier		1..1	(Complex)	LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this Binding: EntityNamePartQualifier (required) ele-1: All FHIR elements must have a @value or children
value[x]:valueCode		1..1	code	BR (Birth) Binding: EntityNamePartQualifier (required) ele-1: All FHIR elements must have a @value or children Fixed Value: BR
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
HumanName.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
HumanName.family.extension:iso21090-EN-qualifier.value[x]	required	EntityNamePartQualifier http://hl7.org/fhir/ValueSet/name-part-qualifier
HumanName.family.extension:iso21090-EN-qualifier.value[x]:valueCode	required	Fixed Value: BR http://hl7.org/fhir/ValueSet/name-part-qualifier

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Name	Flags	Card.	Type	Description & Constraints
HumanName	C	0..*	CHCoreHumanName	BirthName 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 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 ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
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	SΣ	1..1	string	The birthname of the patient
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..2	Extension	Extension Slice: Unordered, Closed by value:url
ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible)
iso21090-EN-qualifier		1..1	(Complex)	LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this Binding: EntityNamePartQualifier (required)
value[x]:valueCode		1..1	code	BR (Birth) Binding: EntityNamePartQualifier (required) Fixed Value: BR
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
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ech11firstname		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible)
value		0..1	string	Primitive value for string Max Length:1048576
prefix	Σ	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
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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)
value		0..1	string	Primitive value for string Max Length:1048576
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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
HumanName.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
HumanName.family.extension:iso21090-EN-qualifier.value[x]	required	EntityNamePartQualifier http://hl7.org/fhir/ValueSet/name-part-qualifier
HumanName.family.extension:iso21090-EN-qualifier.value[x]:valueCode	required	Fixed Value: BR http://hl7.org/fhir/ValueSet/name-part-qualifier

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Mandatory: 4 elements
Must-Support: 1 element
Fixed: 1 element

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier

Differential View

This structure is derived from CHCoreHumanName

Name	Flags	Card.	Type	Description & Constraints
HumanName		0..*	CHCoreHumanName	BirthName
family	S	1..1	string	The birthname of the patient
Slices for extension		1..2	Extension	Extension Slice: Unordered, Closed by value:url
iso21090-EN-qualifier		1..1	(Complex)	LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
valueCode		1..1	code	BR (Birth) Fixed Value: BR
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
HumanName	C	0..*	CHCoreHumanName	BirthName ele-1: All FHIR elements must have a @value or children 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 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 ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
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	SΣ	1..1	string	The birthname of the patient ele-1: All FHIR elements must have a @value or children
Slices for extension		1..2	Extension	Extension Slice: Unordered, Closed 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
ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
iso21090-EN-qualifier		1..1	(Complex)	LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this Binding: EntityNamePartQualifier (required) ele-1: All FHIR elements must have a @value or children
value[x]:valueCode		1..1	code	BR (Birth) Binding: EntityNamePartQualifier (required) ele-1: All FHIR elements must have a @value or children Fixed Value: BR
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
HumanName.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
HumanName.family.extension:iso21090-EN-qualifier.value[x]	required	EntityNamePartQualifier http://hl7.org/fhir/ValueSet/name-part-qualifier
HumanName.family.extension:iso21090-EN-qualifier.value[x]:valueCode	required	Fixed Value: BR http://hl7.org/fhir/ValueSet/name-part-qualifier

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
HumanName	C	0..*	CHCoreHumanName	BirthName 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 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 ch-core-hm-3: ch-ext-ech-11-name can only be put on a family name ch-core-hm-4: ch-ext-ech-11-firstname can only be put on a given name
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	SΣ	1..1	string	The birthname of the patient
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		1..2	Extension	Extension Slice: Unordered, Closed by value:url
ech11name		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-name Binding: eCH-011 NameDataTypes (extensible)
iso21090-EN-qualifier		1..1	(Complex)	LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
Slices for value[x]		1..1	code	Value of extension Slice: Unordered, Closed by type:$this Binding: EntityNamePartQualifier (required)
value[x]:valueCode		1..1	code	BR (Birth) Binding: EntityNamePartQualifier (required) Fixed Value: BR
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
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ech11firstname		0..1	code	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-11-firstname Binding: eCH-011 FirstNameDataTypes (extensible)
value		0..1	string	Primitive value for string Max Length:1048576
prefix	Σ	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
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
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)
value		0..1	string	Primitive value for string Max Length:1048576
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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
HumanName.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
HumanName.family.extension:iso21090-EN-qualifier.value[x]	required	EntityNamePartQualifier http://hl7.org/fhir/ValueSet/name-part-qualifier
HumanName.family.extension:iso21090-EN-qualifier.value[x]:valueCode	required	Fixed Value: BR http://hl7.org/fhir/ValueSet/name-part-qualifier

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Mandatory: 4 elements
Must-Support: 1 element
Fixed: 1 element

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier

Other representations of profile: CSV, Excel, Schematron