Packages
hl7v2
0.5.6
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/pl.ex
defmodule HL7v2.Type.PL do
@moduledoc """
Person Location (PL) -- HL7v2 composite data type.
Used to specify patient location (point of care, room, bed, facility, etc.).
11 components:
1. Point of Care (IS) -- Table 0302
2. Room (IS) -- Table 0303
3. Bed (IS) -- Table 0304
4. Facility (HD) -- sub-components delimited by `&`
5. Location Status (IS) -- Table 0306
6. Person Location Type (IS) -- Table 0305: C=Clinic, N=Nursing, etc.
7. Building (IS) -- Table 0307
8. Floor (IS) -- Table 0308
9. Location Description (ST)
10. Comprehensive Location Identifier (EI) -- sub-components delimited by `&`
11. Assigning Authority for Location (HD) -- sub-components delimited by `&`
"""
@behaviour HL7v2.Type
alias HL7v2.Type
alias HL7v2.Type.{HD, EI}
defstruct [
:point_of_care,
:room,
:bed,
:facility,
:location_status,
:person_location_type,
:building,
:floor,
:location_description,
:comprehensive_location_identifier,
:assigning_authority_for_location
]
@type t :: %__MODULE__{
point_of_care: binary() | nil,
room: binary() | nil,
bed: binary() | nil,
facility: HD.t() | nil,
location_status: binary() | nil,
person_location_type: binary() | nil,
building: binary() | nil,
floor: binary() | nil,
location_description: binary() | nil,
comprehensive_location_identifier: EI.t() | nil,
assigning_authority_for_location: HD.t() | nil
}
@doc """
Parses a PL from a list of components.
## Examples
iex> HL7v2.Type.PL.parse(["ICU", "101", "A", "HOSP&2.16.840.1.113883.19.4.6&ISO", "", "N"])
%HL7v2.Type.PL{
point_of_care: "ICU",
room: "101",
bed: "A",
facility: %HL7v2.Type.HD{namespace_id: "HOSP", universal_id: "2.16.840.1.113883.19.4.6", universal_id_type: "ISO"},
person_location_type: "N"
}
iex> HL7v2.Type.PL.parse([])
%HL7v2.Type.PL{}
"""
@spec parse(list()) :: t()
def parse(components) when is_list(components) do
%__MODULE__{
point_of_care: Type.get_component(components, 0),
room: Type.get_component(components, 1),
bed: Type.get_component(components, 2),
facility: parse_sub_hd(Type.get_component(components, 3)),
location_status: Type.get_component(components, 4),
person_location_type: Type.get_component(components, 5),
building: Type.get_component(components, 6),
floor: Type.get_component(components, 7),
location_description: Type.get_component(components, 8),
comprehensive_location_identifier: parse_sub_ei(Type.get_component(components, 9)),
assigning_authority_for_location: parse_sub_hd(Type.get_component(components, 10))
}
end
@doc """
Encodes a PL to a list of component strings.
## Examples
iex> HL7v2.Type.PL.encode(%HL7v2.Type.PL{point_of_care: "ICU", facility: %HL7v2.Type.HD{namespace_id: "HOSP"}})
["ICU", "", "", "HOSP"]
iex> HL7v2.Type.PL.encode(nil)
[]
"""
@spec encode(t() | nil) :: list()
def encode(nil), do: []
def encode(%__MODULE__{} = pl) do
[
pl.point_of_care || "",
pl.room || "",
pl.bed || "",
encode_sub_hd(pl.facility),
pl.location_status || "",
pl.person_location_type || "",
pl.building || "",
pl.floor || "",
pl.location_description || "",
encode_sub_ei(pl.comprehensive_location_identifier),
encode_sub_hd(pl.assigning_authority_for_location)
]
|> Type.trim_trailing()
end
# -- Sub-component helpers --
defp parse_sub_hd(nil), do: nil
defp parse_sub_hd(value) when is_binary(value) do
subs = String.split(value, Type.sub_component_separator())
hd_val = HD.parse(subs)
if all_nil?(hd_val), do: nil, else: hd_val
end
defp encode_sub_hd(nil), do: ""
defp encode_sub_hd(%HD{} = hd_val),
do: hd_val |> HD.encode() |> Enum.join(Type.sub_component_separator())
defp parse_sub_ei(nil), do: nil
defp parse_sub_ei(value) when is_binary(value) do
subs = String.split(value, Type.sub_component_separator())
ei_val = EI.parse(subs)
if all_nil?(ei_val), do: nil, else: ei_val
end
defp encode_sub_ei(nil), do: ""
defp encode_sub_ei(%EI{} = ei),
do: ei |> EI.encode() |> Enum.join(Type.sub_component_separator())
defp all_nil?(struct) do
struct
|> Map.from_struct()
|> Map.values()
|> Enum.all?(&is_nil/1)
end
end