HL7 v2+ Specification
0.0.0 - draft

HL7 v2+ Specification, published by HL7 International. This guide is not an authorized publication; it is the continuous build for version 0.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2ig/ and changes regularly. See the Directory of published versions

Logical Model: HL7 v2 XTN Data Type

Official URL: http://hl7.org/v2/StructureDefinition/XTN Version: 0.0.0
Standards status: Informative Computable Name: XTN

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:

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">

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:

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">

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:

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">

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:

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">

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

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from V2ComplexDataType

NameFlagsCard.TypeDescription & Constraintsdoco
.. XTN 0..* V2ComplexDataType extended telecommunication number
Instances of this logical model are not marked to be the target of a Reference
... 1 Telephone Number
... 2 0..1 code Telecommunication Use Code
Binding: hl7VS-telecommunicationUseCode (required)
... 3 1..1 code Telecommunication Equipment Type
Binding: hl7VS-telecommunicationEquipmentType (required)
... 5 0..1 string Country Code
... 6 0..1 string Area/City Code
... 7 0..1 string Local Number
... 8 0..1 string Extension
... 9 0..1 string Any Text
... 10 0..1 string Extension Prefix
... 11 0..1 string Speed Dial Code
... 12 0..1 string Unformatted Telephone Number
... 13 0..1 dateTime Effective Start Date
... 14 0..1 dateTime Expiration Date
... 15 0..1 CWE Expiration Reason
Binding: hl7VS-telecommunicationExpirationReason (required)
... 16 0..1 CWE Protection Code
Binding: hl7VS-protectionCode (required)
... 17 0..1 EI Shared Telecommunication Identifier
... 18 0..1 decimal Preference Order

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
XTN.2requiredHl7VSTelecommunicationUseCode
http://terminology.hl7.org/ValueSet/v2-0201
XTN.3requiredHl7VSTelecommunicationEquipmentType
http://terminology.hl7.org/ValueSet/v2-0202
XTN.15requiredHl7VSTelecommunicationExpirationReason
http://terminology.hl7.org/ValueSet/v2-0868
XTN.16requiredHl7VSProtectionCode
http://terminology.hl7.org/ValueSet/v2-0618
NameFlagsCard.TypeDescription & Constraintsdoco
.. XTN 0..* V2ComplexDataType extended telecommunication number
Instances of this logical model are not marked to be the target of a Reference
... 1 Telephone Number
... 2 0..1 code Telecommunication Use Code
Binding: hl7VS-telecommunicationUseCode (required)
... 3 1..1 code Telecommunication Equipment Type
Binding: hl7VS-telecommunicationEquipmentType (required)
... 5 0..1 string Country Code
... 6 0..1 string Area/City Code
... 7 0..1 string Local Number
... 8 0..1 string Extension
... 9 0..1 string Any Text
... 10 0..1 string Extension Prefix
... 11 0..1 string Speed Dial Code
... 12 0..1 string Unformatted Telephone Number
... 13 0..1 dateTime Effective Start Date
... 14 0..1 dateTime Expiration Date
... 15 0..1 CWE Expiration Reason
Binding: hl7VS-telecommunicationExpirationReason (required)
... 16 0..1 CWE Protection Code
Binding: hl7VS-protectionCode (required)
... 17 0..1 EI Shared Telecommunication Identifier
... 18 0..1 decimal Preference Order

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
XTN.2requiredHl7VSTelecommunicationUseCode
http://terminology.hl7.org/ValueSet/v2-0201
XTN.3requiredHl7VSTelecommunicationEquipmentType
http://terminology.hl7.org/ValueSet/v2-0202
XTN.15requiredHl7VSTelecommunicationExpirationReason
http://terminology.hl7.org/ValueSet/v2-0868
XTN.16requiredHl7VSProtectionCode
http://terminology.hl7.org/ValueSet/v2-0618
NameFlagsCard.TypeDescription & Constraintsdoco
.. XTN 0..* V2ComplexDataType extended telecommunication number
Instances of this logical model are not marked to be the target of a Reference
... 1 Telephone Number
... 2 0..1 code Telecommunication Use Code
Binding: hl7VS-telecommunicationUseCode (required)
... 3 1..1 code Telecommunication Equipment Type
Binding: hl7VS-telecommunicationEquipmentType (required)
... 5 0..1 string Country Code
... 6 0..1 string Area/City Code
... 7 0..1 string Local Number
... 8 0..1 string Extension
... 9 0..1 string Any Text
... 10 0..1 string Extension Prefix
... 11 0..1 string Speed Dial Code
... 12 0..1 string Unformatted Telephone Number
... 13 0..1 dateTime Effective Start Date
... 14 0..1 dateTime Expiration Date
... 15 0..1 CWE Expiration Reason
Binding: hl7VS-telecommunicationExpirationReason (required)
... 16 0..1 CWE Protection Code
Binding: hl7VS-protectionCode (required)
... 17 0..1 EI Shared Telecommunication Identifier
... 18 0..1 decimal Preference Order

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
XTN.2requiredHl7VSTelecommunicationUseCode
http://terminology.hl7.org/ValueSet/v2-0201
XTN.3requiredHl7VSTelecommunicationEquipmentType
http://terminology.hl7.org/ValueSet/v2-0202
XTN.15requiredHl7VSTelecommunicationExpirationReason
http://terminology.hl7.org/ValueSet/v2-0868
XTN.16requiredHl7VSProtectionCode
http://terminology.hl7.org/ValueSet/v2-0618

This structure is derived from V2ComplexDataType

Summary

Mandatory: 0 element(1 nested mandatory element)

Differential View

This structure is derived from V2ComplexDataType

NameFlagsCard.TypeDescription & Constraintsdoco
.. XTN 0..* V2ComplexDataType extended telecommunication number
Instances of this logical model are not marked to be the target of a Reference
... 1 Telephone Number
... 2 0..1 code Telecommunication Use Code
Binding: hl7VS-telecommunicationUseCode (required)
... 3 1..1 code Telecommunication Equipment Type
Binding: hl7VS-telecommunicationEquipmentType (required)
... 5 0..1 string Country Code
... 6 0..1 string Area/City Code
... 7 0..1 string Local Number
... 8 0..1 string Extension
... 9 0..1 string Any Text
... 10 0..1 string Extension Prefix
... 11 0..1 string Speed Dial Code
... 12 0..1 string Unformatted Telephone Number
... 13 0..1 dateTime Effective Start Date
... 14 0..1 dateTime Expiration Date
... 15 0..1 CWE Expiration Reason
Binding: hl7VS-telecommunicationExpirationReason (required)
... 16 0..1 CWE Protection Code
Binding: hl7VS-protectionCode (required)
... 17 0..1 EI Shared Telecommunication Identifier
... 18 0..1 decimal Preference Order

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
XTN.2requiredHl7VSTelecommunicationUseCode
http://terminology.hl7.org/ValueSet/v2-0201
XTN.3requiredHl7VSTelecommunicationEquipmentType
http://terminology.hl7.org/ValueSet/v2-0202
XTN.15requiredHl7VSTelecommunicationExpirationReason
http://terminology.hl7.org/ValueSet/v2-0868
XTN.16requiredHl7VSProtectionCode
http://terminology.hl7.org/ValueSet/v2-0618

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. XTN 0..* V2ComplexDataType extended telecommunication number
Instances of this logical model are not marked to be the target of a Reference
... 1 Telephone Number
... 2 0..1 code Telecommunication Use Code
Binding: hl7VS-telecommunicationUseCode (required)
... 3 1..1 code Telecommunication Equipment Type
Binding: hl7VS-telecommunicationEquipmentType (required)
... 5 0..1 string Country Code
... 6 0..1 string Area/City Code
... 7 0..1 string Local Number
... 8 0..1 string Extension
... 9 0..1 string Any Text
... 10 0..1 string Extension Prefix
... 11 0..1 string Speed Dial Code
... 12 0..1 string Unformatted Telephone Number
... 13 0..1 dateTime Effective Start Date
... 14 0..1 dateTime Expiration Date
... 15 0..1 CWE Expiration Reason
Binding: hl7VS-telecommunicationExpirationReason (required)
... 16 0..1 CWE Protection Code
Binding: hl7VS-protectionCode (required)
... 17 0..1 EI Shared Telecommunication Identifier
... 18 0..1 decimal Preference Order

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
XTN.2requiredHl7VSTelecommunicationUseCode
http://terminology.hl7.org/ValueSet/v2-0201
XTN.3requiredHl7VSTelecommunicationEquipmentType
http://terminology.hl7.org/ValueSet/v2-0202
XTN.15requiredHl7VSTelecommunicationExpirationReason
http://terminology.hl7.org/ValueSet/v2-0868
XTN.16requiredHl7VSProtectionCode
http://terminology.hl7.org/ValueSet/v2-0618

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. XTN 0..* V2ComplexDataType extended telecommunication number
Instances of this logical model are not marked to be the target of a Reference
... 1 Telephone Number
... 2 0..1 code Telecommunication Use Code
Binding: hl7VS-telecommunicationUseCode (required)
... 3 1..1 code Telecommunication Equipment Type
Binding: hl7VS-telecommunicationEquipmentType (required)
... 5 0..1 string Country Code
... 6 0..1 string Area/City Code
... 7 0..1 string Local Number
... 8 0..1 string Extension
... 9 0..1 string Any Text
... 10 0..1 string Extension Prefix
... 11 0..1 string Speed Dial Code
... 12 0..1 string Unformatted Telephone Number
... 13 0..1 dateTime Effective Start Date
... 14 0..1 dateTime Expiration Date
... 15 0..1 CWE Expiration Reason
Binding: hl7VS-telecommunicationExpirationReason (required)
... 16 0..1 CWE Protection Code
Binding: hl7VS-protectionCode (required)
... 17 0..1 EI Shared Telecommunication Identifier
... 18 0..1 decimal Preference Order

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
XTN.2requiredHl7VSTelecommunicationUseCode
http://terminology.hl7.org/ValueSet/v2-0201
XTN.3requiredHl7VSTelecommunicationEquipmentType
http://terminology.hl7.org/ValueSet/v2-0202
XTN.15requiredHl7VSTelecommunicationExpirationReason
http://terminology.hl7.org/ValueSet/v2-0868
XTN.16requiredHl7VSProtectionCode
http://terminology.hl7.org/ValueSet/v2-0618

This structure is derived from V2ComplexDataType

Summary

Mandatory: 0 element(1 nested mandatory element)

 

Other representations of profile: CSV, Excel