Packages
hl7v2
2.5.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/prl.ex
defmodule HL7v2.Type.PRL do
@moduledoc """
Parent Result Link (PRL) -- HL7v2 composite data type.
Links a child observation to its parent observation result.
3 components:
1. Parent Observation Identifier (CE) -- sub-components delimited by `&`
2. Parent Observation Sub-Identifier (ST)
3. Parent Observation Value Descriptor (TX)
"""
@behaviour HL7v2.Type
alias HL7v2.Type
alias HL7v2.Type.CE
defstruct [
:parent_observation_identifier,
:parent_observation_sub_identifier,
:parent_observation_value_descriptor
]
@type t :: %__MODULE__{
parent_observation_identifier: CE.t() | nil,
parent_observation_sub_identifier: binary() | nil,
parent_observation_value_descriptor: binary() | nil
}
@doc """
Parses a PRL from a list of components.
## Examples
iex> HL7v2.Type.PRL.parse(["85025&CBC&CPT4", "1", "Hemoglobin"])
%HL7v2.Type.PRL{
parent_observation_identifier: %HL7v2.Type.CE{identifier: "85025", text: "CBC", name_of_coding_system: "CPT4"},
parent_observation_sub_identifier: "1",
parent_observation_value_descriptor: "Hemoglobin"
}
iex> HL7v2.Type.PRL.parse(["85025&CBC&CPT4"])
%HL7v2.Type.PRL{parent_observation_identifier: %HL7v2.Type.CE{identifier: "85025", text: "CBC", name_of_coding_system: "CPT4"}}
iex> HL7v2.Type.PRL.parse([])
%HL7v2.Type.PRL{}
"""
@spec parse(list()) :: t()
def parse(components) when is_list(components) do
%__MODULE__{
parent_observation_identifier: Type.parse_sub(CE, Type.get_component(components, 0)),
parent_observation_sub_identifier: Type.get_component(components, 1),
parent_observation_value_descriptor: Type.get_component(components, 2)
}
end
@doc """
Encodes a PRL to a list of component strings.
## Examples
iex> HL7v2.Type.PRL.encode(%HL7v2.Type.PRL{parent_observation_identifier: %HL7v2.Type.CE{identifier: "85025", text: "CBC", name_of_coding_system: "CPT4"}, parent_observation_sub_identifier: "1"})
["85025&CBC&CPT4", "1"]
iex> HL7v2.Type.PRL.encode(nil)
[]
"""
@spec encode(t() | nil) :: list()
def encode(nil), do: []
def encode(%__MODULE__{} = prl) do
[
Type.encode_sub(CE, prl.parent_observation_identifier),
prl.parent_observation_sub_identifier || "",
prl.parent_observation_value_descriptor || ""
]
|> Type.trim_trailing()
end
end