Clinical Document Architecture - Local Development build (v2.0.0-sd-202406-matchbox-patch) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Logical Model: PN: PersonName (V3 Data Type)

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

Usage:

• Use this Logical Model Profile: Patient (CDA Class), Person (CDA Class), PlayingEntity (CDA Class) and SubjectPerson (CDA Class)

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 EN

Name	Flags	Card.	Type	Description & Constraints
PN	C	1..*	EN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime Base for all types and resources Logical Container: ClinicalDocument (CDA Class) pn-no-ls: No PN name part may have a qualifier of LS.
item		1..*	Base
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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..*	EN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime Base for all types and resources Logical Container: ClinicalDocument (CDA Class) pn-no-ls: No PN name part may have a qualifier of LS.
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
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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..*	EN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime Base for all types and resources Logical Container: ClinicalDocument (CDA Class) pn-no-ls: No PN name part may have a qualifier of LS.
@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 from this IG
PN.use	required	CDAEntityNameUse http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse from this IG

Constraints

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

Differential View

This structure is derived from EN

Name	Flags	Card.	Type	Description & Constraints
PN	C	1..*	EN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime Base for all types and resources Logical Container: ClinicalDocument (CDA Class) pn-no-ls: No PN name part may have a qualifier of LS.
item		1..*	Base
Documentation for this format

Constraints

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PN	C	1..*	EN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime Base for all types and resources Logical Container: ClinicalDocument (CDA Class) pn-no-ls: No PN name part may have a qualifier of LS.
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
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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..*	EN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, @use, item, validTime Base for all types and resources Logical Container: ClinicalDocument (CDA Class) pn-no-ls: No PN name part may have a qualifier of LS.
@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 from this IG
PN.use	required	CDAEntityNameUse http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse from this IG

Constraints

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

Other representations of profile: CSV, Excel