Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions
Active as of 2023-10-03 |
Definitions for the TN logical model.
Guidance on how to interpret the contents of this table can be found here
0. EN | |
Definition | A restriction of entity name that is effectively a simple string used for a simple name for things and places. |
Control | 1..* |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 .The children of this property can appear in any order in the XML. |
2. EN.use | |
Binding | The codes SHALL be taken from EntityNameUse |
4. EN.delimiter | |
Control | 0..0 |
6. EN.family | |
Control | 0..0 |
8. EN.given | |
Control | 0..0 |
10. EN.prefix | |
Control | 0..0 |
12. EN.suffix | |
Control | 0..0 |
Guidance on how to interpret the contents of this table can be found here
0. EN | |
Definition | A restriction of entity name that is effectively a simple string used for a simple name for things and places. Base definition for all types defined in FHIR type system. |
Short | Base for all types and resources |
Control | 10..* |
Is Modifier | false |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 .The children of this property can appear in any order in the XML. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
2. EN.use | |
Definition | A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose |
Control | 0..* |
Binding | The codes SHALL be taken from EntityNameUse |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Use Code |
4. EN.delimiter | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
6. EN.family | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
8. EN.given | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
10. EN.prefix | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
12. EN.suffix | |
Definition | Element EN.family |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
Guidance on how to interpret the contents of this table can be found here
0. EN | |
Definition | A restriction of entity name that is effectively a simple string used for a simple name for things and places. |
Short | Base for all types and resources |
Control | 1..* |
Is Modifier | false |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 .The children of this property can appear in any order in the XML. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
2. EN.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
4. EN.use | |
Definition | A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose |
Control | 0..* |
Binding | The codes SHALL be taken from EntityNameUse |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Use Code |
6. EN.delimiter | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
8. EN.family | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
10. EN.given | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
12. EN.prefix | |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
14. EN.suffix | |
Definition | Element EN.family |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
16. EN.xmlText | |
Short | Allows for mixed text content |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
18. EN.validTime | |
Definition | An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
Label | Valid Time |