Consolidated CDA (C-CDA)
4.0.0-ballot - STU4
Consolidated CDA (C-CDA)
4.0.0-ballot - STU4
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
| Draft as of 2024-11-21 |
Definitions for the USRealmDateTimeInterval logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. IVL_TS | |
| Logical Container | ClinicalDocument (CDA Class) |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:v3. |
| Invariants | 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.value | |
| Short | Either @value or low/high should be present, but not both |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| 4. IVL_TS.low | |
| Short | **MAY** be precise to at least the second |
| Invariants | ts-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 Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| 8. IVL_TS.high | |
| Short | **MAY** be precise to at least the second |
| Invariants | ts-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 Format | YYYYMMDDHHMMSS.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. |
| 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. |
| Invariants | ivl-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.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. |
| Short | Either @value or low/high should be present, but not both |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 4. IVL_TS.low | |
| Definition | This is the low limit of the interval. |
| Short | **MAY** be precise to at least the second |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | Low Boundary |
| Invariants | ts-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 | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
| 8. IVL_TS.high | |
| Definition | This is the high limit of the interval. |
| Short | **MAY** be precise to at least the second |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | High Boundary |
| Invariants | ts-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 | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In the XML format, this property is represented as an attribute. |
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. |
| 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. |
| Invariants | ivl-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. |
| 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. 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. |
| Short | Either @value or low/high should be present, but not both |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In 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. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from CDASetOperator (required to http://hl7.org/cda/stds/core/ValueSet/CDASetOperator) |
| 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. |
| Default Value | I |
| 8. IVL_TS.low | |
| Definition | This is the low limit of the interval. |
| Short | **MAY** be precise to at least the second |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | Low Boundary |
| Invariants | ts-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. |
| 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 |
| 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. |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In 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). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| 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. |
| Default Value | true |
| 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. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| Label | Central 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. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| Label | Width |
| 20. IVL_TS.high | |
| Definition | This is the high limit of the interval. |
| Short | **MAY** be precise to at least the second |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS |
| Label | High Boundary |
| Invariants | ts-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. |
| 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 |
| 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. |
| Control | 0..1 |
| Type | dateTime(ts: Point in Time) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz] |
| XML Format | In 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). |
| Control | 0..1 |
| Type | boolean(bl: Boolean) |
| 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. |
| Default Value | true |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#4.0.0-ballot based on FHIR 5.0.0. Generated 2024-11-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change