Packages
hl7v2
2.3.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/pln.ex
defmodule HL7v2.Type.PLN do
@moduledoc """
Practitioner License or Other ID Number (PLN) -- HL7v2 composite data type.
Used to transmit a practitioner's license or other identification number
along with contextual information.
4 components:
1. ID Number (ST) -- the license or ID number
2. Type of ID Number (IS) -- Table 0338: e.g., "MD", "DO", "RN", "DEA"
3. State/Other Qualifying Information (ST) -- jurisdiction, e.g., "CA", "NY"
4. Expiration Date (DT) -- YYYY[MM[DD]]
"""
@behaviour HL7v2.Type
alias HL7v2.Type
alias HL7v2.Type.DT
defstruct [
:id_number,
:type_of_id_number,
:state_other_qualifying_information,
:expiration_date
]
@type t :: %__MODULE__{
id_number: binary() | nil,
type_of_id_number: binary() | nil,
state_other_qualifying_information: binary() | nil,
expiration_date: Date.t() | DT.t() | nil
}
@doc """
Parses a PLN from a list of components.
## Examples
iex> HL7v2.Type.PLN.parse(["A12345", "MD", "CA", "20281231"])
%HL7v2.Type.PLN{id_number: "A12345", type_of_id_number: "MD", state_other_qualifying_information: "CA", expiration_date: ~D[2028-12-31]}
iex> HL7v2.Type.PLN.parse(["DEA98765", "DEA"])
%HL7v2.Type.PLN{id_number: "DEA98765", type_of_id_number: "DEA"}
iex> HL7v2.Type.PLN.parse([])
%HL7v2.Type.PLN{}
"""
@spec parse(list()) :: t()
def parse(components) when is_list(components) do
%__MODULE__{
id_number: Type.get_component(components, 0),
type_of_id_number: Type.get_component(components, 1),
state_other_qualifying_information: Type.get_component(components, 2),
expiration_date: components |> Type.get_component(3) |> DT.parse()
}
end
@doc """
Encodes a PLN to a list of component strings.
## Examples
iex> HL7v2.Type.PLN.encode(%HL7v2.Type.PLN{id_number: "A12345", type_of_id_number: "MD", state_other_qualifying_information: "CA", expiration_date: ~D[2028-12-31]})
["A12345", "MD", "CA", "20281231"]
iex> HL7v2.Type.PLN.encode(%HL7v2.Type.PLN{id_number: "DEA98765", type_of_id_number: "DEA"})
["DEA98765", "DEA"]
iex> HL7v2.Type.PLN.encode(nil)
[]
"""
@spec encode(t() | nil) :: list()
def encode(nil), do: []
def encode(%__MODULE__{} = pln) do
[
pln.id_number || "",
pln.type_of_id_number || "",
pln.state_other_qualifying_information || "",
DT.encode(pln.expiration_date)
]
|> Type.trim_trailing()
end
end