HL7 v2 XTN Data Type - Definitions - HL7 v2+ Specification v0.0.0

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: XTN - Detailed Descriptions

Page standards status: Informative

Definitions for the XTN logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. XTN
Short	extended telecommunication number
Control	0..*
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. XTN.1
Short	Telephone Number
4. XTN.2
Short	Telecommunication Use Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-telecommunicationUseCode (required to `http://terminology.hl7.org/ValueSet/v2-0201`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. XTN.3
Short	Telecommunication Equipment Type
Control	1..1
Binding	The codes SHALL be taken from hl7VS-telecommunicationEquipmentType (required to `http://terminology.hl7.org/ValueSet/v2-0202`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. XTN.4
Short	Communication Address
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. XTN.5
Short	Country Code
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SNM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. XTN.6
Short	Area/City Code
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SNM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. XTN.7
Short	Local Number
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SNM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. XTN.8
Short	Extension
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SNM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. XTN.9
Short	Any Text
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
20. XTN.10
Short	Extension Prefix
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
22. XTN.11
Short	Speed Dial Code
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. XTN.12
Short	Unformatted Telephone Number
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
26. XTN.13
Short	Effective Start Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. XTN.14
Short	Expiration Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
30. XTN.15
Short	Expiration Reason
Control	0..1
Binding	The codes SHALL be taken from hl7VS-telecommunicationExpirationReason (required to `http://terminology.hl7.org/ValueSet/v2-0868`)
Type	http://hl7.org/v2/StructureDefinition/CWE
32. XTN.16
Short	Protection Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-protectionCode (required to `http://terminology.hl7.org/ValueSet/v2-0618`)
Type	http://hl7.org/v2/StructureDefinition/CWE
34. XTN.17
Short	Shared Telecommunication Identifier
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/EI
36. XTN.18
Short	Preference Order
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. XTN
Definition	Base definition for all types defined in FHIR type system.
Short	extended telecommunication numberBase for all types and resources
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. XTN.1
Short	Telephone Number
4. XTN.2
Short	Telecommunication Use Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-telecommunicationUseCode (required to `http://terminology.hl7.org/ValueSet/v2-0201`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. XTN.3
Short	Telecommunication Equipment Type
Control	1..1
Binding	The codes SHALL be taken from hl7VS-telecommunicationEquipmentType (required to `http://terminology.hl7.org/ValueSet/v2-0202`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. XTN.4
Short	Communication Address
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. XTN.5
Short	Country Code
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SNM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. XTN.6
Short	Area/City Code
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SNM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. XTN.7
Short	Local Number
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SNM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. XTN.8
Short	Extension
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SNM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. XTN.9
Short	Any Text
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
20. XTN.10
Short	Extension Prefix
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
22. XTN.11
Short	Speed Dial Code
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. XTN.12
Short	Unformatted Telephone Number
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
26. XTN.13
Short	Effective Start Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. XTN.14
Short	Expiration Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
30. XTN.15
Short	Expiration Reason
Control	0..1
Binding	The codes SHALL be taken from hl7VS-telecommunicationExpirationReason (required to `http://terminology.hl7.org/ValueSet/v2-0868`)
Type	http://hl7.org/v2/StructureDefinition/CWE
32. XTN.16
Short	Protection Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-protectionCode (required to `http://terminology.hl7.org/ValueSet/v2-0618`)
Type	http://hl7.org/v2/StructureDefinition/CWE
34. XTN.17
Short	Shared Telecommunication Identifier
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/EI
36. XTN.18
Short	Preference Order
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. XTN
Definition	Base definition for all types defined in FHIR type system.
Short	extended telecommunication number
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. XTN.1
Short	Telephone Number
4. XTN.2
Short	Telecommunication Use Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-telecommunicationUseCode (required to `http://terminology.hl7.org/ValueSet/v2-0201`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. XTN.3
Short	Telecommunication Equipment Type
Control	1..1
Binding	The codes SHALL be taken from hl7VS-telecommunicationEquipmentType (required to `http://terminology.hl7.org/ValueSet/v2-0202`)
Type	http://hl7.org/v2/StructureDefinition/ID
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. XTN.4
Short	Communication Address
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. XTN.5
Short	Country Code
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SNM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. XTN.6
Short	Area/City Code
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SNM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. XTN.7
Short	Local Number
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SNM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. XTN.8
Short	Extension
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/SNM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. XTN.9
Short	Any Text
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
20. XTN.10
Short	Extension Prefix
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
22. XTN.11
Short	Speed Dial Code
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
24. XTN.12
Short	Unformatted Telephone Number
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/ST
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
26. XTN.13
Short	Effective Start Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. XTN.14
Short	Expiration Date
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/DTM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
30. XTN.15
Short	Expiration Reason
Control	0..1
Binding	The codes SHALL be taken from hl7VS-telecommunicationExpirationReason (required to `http://terminology.hl7.org/ValueSet/v2-0868`)
Type	http://hl7.org/v2/StructureDefinition/CWE
32. XTN.16
Short	Protection Code
Control	0..1
Binding	The codes SHALL be taken from hl7VS-protectionCode (required to `http://terminology.hl7.org/ValueSet/v2-0618`)
Type	http://hl7.org/v2/StructureDefinition/CWE
34. XTN.17
Short	Shared Telecommunication Identifier
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/EI
36. XTN.18
Short	Preference Order
Control	0..1
Type	http://hl7.org/v2/StructureDefinition/NM
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

IG © HL7 International. Package hl7.v2plus#0.0.0 based on FHIR 5.0.0. Generated 2024-10-31
Links: Table of Contents | QA Report