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-12-18

Definitions for the au-Telecom logical model.

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

0. TEL
Definition

The electronic communication details of entities

ShortAustralian adaptation of the HL7 International CDA TelecommunicationAddress datatype
Control1..*
Logical ContainerADHA ClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsvalue-null: value and nullFlavor are mutually exclusive (one must be present) ((value | nullFlavor).count() = 1)
2. TEL.value
Definition

A code representing a type of communication mechanism.

A unique combination of characters used as input to electronic telecommunication equipmentforthe purpose of contacting an entity.

Comments

Makes up part of the value attribute as ‘tel:phone number’, ‘mailto:email address’, ‘http:URL’, etc.

Control0..1
Typeurl(url: Universal Resource Locator)
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.
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.

Control0..*
TypeChoice 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 Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
6. TEL.use
Definition

The manner of use that is applied to an electronic communication medium.

Comments

Space separated list of codes. The section AS 5017-2006: Health Care Client Electronic Communication Usage Code explains how to map AS 5017-2006 to HL7 Telecommunication-AddressUse (HL7 TAU) code

Control0..1
BindingThe codes SHALL be taken from TelecommunicationAddressUse (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0)
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.
LabelUse Code

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

0. TEL
Definition

The electronic communication details of entities


Base definition for all types defined in FHIR type system.

ShortAustralian adaptation of the HL7 International CDA TelecommunicationAddress datatypeBase for all types and resources
Control10..*
Is Modifierfalse
Logical ContainerADHA ClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsvalue-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.

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. TEL.value
Definition

A code representing a type of communication mechanism.

A unique combination of characters used as input to electronic telecommunication equipmentforthe purpose of contacting an entity.

Comments

Makes up part of the value attribute as ‘tel:phone number’, ‘mailto:email address’, ‘http:URL’, etc.

Control0..1
Typeurl(url: Universal Resource Locator)
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.
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.

Control0..*
TypeChoice 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 Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
8. TEL.use
Definition

The manner of use that is applied to an electronic communication medium.

Comments

Space separated list of codes. The section AS 5017-2006: Health Care Client Electronic Communication Usage Code explains how to map AS 5017-2006 to HL7 Telecommunication-AddressUse (HL7 TAU) code

Control0..1
BindingThe codes SHALL be taken from TelecommunicationAddressUse (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0)
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.
LabelUse Code

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

0. TEL
Definition

The electronic communication details of entities

ShortAustralian adaptation of the HL7 International CDA TelecommunicationAddress datatype
Control1..*
Is Modifierfalse
Logical ContainerADHA ClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsvalue-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.

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. TEL.value
Definition

A code representing a type of communication mechanism.

A unique combination of characters used as input to electronic telecommunication equipmentforthe purpose of contacting an entity.

Comments

Makes up part of the value attribute as ‘tel:phone number’, ‘mailto:email address’, ‘http:URL’, etc.

Control0..1
Typeurl(url: Universal Resource Locator)
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.
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.

Control0..*
TypeChoice 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 Typehttp://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelUseable Period
8. TEL.use
Definition

The manner of use that is applied to an electronic communication medium.

Comments

Space separated list of codes. The section AS 5017-2006: Health Care Client Electronic Communication Usage Code explains how to map AS 5017-2006 to HL7 Telecommunication-AddressUse (HL7 TAU) code

Control0..1
BindingThe codes SHALL be taken from TelecommunicationAddressUse (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0)
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.
LabelUse Code