Packages
hl7v2
1.2.0
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/dln.ex
defmodule HL7v2.Type.DLN do
@moduledoc """
Driver's License Number (DLN) -- HL7v2 composite data type.
Used for driver's license identification.
3 components:
1. License Number (ST)
2. Issuing State, Province, Country (IS) -- Table 0333
3. Expiration Date (DT)
"""
@behaviour HL7v2.Type
alias HL7v2.Type
alias HL7v2.Type.DT
defstruct [:license_number, :issuing_state_province_country, :expiration_date]
@type t :: %__MODULE__{
license_number: binary() | nil,
issuing_state_province_country: binary() | nil,
expiration_date: Date.t() | DT.t() | nil
}
@doc """
Parses a DLN from a list of components.
## Examples
iex> HL7v2.Type.DLN.parse(["S12345678", "CA", "20280101"])
%HL7v2.Type.DLN{license_number: "S12345678", issuing_state_province_country: "CA", expiration_date: ~D[2028-01-01]}
iex> HL7v2.Type.DLN.parse(["S12345678", "CA"])
%HL7v2.Type.DLN{license_number: "S12345678", issuing_state_province_country: "CA"}
iex> HL7v2.Type.DLN.parse(["S12345678"])
%HL7v2.Type.DLN{license_number: "S12345678"}
iex> HL7v2.Type.DLN.parse([])
%HL7v2.Type.DLN{}
"""
@spec parse(list()) :: t()
def parse(components) when is_list(components) do
%__MODULE__{
license_number: Type.get_component(components, 0),
issuing_state_province_country: Type.get_component(components, 1),
expiration_date: components |> Type.get_component(2) |> DT.parse()
}
end
@doc """
Encodes a DLN to a list of component strings.
## Examples
iex> HL7v2.Type.DLN.encode(%HL7v2.Type.DLN{license_number: "S12345678", issuing_state_province_country: "CA", expiration_date: ~D[2028-01-01]})
["S12345678", "CA", "20280101"]
iex> HL7v2.Type.DLN.encode(%HL7v2.Type.DLN{license_number: "S12345678"})
["S12345678"]
iex> HL7v2.Type.DLN.encode(nil)
[]
"""
@spec encode(t() | nil) :: list()
def encode(nil), do: []
def encode(%__MODULE__{} = dln) do
[
dln.license_number || "",
dln.issuing_state_province_country || "",
DT.encode(dln.expiration_date)
]
|> Type.trim_trailing()
end
end