18.3.12 XTN - extended telecommunication number (2A.3.91)

HL7 Component Table - XTN - Extended Telecommunication Number

Core Framework									Base Standard Profile
Seq#	Description	Interpretation	Flags	Cardinality	Length	C.LEN	Vocabulary	Data Type	Implement	Cardinality	Vocabulary
XTN
1	Telephone Number		W	[0..0]				-	SHALL NOT
2	Telecommunication Use Code			[0..1]			telecommunicationUse (CD VS)	ID			(CS)
3	Telecommunication Equipment Type			[1..1]			telecommunicationEquipmentType (CD VS)	ID	SHALL		(CS)
4	Communication Address			C Condition defined for this element [1..1] [0..0]				ST	MAY
5	Country Code			[0..1]				SNM
6	Area/City Code			[0..1]				SNM
7	Local Number			C Condition defined for this element [1..1] [0..0]				SNM	MAY
8	Extension			C Condition defined for this element [1..1] [0..0]				SNM	MAY
9	Any Text			[0..1]				ST
10	Extension Prefix			[0..1]				ST
11	Speed Dial Code			[0..1]				ST
12	Unformatted Telephone Number			C Condition defined for this element [1..1] [0..0]				ST	MAY
13	Effective Start Date			[0..1]				DTM
14	Expiration Date			[0..1]				DTM
15	Expiration Reason			[0..1]			telecommunicationExpirationReason (CD VS)	CWE			(CS)
16	Protection Code			[0..1]			protection (CD VS)	CWE			(CS)
17	Shared Telecommunication Identifier			[0..1]				EI
18	Preference Order			[0..1]				NM

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:

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:

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:

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:

The field would be transmitted as follows:

^WPN^Internet^someone@somewhere.com

18.3.12.1 Telephone Number (2A.3.91.0)

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.

18.3.12.2 Telecommunication Use Code (ID) (2A.3.91.1)

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.

18.3.12.3 Telecommunication Equipment Type (ID) (2A.3.91.2)

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.

18.3.12.4 Communication Address (ST) (2A.3.91.3)

18.3.12.5 Country Code (SNM) (2A.3.91.4)

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.

18.3.12.6 Area/City Code (SNM) (2A.3.91.5)

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.

18.3.12.7 Local Number (SNM) (2A.3.91.6)

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.

18.3.12.8 Extension (SNM) (2A.3.91.7)

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.

18.3.12.9 Any Text (ST) (2A.3.91.8)

Definition: Contains comments with respect to the telephone number.

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

18.3.12.10 Extension Prefix (ST) (2A.3.91.9)

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