Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions
Active as of 2024-10-25 |
XML representation of the TEL logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="TEL"/>
<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://hl7.org/cda/stds/core/StructureDefinition/TEL"/>
<version value="2.0.0-sd"/>
<name value="TEL"/>
<title value="TEL: TelecommunicationAddress (V3 Data Type)"/>
<status value="active"/>
<experimental value="false"/>
<date value="2024-10-25T20:25:09+00:00"/>
<publisher value="Health Level 7"/>
<contact>
<name value="HL7 International - Structured Documents"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/structure"/>
</telecom>
<telecom>
<system value="email"/>
<value value="structdog@lists.HL7.org"/>
</telecom>
</contact>
<description
value="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 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="Base for all types and resources"/>
<definition
value="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 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"/>
<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="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 value="0"/>
<max value="*"/>
<base>
<path value="TEL.use"/>
<min value="0"/>
<max value="*"/>
</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"/>
<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"/>
<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="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 value="0"/>
<max value="*"/>
<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>