au-Telecom
type: StructureDefinition
node role: treeRoot
id:
  v: au-Telecom
text:
  status:
    v: generated
  div: A telephone number (voice or fax), e-mail address, or other locator for a resource (information or service) mediated by telecommunication equipment. The address is specified as a Universal Resource Locator (URL) qualified by time specification and use codes that help in deciding which address to use for a given time and purpose.
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
  value: integer
    v: 1
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-target
  value: boolean
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/data-absent-reason
      value: code
        v: not-applicable
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
  value: uri
    v: urn:hl7-org:v3
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-container
  value: uri
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
url:
  v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom
version:
  v: 1.0.1
name:
  v: TEL
title:
  v: ADHA TEL: TelecommunicationAddress (V3 Data Type)
status:
  v: active
experimental:
  v: false
date:
  v: 2025-10-10T09:58:30+10:00
publisher:
  v: Australian Digital Health Agency
contact:
  name:
    v: Australian Digital Health Agency
  telecom:
    system:
      v: email
description:
  v: **Australian adaptation of the [HL7 International CDA TelecommunicationAddress datatype]( https://hl7.org/cda/stds/core/2.0.1-sd/StructureDefinition-TEL.html)**. This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: AU
copyright:
  v: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/).
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: http://hl7.org/cda/stds/core/StructureDefinition/TEL
base definition:
  v: http://hl7.org/cda/stds/core/StructureDefinition/ANY
  link: http://hl7.org/cda/stds/core/StructureDefinition/ANY
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    value: string
      v: 1.0.1
  element:
    id:
      v: TEL
    path:
      v: TEL
    short:
      v: Australian adaptation of the HL7 International CDA TelecommunicationAddress datatype
    definition:
      v: The electronic communication details of entities
    min:
      v: 1
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: value-null
      severity:
        v: error
      human:
        v: value and nullFlavor are mutually exclusive (one must be present)
      expression:
        v: (value | nullFlavor).count() = 1
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: TEL.nullFlavor
    path:
      v: TEL.nullFlavor
    representation:
      v: xmlAttr
    label:
      v: Exceptional Value Detail
    definition:
      v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: ANY.nullFlavor
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: code
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
        link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    binding:
      strength:
        v: required
      value set:
        v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
        link: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
  element:
    id:
      v: TEL.value
    path:
      v: TEL.value
    representation:
      v: xmlAttr
    definition:
      v: 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.
    comment:
      v: Makes up part of the value attribute as ‘tel:phone number’, ‘mailto:email address’, ‘http:URL’, etc.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: TEL.value
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: url
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/url
        link: http://hl7.org/cda/stds/core/StructureDefinition/url
  element:
    id:
      v: TEL.useablePeriod
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype
      value: canonical
        v: http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
        link: http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
    path:
      v: TEL.useablePeriod
    representation:
      v: typeAttr
    label:
      v: Useable Period

v: 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.

v: 0

v: *

path:
  v: TEL.useablePeriod
min:
  v: 0
max:
  v: *

id:
  v: TEL.use
path:
  v: TEL.use
representation:
  v: xmlAttr
label:
  v: Use Code
definition:
  v: The manner of use that is applied to an electronic communication medium.
comment:
  v: 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
min:
  v: 0
max:
  v: 1
base:
  path:
    v: TEL.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0
    link: 2.0
    link: .0

element:
  id:
    v: TEL
  path:
    v: TEL
  short:
    v: Australian adaptation of the HL7 International CDA TelecommunicationAddress datatype
  definition:
    v: The electronic communication details of entities
  min:
    v: 1
  max:
    v: *
  constraint:
    key:
      v: value-null
    severity:
      v: error
    human:
      v: value and nullFlavor are mutually exclusive (one must be present)
    expression:
      v: (value | nullFlavor).count() = 1
element:
  id:
    v: TEL.value
  path:
    v: TEL.value
  representation:
    v: xmlAttr
  definition:
    v: 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.
  comment:
    v: Makes up part of the value attribute as ‘tel:phone number’, ‘mailto:email address’, ‘http:URL’, etc.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: url
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/url
      link: http://hl7.org/cda/stds/core/StructureDefinition/url
element:
  id:
    v: TEL.useablePeriod
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype
    value: canonical
      v: http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
      link: http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
  path:
    v: TEL.useablePeriod
  representation:
    v: typeAttr
  label:
    v: Useable Period
  definition:
    v: 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.
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
element:
  id:
    v: TEL.use
  path:
    v: TEL.use
  representation:
    v: xmlAttr
  label:
    v: Use Code
  definition:
    v: The manner of use that is applied to an electronic communication medium.
  comment:
    v: 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
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: code
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
  binding:
    strength:
      v: required
    value set:
      v: http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0
      link: 2.0
      link: .0