Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 Ballot United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: USRealmDateTimeInterval - Detailed Descriptions

Draft as of 2024-12-19

Definitions for the USRealmDateTimeInterval logical model.

Guidance on how to interpret the contents of this table can be found here

0. IVL_TS
Logical ContainerClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
2. IVL_TS.value
ShortEither @value or low/high should be present, but not both
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
4. IVL_TS.low
Short**MAY** be precise to at least the second
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
6. IVL_TS.low.value
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
8. IVL_TS.high
Short**MAY** be precise to at least the second
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
10. IVL_TS.high.value
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]

Guidance on how to interpret the contents of this table can be found here

0. IVL_TS
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.


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.
Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
2. IVL_TS.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. IVL_TS.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortEither @value or low/high should be present, but not both
Control0..1
TypedateTime(ts: Point in Time)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML FormatIn the XML format, this property is represented as an attribute.
6. IVL_TS.operator
Definition

A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

Control0..1
BindingThe codes SHALL be taken from CDASetOperator
(required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator)
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.
Default ValueI
8. IVL_TS.low
Definition

This is the low limit of the interval.

Short**MAY** be precise to at least the second
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelLow Boundary
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
10. IVL_TS.low.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
12. IVL_TS.low.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Control0..1
TypedateTime(ts: Point in Time)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML FormatIn the XML format, this property is represented as an attribute.
14. IVL_TS.low.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean(bl: Boolean)
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.
Default Valuetrue
16. IVL_TS.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
LabelCentral Value
18. IVL_TS.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
LabelWidth
20. IVL_TS.high
Definition

This is the high limit of the interval.

Short**MAY** be precise to at least the second
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelHigh Boundary
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
22. IVL_TS.high.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
24. IVL_TS.high.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Control0..1
TypedateTime(ts: Point in Time)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML FormatIn the XML format, this property is represented as an attribute.
26. IVL_TS.high.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean(bl: Boolean)
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.
Default Valuetrue

Guidance on how to interpret the contents of this table can be found here

0. IVL_TS
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

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.
Invariantsivl-ts-center: Center cannot co-exist with low or high (center.empty() or (low.empty() and high.empty()))
ivl-value-shall: If a time interval contains @value, then it shall be precise to at least the day. (value.exists() implies value.toString().length() >= 10)
ivl-value-should: If a time interval contains @value, then it SHOULD contain a time component. (value.exists() implies value.toString().length() > 10)
2. IVL_TS.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. IVL_TS.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

ShortEither @value or low/high should be present, but not both
Control0..1
TypedateTime(ts: Point in Time)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML FormatIn the XML format, this property is represented as an attribute.
6. IVL_TS.operator
Definition

A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

Control0..1
BindingThe codes SHALL be taken from CDASetOperator
(required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator)
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.
Default ValueI
8. IVL_TS.low
Definition

This is the low limit of the interval.

Short**MAY** be precise to at least the second
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelLow Boundary
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
10. IVL_TS.low.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
12. IVL_TS.low.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Control0..1
TypedateTime(ts: Point in Time)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML FormatIn the XML format, this property is represented as an attribute.
14. IVL_TS.low.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean(bl: Boolean)
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.
Default Valuetrue
16. IVL_TS.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
LabelCentral Value
18. IVL_TS.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
LabelWidth
20. IVL_TS.high
Definition

This is the high limit of the interval.

Short**MAY** be precise to at least the second
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelHigh Boundary
Invariantsts-shall-day: **SHALL** be precise to at least the day (nullFlavor.exists() or value.toString().length() >= 10)
ts-should-minute: **SHOULD** be precise to at least the minute (nullFlavor.exists() or value.toString().length() > 10)
22. IVL_TS.high.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
24. IVL_TS.high.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Control0..1
TypedateTime(ts: Point in Time)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML FormatIn the XML format, this property is represented as an attribute.
26. IVL_TS.high.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean(bl: Boolean)
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.
Default Valuetrue