This page is part of the CDA: Clinical Document Architecture (v2.0.0-sd: CDA2 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Active as of 2024-05-17 |
JSON representation of the TEL logical model.
{
"resourceType" : "StructureDefinition",
"id" : "TEL",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <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>\n </div>"
},
"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" : "2.0.0-sd",
"name" : "TEL",
"title" : "TEL: TelecommunicationAddress (V3 Data Type)",
"status" : "active",
"experimental" : false,
"date" : "2024-05-17T05:57:28+10:00",
"publisher" : "Health Level 7",
"contact" : [
{
"name" : "HL7 International - Structured Documents",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/structure"
},
{
"system" : "email",
"value" : "structdog@lists.HL7.org"
}
]
}
],
"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" : {
"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"
}
}
]
}
}