IVL_TS: Interval (V3 Data Type) - Definitions - Clinical Document Architecture with Australian Schema v1.0.0

Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions

Logical Model: IVL_TS - Detailed Descriptions

Active as of 2024-11-22

Definitions for the IVL-TS logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. IVL_TS
Control	1..*
Logical Container	ADHA 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())`)
2. IVL_TS.low
Definition	This is the low limit of the interval.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label	Low Boundary
4. 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
6. 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
8. IVL_TS.high
Definition	This is the high limit of the interval.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label	High Boundary

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	ADHA 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())`)
2. IVL_TS.low
Definition	This is the low limit of the interval.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label	Low Boundary
4. 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
6. 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
8. IVL_TS.high
Definition	This is the high limit of the interval.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label	High Boundary

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	ADHA 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())`)
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.
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.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label	Low Boundary
10. 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
12. 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
14. IVL_TS.high
Definition	This is the high limit of the interval.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label	High Boundary