Packages
hl7v2
3.0.2
3.10.1
3.9.0
3.8.0
3.7.0
3.6.0
3.5.0
3.4.0
3.3.6
3.3.5
3.3.4
3.3.3
3.3.2
3.3.1
3.3.0
3.2.0
3.1.1
3.1.0
3.0.2
3.0.1
3.0.0
2.11.0
2.10.0
2.9.1
2.9.0
2.8.2
2.8.1
2.8.0
2.7.1
2.7.0
2.6.0
2.5.0
2.4.0
2.3.0
2.2.0
2.1.3
2.1.2
2.1.1
2.1.0
1.4.6
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.0
1.2.0
1.1.0
1.0.0
0.6.0
0.5.6
0.5.5
0.5.4
0.5.3
0.5.2
0.5.1
0.5.0
0.1.0
Pure Elixir HL7 v2.x toolkit — schema-driven parsing, typed segments, message builder, MLLP transport
Current section
Files
Jump to
Current section
Files
lib/hl7v2/type/xtn.ex
defmodule HL7v2.Type.XTN do
@moduledoc """
Extended Telecommunication Number (XTN) -- HL7v2 composite data type.
12 components:
1. Telephone Number (ST) -- deprecated
2. Telecommunication Use Code (ID) -- Table 0201: PRN, WPN, NET, etc.
3. Telecommunication Equipment Type (ID) -- Table 0202: PH, FX, CP, Internet, etc.
4. Email Address (ST)
5. Country Code (NM)
6. Area/City Code (NM)
7. Local Number (NM)
8. Extension (NM)
9. Any Text (ST)
10. Extension Prefix (ST)
11. Speed Dial Code (ST)
12. Unformatted Telephone Number (ST)
"""
@behaviour HL7v2.Type
alias HL7v2.Type
defstruct [
:telephone_number,
:telecom_use_code,
:telecom_equipment_type,
:email_address,
:country_code,
:area_code,
:local_number,
:extension,
:any_text,
:extension_prefix,
:speed_dial_code,
:unformatted_telephone_number
]
@type t :: %__MODULE__{
telephone_number: binary() | nil,
telecom_use_code: binary() | nil,
telecom_equipment_type: binary() | nil,
email_address: binary() | nil,
country_code: binary() | nil,
area_code: binary() | nil,
local_number: binary() | nil,
extension: binary() | nil,
any_text: binary() | nil,
extension_prefix: binary() | nil,
speed_dial_code: binary() | nil,
unformatted_telephone_number: binary() | nil
}
@doc """
Parses an XTN from a list of components.
## Examples
iex> HL7v2.Type.XTN.parse(["", "PRN", "PH", "", "34", "961", "123456", "789"])
%HL7v2.Type.XTN{
telecom_use_code: "PRN",
telecom_equipment_type: "PH",
country_code: "34",
area_code: "961",
local_number: "123456",
extension: "789"
}
iex> HL7v2.Type.XTN.parse(["", "NET", "Internet", "john@example.com"])
%HL7v2.Type.XTN{
telecom_use_code: "NET",
telecom_equipment_type: "Internet",
email_address: "john@example.com"
}
iex> HL7v2.Type.XTN.parse([])
%HL7v2.Type.XTN{}
"""
@spec parse(list()) :: t()
def parse(components) when is_list(components) do
%__MODULE__{
telephone_number: Type.get_component(components, 0),
telecom_use_code: Type.get_component(components, 1),
telecom_equipment_type: Type.get_component(components, 2),
email_address: Type.get_component(components, 3),
country_code: Type.get_component(components, 4),
area_code: Type.get_component(components, 5),
local_number: Type.get_component(components, 6),
extension: Type.get_component(components, 7),
any_text: Type.get_component(components, 8),
extension_prefix: Type.get_component(components, 9),
speed_dial_code: Type.get_component(components, 10),
unformatted_telephone_number: Type.get_component(components, 11)
}
end
@doc """
Encodes an XTN to a list of component strings.
## Examples
iex> HL7v2.Type.XTN.encode(%HL7v2.Type.XTN{telecom_use_code: "NET", telecom_equipment_type: "Internet", email_address: "john@example.com"})
["", "NET", "Internet", "john@example.com"]
iex> HL7v2.Type.XTN.encode(nil)
[]
"""
@spec encode(t() | nil) :: list()
def encode(nil), do: []
def encode(%__MODULE__{} = xtn) do
[
xtn.telephone_number || "",
xtn.telecom_use_code || "",
xtn.telecom_equipment_type || "",
xtn.email_address || "",
xtn.country_code || "",
xtn.area_code || "",
xtn.local_number || "",
xtn.extension || "",
xtn.any_text || "",
xtn.extension_prefix || "",
xtn.speed_dial_code || "",
xtn.unformatted_telephone_number || ""
]
|> Type.trim_trailing()
end
end