Clinical Document Architecture
2.0.0-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.0-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.0-sd
Active as of 2024-05-16 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:

Formal Views of Template Content

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

This structure is derived from ANY

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EN.userequiredCDAEntityNameUse
http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
from this IG

Constraints

IdGradePath(s)DetailsRequirements
EN-1errorEN.itemCan only have only one of the possible item elements in each choice
: (delimiter | family | given | prefix | suffix | xmlText).count() = 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EN.userequiredCDAEntityNameUse
http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
from this IG

Constraints

IdGradePath(s)DetailsRequirements
EN-1errorEN.itemCan only have only one of the possible item elements in each choice
: (delimiter | family | given | prefix | suffix | xmlText).count() = 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EN.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EN.userequiredCDAEntityNameUse
http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
from this IG

Constraints

IdGradePath(s)DetailsRequirements
EN-1errorEN.itemCan 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EN.userequiredCDAEntityNameUse
http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
from this IG

Constraints

IdGradePath(s)DetailsRequirements
EN-1errorEN.itemCan only have only one of the possible item elements in each choice
: (delimiter | family | given | prefix | suffix | xmlText).count() = 1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EN.userequiredCDAEntityNameUse
http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
from this IG

Constraints

IdGradePath(s)DetailsRequirements
EN-1errorEN.itemCan only have only one of the possible item elements in each choice
: (delimiter | family | given | prefix | suffix | xmlText).count() = 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EN.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
EN.userequiredCDAEntityNameUse
http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
from this IG

Constraints

IdGradePath(s)DetailsRequirements
EN-1errorEN.itemCan only have only one of the possible item elements in each choice
: (delimiter | family | given | prefix | suffix | xmlText).count() = 1

 

Other representations of profile: CSV, Excel