TEL: TelecommunicationAddress (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: TEL - Detailed Descriptions

Active as of 2024-11-22

Definitions for the TEL 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. TEL
Control	1..*
Logical Container	ADHA ClinicalDocument (CDA Class)
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	value-null: value and nullFlavor are mutually exclusive (one must be present) (`(value \| nullFlavor).count() = 1`)
2. TEL.value
Control	0..1
Type	url(url: Universal Resource Locator)
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.
4. TEL.useablePeriod
Definition	Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control	0..*
Type	Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type	http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format	The type of this property is determined using the `xsi:type`attribute.
Label	Useable Period
6. TEL.use
Definition	One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
Control	0..*
Binding	The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse\|2.0.0`)
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	Use Code

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

0. TEL
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. 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	value-null: value and nullFlavor are mutually exclusive (one must be present) (`(value \| nullFlavor).count() = 1`)
2. TEL.value
Control	0..1
Type	url(url: Universal Resource Locator)
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.
4. TEL.useablePeriod
Definition	Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control	0..*
Type	Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type	http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format	The type of this property is determined using the `xsi:type`attribute.
Label	Useable Period
6. TEL.use
Definition	One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
Control	0..*
Binding	The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse\|2.0.0`)
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	Use Code

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

0. TEL
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
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	value-null: value and nullFlavor are mutually exclusive (one must be present) (`(value \| nullFlavor).count() = 1`)
2. TEL.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. TEL.value
Control	0..1
Type	url(url: Universal Resource Locator)
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.
6. TEL.useablePeriod
Definition	Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control	0..*
Type	Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type	http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format	The type of this property is determined using the `xsi:type`attribute.
Label	Useable Period
8. TEL.use
Definition	One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
Control	0..*
Binding	The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse\|2.0.0`)
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	Use Code