Consolidated CDA (C-CDA)
3.0.0 - STU3 United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: USRealmPatientNamePTNUSFIELDED - Detailed Descriptions

Draft as of 2024-05-18

Definitions for the USRealmPatientNamePTNUSFIELDED logical model.

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

0. PN
Logical ContainerClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). (nullFlavor.exists() or item.family.count() = 1)
shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). (nullFlavor.exists() or item.given.exists())
shall-max-suffix: There may be at most one suffix ((item.suffix.empty() or item.suffix.count() = 1))
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (item.xmlText.empty())
2. PN.use
ShortIf 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).

Control0..1
4. PN.item
6. PN.item.family
Short(USCDI) Last Name
8. PN.item.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).

Control0..1
BindingThe codes SHALL be taken from EntityPersonNamePartQualifier .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26)
10. PN.item.given
Short(USCDI) First Name / Middle Name
Comments

SHALL contain at least one [1..*] given (CONF:81-7157).

12. PN.item.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).

Control0..1
BindingThe codes SHALL be taken from EntityPersonNamePartQualifier .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26)
14. PN.item.prefix
Comments

MAY contain zero or more [0..*] prefix (CONF:81-7155).

16. PN.item.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).

Control0..1
BindingThe codes SHALL be taken from EntityPersonNamePartQualifier .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26)
18. PN.item.suffix
Short(USCDI) Suffix
Comments

MAY contain zero or one [0..1] suffix (CONF:81-7161).

20. PN.item.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).

Control0..1
BindingThe codes SHALL be taken from EntityPersonNamePartQualifier .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26)
22. PN.validTime
Short(USCDI) Previous Name - Available for use to identify the time period when name was/is in use.

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.

ShortBase for all types and resources
Control10..*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). (nullFlavor.exists() or item.family.count() = 1)
shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). (nullFlavor.exists() or item.given.exists())
shall-max-suffix: There may be at most one suffix ((item.suffix.empty() or item.suffix.count() = 1))
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (item.xmlText.empty())
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

ShortIf 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).

Control0..1
BindingThe codes SHALL be taken from CDAEntityNameUse
(required to http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelUse Code
4. PN.item
Definition

A series of items that constitute the name.

Control1..*
Typehttp://hl7.org/fhir/StructureDefinition/Base
Choice GroupThis is a repeating choice group that does not appear directly in the instance
InvariantsEN-1: Can only have only one of the possible item elements in each choice ((delimiter | family | given | prefix | suffix | xmlText).count() = 1)
6. PN.item.family
Short(USCDI) Last Name
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
8. PN.item.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).

Control0..1
BindingThe codes SHALL be taken from EntityPersonNamePartQualifier .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelQualifier Code
10. PN.item.given
Short(USCDI) First Name / Middle Name
Comments

SHALL contain at least one [1..*] given (CONF:81-7157).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
12. PN.item.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).

Control0..1
BindingThe codes SHALL be taken from EntityPersonNamePartQualifier .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelQualifier Code
14. PN.item.prefix
Comments

MAY contain zero or more [0..*] prefix (CONF:81-7155).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
16. PN.item.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).

Control0..1
BindingThe codes SHALL be taken from EntityPersonNamePartQualifier .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelQualifier Code
18. PN.item.suffix
Short(USCDI) Suffix
Comments

MAY contain zero or one [0..1] suffix (CONF:81-7161).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
20. PN.item.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).

Control0..1
BindingThe codes SHALL be taken from EntityPersonNamePartQualifier .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelQualifier Code
22. 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.

Short(USCDI) Previous Name - Available for use to identify the time period when name was/is in use.
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
LabelValid Time

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).

ShortBase for all types and resources
Control1..*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantspn-no-ls: No PN name part may have a qualifier of LS. ((item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty())
shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). (nullFlavor.exists() or item.family.count() = 1)
shall-given: SHALL contain at least one [1..*] given (CONF:81-7157). (nullFlavor.exists() or item.given.exists())
shall-max-suffix: There may be at most one suffix ((item.suffix.empty() or item.suffix.count() = 1))
81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278). (item.xmlText.empty())
2. PN.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional 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

ShortIf 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).

Control0..1
BindingThe codes SHALL be taken from CDAEntityNameUse
(required to http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelUse Code
6. PN.item
Definition

A series of items that constitute the name.

Control1..*
Typehttp://hl7.org/fhir/StructureDefinition/Base
Choice GroupThis is a repeating choice group that does not appear directly in the instance
InvariantsEN-1: Can only have only one of the possible item elements in each choice ((delimiter | family | given | prefix | suffix | xmlText).count() = 1)
8. PN.item.delimiter
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
10. PN.item.family
Short(USCDI) Last Name
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
12. PN.item.family.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
14. PN.item.family.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
16. PN.item.family.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelMedia Type
Fixed Valuetext/plain
18. PN.item.family.language
Definition

For character based information the language property specifies the human language of the text.

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelLanguage
20. PN.item.family.xmlText
ShortAllows for mixed text content
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as unadorned text.
22. PN.item.family.partType
Definition

Indicates whether the name part is a given name, family name, prefix, suffix, etc.

Control0..1
BindingThe codes SHALL be taken from EntityNamePartType
(required to http://terminology.hl7.org/ValueSet/v3-EntityNamePartType)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelName Part Type Code
24. PN.item.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).

Control0..1
BindingThe codes SHALL be taken from EntityPersonNamePartQualifier .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelQualifier Code
26. PN.item.given
Short(USCDI) First Name / Middle Name
Comments

SHALL contain at least one [1..*] given (CONF:81-7157).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
28. PN.item.given.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
30. PN.item.given.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
32. PN.item.given.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelMedia Type
Fixed Valuetext/plain
34. PN.item.given.language
Definition

For character based information the language property specifies the human language of the text.

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelLanguage
36. PN.item.given.xmlText
ShortAllows for mixed text content
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as unadorned text.
38. PN.item.given.partType
Definition

Indicates whether the name part is a given name, family name, prefix, suffix, etc.

Control0..1
BindingThe codes SHALL be taken from EntityNamePartType
(required to http://terminology.hl7.org/ValueSet/v3-EntityNamePartType)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelName Part Type Code
40. PN.item.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).

Control0..1
BindingThe codes SHALL be taken from EntityPersonNamePartQualifier .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelQualifier Code
42. PN.item.prefix
Comments

MAY contain zero or more [0..*] prefix (CONF:81-7155).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
44. PN.item.prefix.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
46. PN.item.prefix.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
48. PN.item.prefix.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelMedia Type
Fixed Valuetext/plain
50. PN.item.prefix.language
Definition

For character based information the language property specifies the human language of the text.

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelLanguage
52. PN.item.prefix.xmlText
ShortAllows for mixed text content
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as unadorned text.
54. PN.item.prefix.partType
Definition

Indicates whether the name part is a given name, family name, prefix, suffix, etc.

Control0..1
BindingThe codes SHALL be taken from EntityNamePartType
(required to http://terminology.hl7.org/ValueSet/v3-EntityNamePartType)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelName Part Type Code
56. PN.item.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).

Control0..1
BindingThe codes SHALL be taken from EntityPersonNamePartQualifier .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelQualifier Code
58. PN.item.suffix
Short(USCDI) Suffix
Comments

MAY contain zero or one [0..1] suffix (CONF:81-7161).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
60. PN.item.suffix.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
62. PN.item.suffix.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
64. PN.item.suffix.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelMedia Type
Fixed Valuetext/plain
66. PN.item.suffix.language
Definition

For character based information the language property specifies the human language of the text.

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelLanguage
68. PN.item.suffix.xmlText
ShortAllows for mixed text content
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as unadorned text.
70. PN.item.suffix.partType
Definition

Indicates whether the name part is a given name, family name, prefix, suffix, etc.

Control0..1
BindingThe codes SHALL be taken from EntityNamePartType
(required to http://terminology.hl7.org/ValueSet/v3-EntityNamePartType)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelName Part Type Code
72. PN.item.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).

Control0..1
BindingThe codes SHALL be taken from EntityPersonNamePartQualifier .
(required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelQualifier Code
74. PN.item.xmlText
ShortAllows for mixed text content
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as unadorned text.
76. 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.

Short(USCDI) Previous Name - Available for use to identify the time period when name was/is in use.
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
LabelValid Time