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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML

Logical Model: US Realm Patient Name (PTN.US.FIELDED)

The US Realm Patient Name datatype flavor is a set of reusable constraints that can be used for the patient or any other person. It requires a first (given) and last (family) name. If a patient or person has only one name part (e.g., patient with first name only) place the name part in the field required by the organization. Use the appropriate nullFlavor, “Not Applicable” (NA), in the other field.

For information on mixed content see the Extensible Markup Language reference (http://www.w3c.org/TR/2008/REC-xml-20081126/).

Usage:

• Use this Logical Model: Referral Note and US Realm Header

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 PN

Name	Flags	Card.	Type	Description & Constraints
PN	C	1..*	PN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @use, delimiter, family, given, prefix, suffix, other, validTime Base for all types and resources 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
use		0..1	cs	If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
family		1..1	ENXP
qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
given	C	1..*	ENXP	81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
prefix		0..*	ENXP
qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
suffix		0..1	ENXP
qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
PN.family.qualifier	required	EntityPersonNamePartQualifier
PN.given.qualifier	required	EntityPersonNamePartQualifier
PN.prefix.qualifier	required	EntityPersonNamePartQualifier
PN.suffix.qualifier	required	EntityPersonNamePartQualifier

Constraints

Id	Grade	Path(s)	Details	Requirements
81-7163	warning	PN.given	The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). :
81-7278	error	PN	**SHALL NOT** have mixed content except for white space (CONF:81-7278). :

Name	Flags	Card.	Type	Description & Constraints
PN	C	1..*	PN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @use, delimiter, family, given, prefix, suffix, other, validTime Base for all types and resources 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
@use		0..1	cs	If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: EntityNameUse (required)
family		1..1	ENXP
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
given	C	1..*	ENXP	81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
prefix		0..*	ENXP
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
suffix		0..1	ENXP
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
PN.use	required	EntityNameUse
PN.family.qualifier	required	EntityPersonNamePartQualifier
PN.given.qualifier	required	EntityPersonNamePartQualifier
PN.prefix.qualifier	required	EntityPersonNamePartQualifier
PN.suffix.qualifier	required	EntityPersonNamePartQualifier

Constraints

Id	Grade	Path(s)	Details	Requirements
81-7163	warning	PN.given	The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). :
81-7278	error	PN	**SHALL NOT** have mixed content except for white space (CONF:81-7278). :
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
pn-no-ls	error	PN	No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()

Name	Flags	Card.	Type	Description & Constraints
PN	C	1..*	PN	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @use, delimiter, family, given, prefix, suffix, other, validTime Base for all types and resources 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
@nullFlavor		0..1	cs	Binding: NullFlavor (required)
@use		0..1	cs	If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: EntityNameUse (required)
delimiter		0..*	ENXP
family		1..1	ENXP
@nullFlavor		0..1	cs	Binding: NullFlavor (required)
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
data[x]		0..1	st
@partType		0..1	cs	Binding: EntityNamePartType (required)
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
given	C	1..*	ENXP	81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
@nullFlavor		0..1	cs	Binding: NullFlavor (required)
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
data[x]		0..1	st
@partType		0..1	cs	Binding: EntityNamePartType (required)
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
prefix		0..*	ENXP
@nullFlavor		0..1	cs	Binding: NullFlavor (required)
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
data[x]		0..1	st
@partType		0..1	cs	Binding: EntityNamePartType (required)
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
suffix		0..1	ENXP
@nullFlavor		0..1	cs	Binding: NullFlavor (required)
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
data[x]		0..1	st
@partType		0..1	cs	Binding: EntityNamePartType (required)
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
other		0..1	st
validTime		0..1	IVL_TS
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
PN.nullFlavor	required	NullFlavor
PN.use	required	EntityNameUse
PN.family.nullFlavor	required	NullFlavor
PN.family.partType	required	EntityNamePartType
PN.family.qualifier	required	EntityPersonNamePartQualifier
PN.given.nullFlavor	required	NullFlavor
PN.given.partType	required	EntityNamePartType
PN.given.qualifier	required	EntityPersonNamePartQualifier
PN.prefix.nullFlavor	required	NullFlavor
PN.prefix.partType	required	EntityNamePartType
PN.prefix.qualifier	required	EntityPersonNamePartQualifier
PN.suffix.nullFlavor	required	NullFlavor
PN.suffix.partType	required	EntityNamePartType
PN.suffix.qualifier	required	EntityPersonNamePartQualifier

Constraints

Id	Grade	Path(s)	Details	Requirements
81-7163	warning	PN.given	The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). :
81-7278	error	PN	**SHALL NOT** have mixed content except for white space (CONF:81-7278). :
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
pn-no-ls	error	PN	No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()

This structure is derived from PN

Summary

Mandatory: 2 elements

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, delimiter, family, given, prefix, suffix, other, validTime Base for all types and resources 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
use		0..1	cs	If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced
family		1..1	ENXP
qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
given	C	1..*	ENXP	81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
prefix		0..*	ENXP
qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
suffix		0..1	ENXP
qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
PN.family.qualifier	required	EntityPersonNamePartQualifier
PN.given.qualifier	required	EntityPersonNamePartQualifier
PN.prefix.qualifier	required	EntityPersonNamePartQualifier
PN.suffix.qualifier	required	EntityPersonNamePartQualifier

Constraints

Id	Grade	Path(s)	Details	Requirements
81-7163	warning	PN.given	The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). :
81-7278	error	PN	**SHALL NOT** have mixed content except for white space (CONF:81-7278). :

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, delimiter, family, given, prefix, suffix, other, validTime Base for all types and resources 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
@use		0..1	cs	If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: EntityNameUse (required)
family		1..1	ENXP
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
given	C	1..*	ENXP	81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
prefix		0..*	ENXP
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
suffix		0..1	ENXP
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
PN.use	required	EntityNameUse
PN.family.qualifier	required	EntityPersonNamePartQualifier
PN.given.qualifier	required	EntityPersonNamePartQualifier
PN.prefix.qualifier	required	EntityPersonNamePartQualifier
PN.suffix.qualifier	required	EntityPersonNamePartQualifier

Constraints

Id	Grade	Path(s)	Details	Requirements
81-7163	warning	PN.given	The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). :
81-7278	error	PN	**SHALL NOT** have mixed content except for white space (CONF:81-7278). :
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
pn-no-ls	error	PN	No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').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, delimiter, family, given, prefix, suffix, other, validTime Base for all types and resources 81-7278: **SHALL NOT** have mixed content except for white space (CONF:81-7278).
@nullFlavor		0..1	cs	Binding: NullFlavor (required)
@use		0..1	cs	If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced Binding: EntityNameUse (required)
delimiter		0..*	ENXP
family		1..1	ENXP
@nullFlavor		0..1	cs	Binding: NullFlavor (required)
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
data[x]		0..1	st
@partType		0..1	cs	Binding: EntityNamePartType (required)
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
given	C	1..*	ENXP	81-7163: The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163).
@nullFlavor		0..1	cs	Binding: NullFlavor (required)
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
data[x]		0..1	st
@partType		0..1	cs	Binding: EntityNamePartType (required)
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
prefix		0..*	ENXP
@nullFlavor		0..1	cs	Binding: NullFlavor (required)
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
data[x]		0..1	st
@partType		0..1	cs	Binding: EntityNamePartType (required)
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
suffix		0..1	ENXP
@nullFlavor		0..1	cs	Binding: NullFlavor (required)
@representation		0..1	cs	Fixed Value: TXT
@mediaType		0..1	cs	Fixed Value: text/plain
@language		0..1	cs
data[x]		0..1	st
@partType		0..1	cs	Binding: EntityNamePartType (required)
@qualifier		0..1	cs	Binding: EntityPersonNamePartQualifier (required)
other		0..1	st
validTime		0..1	IVL_TS
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
PN.nullFlavor	required	NullFlavor
PN.use	required	EntityNameUse
PN.family.nullFlavor	required	NullFlavor
PN.family.partType	required	EntityNamePartType
PN.family.qualifier	required	EntityPersonNamePartQualifier
PN.given.nullFlavor	required	NullFlavor
PN.given.partType	required	EntityNamePartType
PN.given.qualifier	required	EntityPersonNamePartQualifier
PN.prefix.nullFlavor	required	NullFlavor
PN.prefix.partType	required	EntityNamePartType
PN.prefix.qualifier	required	EntityPersonNamePartQualifier
PN.suffix.nullFlavor	required	NullFlavor
PN.suffix.partType	required	EntityNamePartType
PN.suffix.qualifier	required	EntityPersonNamePartQualifier

Constraints

Id	Grade	Path(s)	Details	Requirements
81-7163	warning	PN.given	The second occurrence of given (given[2]) if provided, SHALL include middle name or middle initial (CONF:81-7163). :
81-7278	error	PN	**SHALL NOT** have mixed content except for white space (CONF:81-7278). :
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
pn-no-ls	error	PN	No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()

This structure is derived from PN

Summary

Mandatory: 2 elements

Other representations of profile: CSV, Excel