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 - XML Profile

Active as of 2024-11-22

XML representation of the au-Telecom logical model.

Raw xml | Download


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="au-Telecom"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>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.</p>
    </div>
  </text>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
    <valueBoolean>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
        <valueCode value="not-applicable"/>
      </extension>
    </valueBoolean>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-container">
    <valueUri
              value="http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"/>
  </extension>
  <url
       value="http://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom"/>
  <version value="1.0.0"/>
  <name value="TEL"/>
  <title value="ADHA TEL: TelecommunicationAddress (V3 Data Type)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-11-22T03:02:41+00:00"/>
  <publisher value="Australian Digital Health Agency"/>
  <contact>
    <name value="Australian Digital Health Agency"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:help@digitalhealth.gov.au"/>
    </telecom>
  </contact>
  <description
               value="**Australian adaptation of the [HL7 International CDA TelecommunicationAddress datatype](     https://hl7.org/cda/stds/core/2.0.0-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 value="urn:iso:std:iso:3166"/>
      <code value="AU"/>
    </coding>
  </jurisdiction>
  <copyright
             value="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/)."/>
  <fhirVersion value="5.0.0"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="http://hl7.org/cda/stds/core/StructureDefinition/TEL"/>
  <baseDefinition
                  value="http://hl7.org/cda/stds/core/StructureDefinition/ANY"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="TEL">
      <path value="TEL"/>
      <short
             value="Australian adaptation of the HL7 International CDA TelecommunicationAddress datatype"/>
      <definition value="The electronic communication details of entities"/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <constraint>
        <key value="value-null"/>
        <severity value="error"/>
        <human
               value="value and nullFlavor are mutually exclusive (one must be present)"/>
        <expression value="(value | nullFlavor).count() = 1"/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="TEL.nullFlavor">
      <path value="TEL.nullFlavor"/>
      <representation value="xmlAttr"/>
      <label value="Exceptional Value Detail"/>
      <definition
                  value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ANY.nullFlavor"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
      </binding>
    </element>
    <element id="TEL.value">
      <path value="TEL.value"/>
      <representation value="xmlAttr"/>
      <definition
                  value="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
               value="Makes up part of the value attribute as ‘tel:phone number’, ‘mailto:email address’, ‘http:URL’, etc."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="TEL.value"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="url"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/url"/>
      </type>
    </element>
    <element id="TEL.useablePeriod">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype">
        <valueCanonical
                        value="http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"/>
      </extension>
      <path value="TEL.useablePeriod"/>
      <representation value="typeAttr"/>
      <label value="Useable Period"/>
      <definition
                  value="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 value="0"/>
      <max value="*"/>
      <base>
        <path value="TEL.useablePeriod"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"/>
      </type>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"/>
      </type>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"/>
      </type>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"/>
      </type>
    </element>
    <element id="TEL.use">
      <path value="TEL.use"/>
      <representation value="xmlAttr"/>
      <label value="Use Code"/>
      <definition
                  value="The manner of use that is applied to an electronic communication medium."/>
      <comment
               value="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 value="0"/>
      <max value="1"/>
      <base>
        <path value="TEL.use"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0"/>
      </binding>
    </element>
  </snapshot>
  <differential>
    <element id="TEL">
      <path value="TEL"/>
      <short
             value="Australian adaptation of the HL7 International CDA TelecommunicationAddress datatype"/>
      <definition value="The electronic communication details of entities"/>
      <min value="1"/>
      <max value="*"/>
      <constraint>
        <key value="value-null"/>
        <severity value="error"/>
        <human
               value="value and nullFlavor are mutually exclusive (one must be present)"/>
        <expression value="(value | nullFlavor).count() = 1"/>
      </constraint>
    </element>
    <element id="TEL.value">
      <path value="TEL.value"/>
      <representation value="xmlAttr"/>
      <definition
                  value="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
               value="Makes up part of the value attribute as ‘tel:phone number’, ‘mailto:email address’, ‘http:URL’, etc."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="url"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/url"/>
      </type>
    </element>
    <element id="TEL.useablePeriod">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-defaulttype">
        <valueCanonical
                        value="http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"/>
      </extension>
      <path value="TEL.useablePeriod"/>
      <representation value="typeAttr"/>
      <label value="Useable Period"/>
      <definition
                  value="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 value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"/>
      </type>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS"/>
      </type>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"/>
      </type>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS"/>
      </type>
    </element>
    <element id="TEL.use">
      <path value="TEL.use"/>
      <representation value="xmlAttr"/>
      <label value="Use Code"/>
      <definition
                  value="The manner of use that is applied to an electronic communication medium."/>
      <comment
               value="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 value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0"/>
      </binding>
    </element>
  </differential>
</StructureDefinition>