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

FHIR IG Statistics: StructureDefinition/TEL

Packageau.digitalhealth.cda.schema
TypeStructureDefinition
IdTEL
FHIR VersionR5
Sourcehttp://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-TEL.html
URLhttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Version1.0.0
Statusactive
Date2025-07-21T22:05:27+00:00
NameTEL
TitleTEL: TelecommunicationAddress (V3 Data Type)
Realmau
Authoritynational
DescriptionA telephone number (voice or fax), e-mail address, or other locator for a resource 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.
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
Kindlogical

Resources that use this resource

StructureDefinition
AssignedAuthorAssignedAuthor (CDA Class)
AssignedEntityAssignedEntity (CDA Class)
AssociatedEntityAssociatedEntity (CDA Class)
CriterionCriterion (CDA Class)
CustodianOrganizationCustodianOrganization (CDA Class)
EDED: EncapsulatedData (V3 Data Type)
GuardianGuardian (CDA Class)
IntendedRecipientIntendedRecipient (CDA Class)
ObservationObservation (CDA Class)
ObservationRangeObservationRange (CDA Class)
OrganizationOrganization (CDA Class)
ParticipantRoleParticipantRole (CDA Class)
PatientRolePatientRole (CDA Class)
RelatedEntityRelatedEntity (CDA Class)
RelatedSubjectRelatedSubject (CDA Class)
au-ObservationADHA Observation (CDA Class)
au-ObservationRangeADHA ObservationRange (CDA Class)
2.16.840.1.113883.10.22.4.37--20200508162154IPS Advance Directive Observation

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": "TEL",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "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://hl7.org/cda/stds/core/StructureDefinition/TEL",
  "version": "1.0.0",
  "name": "TEL",
  "title": "TEL: TelecommunicationAddress (V3 Data Type)",
  "status": "active",
  "experimental": false,
  "date": "2025-07-21T22:05:27+00:00",
  "publisher": "HL7",
  "description": "A telephone number (voice or fax), e-mail address, or other locator for a resource 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.",
  "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": "Base for all types and resources",
        "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.",
        "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"
        ],
        "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": "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.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "TEL.use",
          "min": 0,
          "max": "*"
        },
        "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",
        "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"
        ],
        "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": "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.",
        "min": 0,
        "max": "*",
        "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"
        }
      }
    ]
  }
}