The Demo site for our new HL7 Version 2+ (plus) Standard
visit the hl7 website

Draft Website - For Review Purposes Only

XTN - extended telecommunication number

HL7 Component Table - XTN - extended telecommunication number
Seq# Description Implement Flags Cardinality Length C.LEN Vocabulary Data Type
XTN
1 Telephone Number [0..1]    
2 Telecommunication Use Code SHALL [0..1] [3..3]     0201 ID
3 Telecommunication Equipment Type SHALL [0..1] [2..8]     0202 ID
4

Communication Address MAY
True:
False:
C =
[1..1]
[0..1]
199 ST
5 Country Code = [0..1]   3 SNM
6 Area/City Code = [0..1]   3 SNM
7

Local Number MAY
True:
False:
C =
[1..1]
[0..1]
  9 SNM
8

Extension MAY
True:
False:
C =
[1..1]
[0..1]
  5 SNM
9 Any Text # [0..1] 199 ST
10 Extension Prefix = [0..1]   4 ST
11 Speed Dial Code = [0..1]   6 ST
12

Unformatted Telephone Number MAY
True:
False:
C #
[1..1]
[0..1]
199 ST
13 Effective Start Date [0..1]     DTM
14 Expiration Date [0..1]     DTM
15 Expiration Reason [0..1]     0868 CWE
16 Protection Code [0..1]     0618 CWE
17 Shared Telecommunication Identifier [0..1]     EI
18 Preference Order = [0..1]   2 NM

Components: <WITHDRAWN Telephone Number> & <Telecommunication Use Code (ID)> & <Telecommunication Equipment Type (ID)> & <Communication Address (ST)> & <Country Code (SNM)> & <Area/City Code (SNM)> & <Local Number (SNM)> & <Extension (SNM)> & <Any Text (ST)> & <Extension Prefix (ST)> & <Speed Dial Code (ST)> & <Unformatted Telephone Number (ST)> & <Effective Start Date (DTM)> & <Expiration Date (DTM)> & <Expiration Reason (CWE)> & <Protection Code (CWE)> & <Shared Telecommunication Identifier (EI)> & <Preference Order (NM)>

Subcomponents for Expiration Reason (CWE): <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier (ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^ <Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^ <Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate Value Set Version ID (DTM)>

Subcomponents for Protection Code (CWE): <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier (ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^ <Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^ <Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate Value Set Version ID (DTM)>

Subcomponents for Shared Telecommunication Identifier (EI): <Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>

Example 1: A Work fax number

^WPN^FX^^^734^6777777

Example 2: Telephone number with extension

^WPN^PH^^^734^6777777^1

Example 2: Telephone number with internal code. In this example, assume that a corporation's telephone system supports a full external telephone number (area code and telephone number). It also supports internal dialing standards that assign a code to each facility and an extension to each telephone (which happens to be the last 4 digits of the external telephone number, by convention).

So, if the Los Angeles facility were assigned code 333, and if the "outside" telephone number at the LA office is (626) 555-1234, the components would be:

Component

Value

area/city code

626

phone number

555-1234

extension

1234

extension prefix

333


The field would be transmitted as follows:

^WPN^PH^^^626^5551234^1234^333

Example 3: speed dial. In this example, assume that a corporation's telephone system supports speed dialing numbers. For example, suppose that a corporation has a contract with a travel agency, whose external number is 1-610-555-1234. Since it is so frequently dialed, the company assigns a speed code: #6098. The components would be:

Component

Value

Area/city code

610

Phone number

555-1234

Speed Dial

#6098


The field would be transmitted as follows:

^WPN^PH^^^610^5551234^^^#6098

Example 4: home e-mail address. In this example, assume that a person has a primary home e-mail address such as someone@somewhere.com. The components would be:

Component

Value

Telecommunication Use Code

PRN

Telecommunication Equipment Type

Internet

Communication Address

someone@somewhere.com


The field would be transmitted as follows:

^PRN^Internet^someone@somewhere.com

Example 5: work e-mail address. In this example, assume that a person has a work e-mail address such as someone@somewhere.com. The components would be:

Component

Value

Telecommunication Use Code

WPN

Telecommunication Equipment Type

Internet

Communication Address

someone@somewhere.com


The field would be transmitted as follows:

^WPN^Internet^someone@somewhere.com

XTN-1: Telephone Number (XTN)

Attention: The XTN-1 component was deprecated as of v2.3 and the detail was withdrawn and removed from the standard as of v2.6.

XTN-2: Telecommunication Use Code (ID)

Definition: A code that represents a specific use of a telecommunication number. Refer to HL7 Table 0201 - Telecommunication Use Code for valid values. This component along with XTN.3 describes the nature of the telecommunication data that follows. Best practice requires the population of XTN.2 when XTN.4 or XTN.7 is populated.

XTN-3: Telecommunication Equipment Type (ID)

Definition: A code that represents the type of telecommunication equipment. Refer to HL7 Table 0202 - Telecommunication Equipment Type for valid values. This component along with XTN.2 describes the nature of the telecommunication data that follows and is necessary to accurately interpret it.

XTN-4: Communication Address (ST)

Note: This component is required if, and only allowed if, XTN.7 or XTN.12 are not populated.

Note: If any of the HL7 delimiters are found in the Communication Address, such as @, the appropriate HL7 escape sequence SHALL be used when encoding an Internet address (see Chapter 2, "Control", section 2.7.1, "Formatting Codes").


XTN-5: Country Code (SNM)

Definition: The numeric code assigned by the International Telecommunication Union in standard E.164 to access telephone services in another country. For example, "+1" is the country code for the United States, "+49" is the code for Germany.

XTN-6: Area/City Code (SNM)

Definition: The numeric code to access telephone services in another area/city within a country. This number historically needs not be dialed if the caller is located in the same area/city as the phone number of the called party.

The use and size of area/city codes is however country specific: some countries do not use area/city codes, or the use of area/city codes may be mandatory when dialing, or area/city codes may be used to group phone numbers based on other criteria than geographic location, such as cell-phone area/city-codes, or free information numbers (e.g., 800 numbers).

Most countries have a prefix for Area/City codes which only has to be dialed if one doesn't use a country code. This prefix (mostly "0", sometimes "9") should be omitted from the content of this field. If the prefix for the Area/Code is also mandatory if one uses the country code (e.g., in Italy) then this field should also contain the prefix.

XTN-7: Local Number (SNM)

Definition: The numeric code used to contact the called party, exclusive of country and area/city codes. The Local Number is required when, and allowed only if, XTN.4 and XTN.12 are not populated.

The size of the Local Number is country specific.

Note: The Local Number does not include the numeric codes that have to be dialed once a connection has been established. Examples include (automated) organizational phone systems which allow external callers to dial additional numeric codes. These additional numeric codes should be specified as an extension.


XTN-8: Extension (SNM)

Definition: The numeric code to contact the called party used within an organization, e.g., the number used if both caller and called party are located within the same organization. The extension is often the same as the last few digits of the Local Number. The use of extensions is country and site specific, and may depend on the type of phone system (PBX) used by the organization.

XTN-9: Any Text (ST)

Definition: Contains comments with respect to the telephone number.

Example: |^^^^^^^^Do not use after 5PM|

XTN-10: Extension Prefix (ST)

Definition: The characters established within a company’s internal telephone system network used as a prefix to the Extension component for internal dialing.

Note: The use of Extension Prefix requires that the Extension component be valued and that digits, as well as special characters (e.g., *, #) may be used.


XTN-11: Speed Dial Code (ST)

Definition: The characters established within a company’s internal telephone system used in place of the (external) telephone number to facilitate calling because its length is shorter than that of the telephone number.

Note: Digits, as well as special characters (e.g., *, #) may be used.


XTN-12: Unformatted Telephone Number (ST)

Definition: An expression of the telephone number as an unparsable string. The Unformatted Telephone number is required when, and allowed only if, XTN.4 and XTN.7 are not populated.

The phone number was entered as free text and sending system does not know how to parse it.

Example: |^^^^^^^^^^^1-800-Dentist|

XTN-13: Effective Start Date (DTM)

Definition: The first date, if known, on which the telecommunication number is valid and active.

XTN-14: Expiration Date (DTM)

Definition: The last date, if known, on which the telecommunication number is valid and active.

XTN-15: Expiration Reason (CWE)

Definition: Indicates why this contact number/e-mail was marked as "ended". Refer to User-defined Table 0868 – Telecommunication Expiration Reason for valid values.

XTN-16: Protection Code (CWE)

Definition: Indicates whether this information is considered sensitive or should be protected in some way. Refer to User-defined table 0618 - Protection Code for suggested values.

The specific set of codes and appropriate handling of such telecommunications addresses will vary by jurisdiction and is subject to site-specific negotiation. For example, a provider address marked as 'unlisted' might not be printed in an internal address listing.

XTN-17: Shared Telecommunication Identifier (EI)

Definition: A unique identifier for the phone number or e-mail address.

This component allows a phone number to be uniquely identified, and enables the linking of a single phone number to multiple people and contexts. For example, each member of a family living at the same location would share the same phone number, having the same identifier. A correction to the phone number of one family member could be automatically propagated to other members of the family.

HL7 does not assume responsibility for the processing rules for this component.

XTN-18: Preference Order (NM)

Definition: For an entity having multiple telecommunication addresses, indicates which is the "most preferred" (lowest number) to "least preferred" (highest number).

If the preference order is unique across all usages for a given type, then it indicates the preference across all usages, (e.g. first try my home number, then my business number). If the preference order is unique across all usages and types, then it indicates the preference across all types of telecommunication addresses. (E.g., first try my phone; if that doesn't work, use my pager.) Otherwise, the preference order is assumed to only apply within a specific type and usage.

Preference order numbers need not be sequential (i.e., three numbers with the priority orders of 0, 5 and 15 are legitimate). The preference order numbers must be non-negative.