PIVL_TS: PeriodicIntervalOfTime (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: PIVL_TS - Detailed Descriptions

Active as of 2024-11-22

Definitions for the PIVL-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. PIVL_TS
Control	1..*
Logical Container	ADHA ClinicalDocument (CDA Class)
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. PIVL_TS.value
Control	0..0
XML Format	In the XML format, this property is represented as an attribute.
4. PIVL_TS.phase
Definition	A prototype of the repeating interval, specifying the duration of each occurrence and anchors the periodic interval sequence at a certain point in time.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Label	Phase
6. PIVL_TS.period
Definition	A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/PQ
Label	Period
8. PIVL_TS.alignment
Definition	Specifies if and how the repetitions are aligned to the cycles of the underlying calendar (e.g., to distinguish every 30 days from "the 5th of every month".) A non-aligned periodic interval recurs independently from the calendar. An aligned periodic interval is synchronized with the calendar.
Control	0..1
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	Alignment to the Calendar
10. PIVL_TS.institutionSpecified
Definition	Indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish "every 8 hours" from "3 times a day".)
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.
Label	Institution Specified Timing

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

0. PIVL_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`.
2. PIVL_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..0
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. PIVL_TS.phase
Definition	A prototype of the repeating interval, specifying the duration of each occurrence and anchors the periodic interval sequence at a certain point in time.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Label	Phase
6. PIVL_TS.period
Definition	A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/PQ
Label	Period
8. PIVL_TS.alignment
Definition	Specifies if and how the repetitions are aligned to the cycles of the underlying calendar (e.g., to distinguish every 30 days from "the 5th of every month".) A non-aligned periodic interval recurs independently from the calendar. An aligned periodic interval is synchronized with the calendar.
Control	0..1
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	Alignment to the Calendar
10. PIVL_TS.institutionSpecified
Definition	Indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish "every 8 hours" from "3 times a day".)
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.
Label	Institution Specified Timing

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

0. PIVL_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`.
2. PIVL_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. PIVL_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..0
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. PIVL_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. PIVL_TS.phase
Definition	A prototype of the repeating interval, specifying the duration of each occurrence and anchors the periodic interval sequence at a certain point in time.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Label	Phase
10. PIVL_TS.period
Definition	A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/PQ
Label	Period
12. PIVL_TS.alignment
Definition	Specifies if and how the repetitions are aligned to the cycles of the underlying calendar (e.g., to distinguish every 30 days from "the 5th of every month".) A non-aligned periodic interval recurs independently from the calendar. An aligned periodic interval is synchronized with the calendar.
Control	0..1
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	Alignment to the Calendar
14. PIVL_TS.institutionSpecified
Definition	Indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish "every 8 hours" from "3 times a day".)
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.
Label	Institution Specified Timing