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: ON - Detailed Descriptions

Active as of 2024-10-25

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.

Control1..*
Logical ContainerClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ON.item
4. ON.item.family
Control0..0
6. ON.item.given
Control0..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.

ShortBase for all types and resources
Control10..*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.

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.

ShortBase for all types and resources
Control1..*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
XML FormatIn 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.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional 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

Control0..*
BindingThe codes SHALL be taken from CDAEntityNameUse
(required to http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelUse Code
6. ON.item
Definition

A series of items that constitute the name.

Control0..*
Typehttp://hl7.org/fhir/StructureDefinition/Base
Choice GroupThis is a repeating choice group that does not appear directly in the instance
InvariantsEN-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
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
10. ON.item.family
Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
12. ON.item.given
Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
14. ON.item.prefix
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
16. ON.item.suffix
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
18. ON.item.xmlText
ShortAllows 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.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn 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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
LabelValid Time