US Realm Patient Name (PTN.US.FIELDED) - Definitions - Consolidated CDA Release 2.1 StructureDefinition Publication v2.1

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: USRealmPatientNamePTNUSFIELDED - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the USRealmPatientNamePTNUSFIELDED logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. PN
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.The children of this property can appear in any order in the XML.
Invariants	81-7278: SHALL NOT have mixed content except for white space (CONF:81-7278). ()
2. PN.use
Short	If name/@nullFlavor is present, the remaining conformance statements SHALL NOT be enforced
Comments	MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154).
4. PN.family
Comments	SHALL contain exactly one [1..1] family (CONF:81-7159).
Control	1..1
6. PN.family.qualifier
Comments	This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160).
Control	0..1
Binding	The codes SHALL be taken from EntityPersonNamePartQualifier
8. PN.given
Comments	SHALL contain at least one [1..*] given (CONF:81-7157).
Control	1..?
Invariants	81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). ()
10. PN.given.qualifier
Comments	Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158).
Control	0..1
Binding	The codes SHALL be taken from EntityPersonNamePartQualifier
12. PN.prefix
Comments	MAY contain zero or more [0..*] prefix (CONF:81-7155).
14. PN.prefix.qualifier
Comments	The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156).
Control	0..1
Binding	The codes SHALL be taken from EntityPersonNamePartQualifier
16. PN.suffix
Comments	MAY contain zero or one [0..1] suffix (CONF:81-7161).
Control	0..1
18. PN.suffix.qualifier
Comments	The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162).
Control	0..1
Binding	The codes SHALL be taken from EntityPersonNamePartQualifier

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

0. PN
Definition	A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	10..*
Is Modifier	false
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.The children of this property can appear in any order in the XML.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter \| family \| given \| prefix \| suffix).where(qualifier = 'LS').empty()`) 81-7278: SHALL NOT have mixed content except for white space (CONF:81-7278). ()
2. PN.use
Definition	A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose
Short	If name/@nullFlavor is present, the remaining conformance statements SHALL NOT be enforced
Comments	MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154).
Control	0..1
Binding	The codes SHALL be taken from EntityNameUse
Type	code(cs: Coded Simple Value)
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.
Label	Use Code
4. PN.family
Comments	SHALL contain exactly one [1..1] family (CONF:81-7159).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
6. PN.family.qualifier
Definition	qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.
Comments	This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160).
Control	0..1
Binding	The codes SHALL be taken from EntityPersonNamePartQualifier
Type	code(cs: Coded Simple Value)
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.
Label	Qualifier Code
8. PN.given
Comments	SHALL contain at least one [1..*] given (CONF:81-7157).
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
Invariants	81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). ()
10. PN.given.qualifier
Definition	qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.
Comments	Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158).
Control	0..1
Binding	The codes SHALL be taken from EntityPersonNamePartQualifier
Type	code(cs: Coded Simple Value)
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.
Label	Qualifier Code
12. PN.prefix
Comments	MAY contain zero or more [0..*] prefix (CONF:81-7155).
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
14. PN.prefix.qualifier
Definition	qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.
Comments	The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156).
Control	0..1
Binding	The codes SHALL be taken from EntityPersonNamePartQualifier
Type	code(cs: Coded Simple Value)
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.
Label	Qualifier Code
16. PN.suffix
Definition	Element EN.family
Comments	MAY contain zero or one [0..1] suffix (CONF:81-7161).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
18. PN.suffix.qualifier
Definition	qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.
Comments	The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162).
Control	0..1
Binding	The codes SHALL be taken from EntityPersonNamePartQualifier
Type	code(cs: Coded Simple Value)
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.
Label	Qualifier Code

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

0. PN
Definition	A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).
Short	Base for all types and resources
Control	1..*
Is Modifier	false
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.The children of this property can appear in any order in the XML.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter \| family \| given \| prefix \| suffix).where(qualifier = 'LS').empty()`) 81-7278: SHALL NOT have mixed content except for white space (CONF:81-7278). ()
2. PN.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code(cs: Coded Simple Value)
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.
Label	Exceptional Value Detail
4. PN.use
Definition	A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose
Short	If name/@nullFlavor is present, the remaining conformance statements SHALL NOT be enforced
Comments	MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154).
Control	0..1
Binding	The codes SHALL be taken from EntityNameUse
Type	code(cs: Coded Simple Value)
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.
Label	Use Code
6. PN.delimiter
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
8. PN.family
Comments	SHALL contain exactly one [1..1] family (CONF:81-7159).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
10. PN.family.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code(cs: Coded Simple Value)
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.
Label	Exceptional Value Detail
12. PN.family.representation
Definition	Specifies the representation of the binary data that is the content of the binary data value
Control	0..1
Type	code(cs: Coded Simple Value)
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	TXT
14. PN.family.mediaType
Definition	Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
Control	0..1
Type	code(cs: Coded Simple Value)
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.
Label	Media Type
Fixed Value	text/plain
16. PN.family.language
Definition	For character based information the language property specifies the human language of the text.
Control	0..1
Type	code(cs: Coded Simple Value)
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.
Label	Language
18. PN.family.data[x]
Definition	The string value
Control	0..1
Type	string(st: Character String)
[x] Note	See Choice of Data Types for further information about how to use [x]
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 unadorned text.
20. PN.family.partType
Definition	Indicates whether the name part is a given name, family name, prefix, suffix, etc.
Control	0..1
Binding	The codes SHALL be taken from EntityNamePartType
Type	code(cs: Coded Simple Value)
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.
Label	Name Part Type Code
22. PN.family.qualifier
Definition	qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.
Comments	This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160).
Control	0..1
Binding	The codes SHALL be taken from EntityPersonNamePartQualifier
Type	code(cs: Coded Simple Value)
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.
Label	Qualifier Code
24. PN.given
Comments	SHALL contain at least one [1..*] given (CONF:81-7157).
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
Invariants	81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). ()
26. PN.given.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code(cs: Coded Simple Value)
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.
Label	Exceptional Value Detail
28. PN.given.representation
Definition	Specifies the representation of the binary data that is the content of the binary data value
Control	0..1
Type	code(cs: Coded Simple Value)
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	TXT
30. PN.given.mediaType
Definition	Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
Control	0..1
Type	code(cs: Coded Simple Value)
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.
Label	Media Type
Fixed Value	text/plain
32. PN.given.language
Definition	For character based information the language property specifies the human language of the text.
Control	0..1
Type	code(cs: Coded Simple Value)
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.
Label	Language
34. PN.given.data[x]
Definition	The string value
Control	0..1
Type	string(st: Character String)
[x] Note	See Choice of Data Types for further information about how to use [x]
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 unadorned text.
36. PN.given.partType
Definition	Indicates whether the name part is a given name, family name, prefix, suffix, etc.
Control	0..1
Binding	The codes SHALL be taken from EntityNamePartType
Type	code(cs: Coded Simple Value)
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.
Label	Name Part Type Code
38. PN.given.qualifier
Definition	qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.
Comments	Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158).
Control	0..1
Binding	The codes SHALL be taken from EntityPersonNamePartQualifier
Type	code(cs: Coded Simple Value)
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.
Label	Qualifier Code
40. PN.prefix
Comments	MAY contain zero or more [0..*] prefix (CONF:81-7155).
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
42. PN.prefix.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code(cs: Coded Simple Value)
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.
Label	Exceptional Value Detail
44. PN.prefix.representation
Definition	Specifies the representation of the binary data that is the content of the binary data value
Control	0..1
Type	code(cs: Coded Simple Value)
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	TXT
46. PN.prefix.mediaType
Definition	Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
Control	0..1
Type	code(cs: Coded Simple Value)
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.
Label	Media Type
Fixed Value	text/plain
48. PN.prefix.language
Definition	For character based information the language property specifies the human language of the text.
Control	0..1
Type	code(cs: Coded Simple Value)
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.
Label	Language
50. PN.prefix.data[x]
Definition	The string value
Control	0..1
Type	string(st: Character String)
[x] Note	See Choice of Data Types for further information about how to use [x]
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 unadorned text.
52. PN.prefix.partType
Definition	Indicates whether the name part is a given name, family name, prefix, suffix, etc.
Control	0..1
Binding	The codes SHALL be taken from EntityNamePartType
Type	code(cs: Coded Simple Value)
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.
Label	Name Part Type Code
54. PN.prefix.qualifier
Definition	qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.
Comments	The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156).
Control	0..1
Binding	The codes SHALL be taken from EntityPersonNamePartQualifier
Type	code(cs: Coded Simple Value)
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.
Label	Qualifier Code
56. PN.suffix
Definition	Element EN.family
Comments	MAY contain zero or one [0..1] suffix (CONF:81-7161).
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ENXP
58. PN.suffix.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code(cs: Coded Simple Value)
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.
Label	Exceptional Value Detail
60. PN.suffix.representation
Definition	Specifies the representation of the binary data that is the content of the binary data value
Control	0..1
Type	code(cs: Coded Simple Value)
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	TXT
62. PN.suffix.mediaType
Definition	Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
Control	0..1
Type	code(cs: Coded Simple Value)
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.
Label	Media Type
Fixed Value	text/plain
64. PN.suffix.language
Definition	For character based information the language property specifies the human language of the text.
Control	0..1
Type	code(cs: Coded Simple Value)
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.
Label	Language
66. PN.suffix.data[x]
Definition	The string value
Control	0..1
Type	string(st: Character String)
[x] Note	See Choice of Data Types for further information about how to use [x]
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 unadorned text.
68. PN.suffix.partType
Definition	Indicates whether the name part is a given name, family name, prefix, suffix, etc.
Control	0..1
Binding	The codes SHALL be taken from EntityNamePartType
Type	code(cs: Coded Simple Value)
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.
Label	Name Part Type Code
70. PN.suffix.qualifier
Definition	qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records.
Comments	The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162).
Control	0..1
Binding	The codes SHALL be taken from EntityPersonNamePartQualifier
Type	code(cs: Coded Simple Value)
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.
Label	Qualifier Code
72. PN.other
Control	0..1
Type	string(st: Character 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 unadorned text.
74. PN.validTime
Definition	An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Label	Valid Time