FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/au-Telecom

Packageau.digitalhealth.cda.schema
TypeStructureDefinition
Idau-Telecom
FHIR VersionR5
Sourcehttp://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-au-Telecom.html
URLhttp://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom
Version1.0.0
Statusactive
Date2025-07-21T22:05:27+00:00
NameTEL
TitleADHA TEL: TelecommunicationAddress (V3 Data Type)
Realmau
Authoritynational
Description**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
CopyrightCopyright © 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/).
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Kindlogical

Resources that use this resource

StructureDefinition
au-AssignedAuthorADHA AssignedAuthor (CDA Class)
au-AssignedEntityADHA AssignedEntity (CDA Class)
au-AssociatedEntityADHA AssociatedEntity (CDA Class)
au-CustodianOrganizationADHA CustodianOrganization (CDA Class)
au-EntityADHA Entity (CDA Class)
au-IntendedRecipientADHA IntendedRecipient (CDA Class)
au-OrganizationADHA Organization (CDA Class)
au-ParticipantRoleADHA ParticipantRole ADHA (CDA Class)
au-PatientRoleADHA PatientRole (CDA Class)
personalRelationshipADHA extension personalRelationship

Resources that this resource uses

StructureDefinition
ANYANY: DataValue (V3 Data Type)
EIVL-TSEIVL_TS: EventRelatedPeriodicInterval (V3 Data Type)
IVL-TSIVL_TS: Interval (V3 Data Type)
PIVL-TSPIVL_TS: PeriodicIntervalOfTime (V3 Data Type)
SXPR-TSSXPR_TS: Component part of GTS (V3 Data Type)
cs-simplecs: Coded Simple Value
urlurl: Universal Resource Locator
ValueSet
v3-TelecommunicationAddressUseTelecommunicationAddressUse
v3-TelecommunicationAddressUseTelecommunicationAddressUse

Narrative

Note: links and images are rebased to the (stated) source

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.


Source

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