Clinical Document Architecture
2.0.1-sd - release
Clinical Document Architecture
2.0.1-sd - release
This page is part of the CDA: Clinical Document Architecture (v2.0.1-sd: CDA 2.0 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
| Active as of 2024-12-18 |
Definitions for the ON logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. ON | |
| Definition | A name for an organization. A sequence of name parts. Examples for organization name values are "Health Level Seven, Inc.", "Hospital", etc. An organization name may be as simple as a character string or may consist of several person name parts, such as, "Health Level 7", "Inc.". ON differs from EN because certain person related name parts are not possible. |
| Control | 1..* |
| Logical Container | ClinicalDocument (CDA Class) |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. ON.item | |
| 4. ON.item.family | |
| Control | 0..0 |
| 6. ON.item.given | |
| Control | 0..0 |
Guidance on how to interpret the contents of this table can be found here
| 0. ON | |
| Definition | A name for an organization. A sequence of name parts. Examples for organization name values are "Health Level Seven, Inc.", "Hospital", etc. An organization name may be as simple as a character string or may consist of several person name parts, such as, "Health Level 7", "Inc.". ON differs from EN because certain person related name parts are not possible. Base definition for all types defined in FHIR type system. |
| Short | Base for all types and resources |
| Control | 10..* |
| Is Modifier | false |
| Logical Container | ClinicalDocument (CDA Class) |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. ON.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| 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. ON.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 CDAEntityNameUse (required to http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse) |
| 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. ON.item | |
| Definition | A series of items that constitute the name. |
| Control | 0..* |
| Type | http://hl7.org/fhir/StructureDefinition/Base |
| Choice Group | This is a repeating choice group that does not appear directly in the instance |
| Invariants | EN-1: Can only have only one of the possible item elements in each choice ((delimiter | family | given | prefix | suffix | xmlText).count() = 1) |
| 8. ON.item.delimiter | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 10. ON.item.family | |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 12. ON.item.given | |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 14. ON.item.prefix | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 16. ON.item.suffix | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 18. ON.item.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. |
| 20. ON.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 |
Guidance on how to interpret the contents of this table can be found here
| 0. ON | |
| Definition | A name for an organization. A sequence of name parts. Examples for organization name values are "Health Level Seven, Inc.", "Hospital", etc. An organization name may be as simple as a character string or may consist of several person name parts, such as, "Health Level 7", "Inc.". ON differs from EN because certain person related name parts are not possible. |
| Short | Base for all types and resources |
| Control | 1..* |
| Is Modifier | false |
| Logical Container | ClinicalDocument (CDA Class) |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| 2. ON.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor) |
| 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. ON.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 CDAEntityNameUse (required to http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse) |
| 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. ON.item | |
| Definition | A series of items that constitute the name. |
| Control | 0..* |
| Type | http://hl7.org/fhir/StructureDefinition/Base |
| Choice Group | This is a repeating choice group that does not appear directly in the instance |
| Invariants | EN-1: Can only have only one of the possible item elements in each choice ((delimiter | family | given | prefix | suffix | xmlText).count() = 1) |
| 8. ON.item.delimiter | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 10. ON.item.family | |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 12. ON.item.given | |
| Control | 0..0 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 14. ON.item.prefix | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 16. ON.item.suffix | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ENXP |
| 18. ON.item.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. |
| 20. ON.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 |
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.1-sd based on FHIR 5.0.0. Generated 2024-12-18
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change