EN: EntityName (V3 Data Type) - Clinical Document Architecture v2.0.1-sd

Clinical Document Architecture
2.0.1-sd - release

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.1-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions

Logical Model: EN: EntityName (V3 Data Type)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/EN				Version: 2.0.1-sd
Active as of 2025-04-04				Computable Name: EN

A name for a person, organization, place or thing. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for entity name values are "Jim Bob Walton, Jr.", "Health Level Seven, Inc.", "Lake Tahoe", etc. An entity name may be as simple as a character string or may consist of several entity name parts, such as, "Jim", "Bob", "Walton", and "Jr.", "Health Level Seven" and "Inc.", "Lake" and "Tahoe".

Usage:

Derived from this Logical Model Profile: ON: OrganizationName (V3 Data Type), PN: PersonName (V3 Data Type) and TN: TrivialName (V3 Data Type)
Use this Logical Model Profile: Criterion (CDA Class), LabeledDrug (CDA Class), Material (CDA Class), Observation (CDA Class)... Show 2 more

Formal Views of Template Content

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

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints
EN		1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class)
@use		0..*	cs	Binding: CDAEntityNameUse (required)
item	C	0..*	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 (Differential)

Path	Conformance	ValueSet	URI
EN.use	required	CDAEntityNameUse `http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
EN-1	error	EN.item	Can only have only one of the possible item elements in each choice : (delimiter \| family \| given \| prefix \| suffix \| xmlText).count() = 1

Name	Flags	Card.	Type	Description & Constraints
EN		1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: CDAEntityNameUse (required)
item	C	0..*	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
EN.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
EN.use	required	CDAEntityNameUse `http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
EN-1	error	EN.item	Can only have only one of the possible item elements in each choice : (delimiter \| family \| given \| prefix \| suffix \| xmlText).count() = 1

Name	Flags	Card.	Type	Description & Constraints
EN		1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: CDAEntityNameUse (required)
item	C	0..*	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
EN.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
EN.use	required	CDAEntityNameUse `http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
EN-1	error	EN.item	Can only have only one of the possible item elements in each choice : (delimiter \| family \| given \| prefix \| suffix \| xmlText).count() = 1

Differential View

This structure is derived from ANY

Name	Flags	Card.	Type	Description & Constraints
EN		1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class)
@use		0..*	cs	Binding: CDAEntityNameUse (required)
item	C	0..*	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 (Differential)

Path	Conformance	ValueSet	URI
EN.use	required	CDAEntityNameUse `http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
EN-1	error	EN.item	Can only have only one of the possible item elements in each choice : (delimiter \| family \| given \| prefix \| suffix \| xmlText).count() = 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
EN		1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: CDAEntityNameUse (required)
item	C	0..*	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
EN.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
EN.use	required	CDAEntityNameUse `http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
EN-1	error	EN.item	Can only have only one of the possible item elements in each choice : (delimiter \| family \| given \| prefix \| suffix \| xmlText).count() = 1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
EN		1..*	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor Base for all types and resources Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: CDAEntityNameUse (required)
item	C	0..*	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
EN.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
EN.use	required	CDAEntityNameUse `http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
EN-1	error	EN.item	Can only have only one of the possible item elements in each choice : (delimiter \| family \| given \| prefix \| suffix \| xmlText).count() = 1

This structure is derived from ANY

Summary

Structures

This structure refers to these other structures:

Other representations of profile: CSV, Excel

IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.1-sd based on FHIR 5.0.0. Generated 2025-04-04
Links: Table of Contents | QA Report | Version History external | | Propose a change