Interface: XTN

HL7 v2 Extended Telecommunication Number (XTN): structured telecom per HL7 Chapter 2. All 12 v1 components are optional. Fields are OMITTED when the underlying component is absent (exactOptionalPropertyTypes).

Component positions (HL7 1-indexed; this interface is 0-indexed by key):

1. telephoneNumber: formatted or unformatted phone number
2. telecommunicationUseCode: PRN=Primary Residence, WPN=Work, NET=Internet, ORN=Other Residence, BPN=Beeper, VHN=Vacation Home, ASN=Answering Service, EMR=Emergency, ...
3. telecommunicationEquipmentType: PH=Phone, FX=Fax, MD=Modem, CP=Cellular Phone, BP=Beeper, Internet, X.400, TDD, TTY
4. emailAddress
5. countryCode (e.g. "+1")
6. areaCityCode
7. localNumber
8. extension
9. anyText: free-text note
10. extensionPrefix (e.g. "x")
11. speedDialCode
12. unformattedTelephoneNumber

Example

import type { XTN } from "@cosyte/hl7";
const phone: XTN = {
  telephoneNumber: "(555) 555-1234",
  telecommunicationUseCode: "WPN",
  telecommunicationEquipmentType: "PH",
};

Properties

anyText?

readonly optional anyText?: string

---

areaCityCode?

readonly optional areaCityCode?: string

---

countryCode?

readonly optional countryCode?: string

---

emailAddress?

readonly optional emailAddress?: string

---

extension?

readonly optional extension?: string

---

extensionPrefix?

readonly optional extensionPrefix?: string

---

localNumber?

readonly optional localNumber?: string

---

speedDialCode?

readonly optional speedDialCode?: string

---

telecommunicationEquipmentType?

readonly optional telecommunicationEquipmentType?: string

---

telecommunicationUseCode?

readonly optional telecommunicationUseCode?: string

---

telephoneNumber?

readonly optional telephoneNumber?: string

---

unformattedTelephoneNumber?

readonly optional unformattedTelephoneNumber?: string