Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Logical Model: US Realm Person Name (PN.US.FIELDED)

The US Realm Clinical Document Person Name datatype flavor is a set of reusable constraints that can be used for Persons.

Usage:

• Use this Logical Model: Advance Directive Observation, Care Plan, Care Team Member Act, Drug Monitoring Act... Show 5 more, Note Activity, Procedure Activity Procedure, Referral Note, Related Person Relationship and Name Participant and US Realm Header

Formal Views of Template Content

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

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

This structure is derived from PN

Name	Flags	Card.	Type	Description & Constraints
PN	C	1..*	PN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item Base for all types and resources Logical Container: ClinicalDocument (CDA Class) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
81-9371	error	PN	The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()
81-9372	error	PN	The string **SHALL NOT** contain name parts (CONF:81-9372). : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()

Name	Flags	Card.	Type	Description & Constraints
PN	C	1..*	PN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item Base for all types and resources Logical Container: ClinicalDocument (CDA Class) pn-no-ls: No PN name part may have a qualifier of LS. 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: CDAEntityNameUse (required)
item	C	1..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice
(Choice of one)		1..1
delimiter		0..*	ENXP
family		0..*	ENXP
given		0..*	ENXP
prefix		0..*	ENXP
suffix		0..*	ENXP
xmlText		0..1	st	Allows for mixed text content
validTime		0..1	IVL_TS
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PN.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
PN.use	required	CDAEntityNameUse http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse

Constraints

Id	Grade	Path(s)	Details	Requirements
81-9371	error	PN	The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()
81-9372	error	PN	The string **SHALL NOT** contain name parts (CONF:81-9372). : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()
EN-1	error	PN.item	Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1
pn-no-ls	error	PN	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()

Name	Flags	Card.	Type	Description & Constraints
PN	C	1..*	PN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item Base for all types and resources Logical Container: ClinicalDocument (CDA Class) pn-no-ls: No PN name part may have a qualifier of LS. 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: CDAEntityNameUse (required)
item	C	1..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice
(Choice of one)		1..1
delimiter		0..*	ENXP
family		0..*	ENXP
given		0..*	ENXP
prefix		0..*	ENXP
suffix		0..*	ENXP
xmlText		0..1	st	Allows for mixed text content
validTime		0..1	IVL_TS
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PN.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
PN.use	required	CDAEntityNameUse http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse

Constraints

Id	Grade	Path(s)	Details	Requirements
81-9371	error	PN	The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()
81-9372	error	PN	The string **SHALL NOT** contain name parts (CONF:81-9372). : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()
EN-1	error	PN.item	Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1
pn-no-ls	error	PN	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()

This structure is derived from PN

Summary

Differential View

This structure is derived from PN

Name	Flags	Card.	Type	Description & Constraints
PN	C	1..*	PN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item Base for all types and resources Logical Container: ClinicalDocument (CDA Class) 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
81-9371	error	PN	The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()
81-9372	error	PN	The string **SHALL NOT** contain name parts (CONF:81-9372). : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PN	C	1..*	PN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item Base for all types and resources Logical Container: ClinicalDocument (CDA Class) pn-no-ls: No PN name part may have a qualifier of LS. 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: CDAEntityNameUse (required)
item	C	1..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice
(Choice of one)		1..1
delimiter		0..*	ENXP
family		0..*	ENXP
given		0..*	ENXP
prefix		0..*	ENXP
suffix		0..*	ENXP
xmlText		0..1	st	Allows for mixed text content
validTime		0..1	IVL_TS
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PN.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
PN.use	required	CDAEntityNameUse http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse

Constraints

Id	Grade	Path(s)	Details	Requirements
81-9371	error	PN	The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()
81-9372	error	PN	The string **SHALL NOT** contain name parts (CONF:81-9372). : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()
EN-1	error	PN.item	Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1
pn-no-ls	error	PN	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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PN	C	1..*	PN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime, item Base for all types and resources Logical Container: ClinicalDocument (CDA Class) pn-no-ls: No PN name part may have a qualifier of LS. 81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). 81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372).
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: CDAEntityNameUse (required)
item	C	1..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice
(Choice of one)		1..1
delimiter		0..*	ENXP
family		0..*	ENXP
given		0..*	ENXP
prefix		0..*	ENXP
suffix		0..*	ENXP
xmlText		0..1	st	Allows for mixed text content
validTime		0..1	IVL_TS
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PN.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
PN.use	required	CDAEntityNameUse http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse

Constraints

Id	Grade	Path(s)	Details	Requirements
81-9371	error	PN	The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : conformsTo('http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED') or item.xmlText.exists()
81-9372	error	PN	The string **SHALL NOT** contain name parts (CONF:81-9372). : item.xmlText.exists() implies (item.delimiter | item.family | item.given | item.prefix | item.suffix).empty()
EN-1	error	PN.item	Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1
pn-no-ls	error	PN	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()

This structure is derived from PN

Summary

Other representations of profile: CSV, Excel