Packages
hl7v2
2.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/ri.ex
defmodule HL7v2.Type.RI do
@moduledoc """
Repeat Interval (RI) -- HL7v2 composite data type.
Specifies the interval between repeated services. Used in TQ-2
(Timing/Quantity interval component).
2 components:
1. Repeat Pattern (IS) -- coded pattern, e.g., "Q6H", "BID", "TID"
2. Explicit Time Interval (ST) -- explicit interval, e.g., "Q2H", "300S"
"""
@behaviour HL7v2.Type
alias HL7v2.Type
defstruct [:repeat_pattern, :explicit_time_interval]
@type t :: %__MODULE__{
repeat_pattern: binary() | nil,
explicit_time_interval: binary() | nil
}
@doc """
Parses an RI from a list of components.
## Examples
iex> HL7v2.Type.RI.parse(["Q6H", "6 hours"])
%HL7v2.Type.RI{repeat_pattern: "Q6H", explicit_time_interval: "6 hours"}
iex> HL7v2.Type.RI.parse(["BID"])
%HL7v2.Type.RI{repeat_pattern: "BID"}
iex> HL7v2.Type.RI.parse([])
%HL7v2.Type.RI{}
"""
@spec parse(list()) :: t()
def parse(components) when is_list(components) do
%__MODULE__{
repeat_pattern: Type.get_component(components, 0),
explicit_time_interval: Type.get_component(components, 1)
}
end
@doc """
Encodes an RI to a list of component strings.
## Examples
iex> HL7v2.Type.RI.encode(%HL7v2.Type.RI{repeat_pattern: "Q6H", explicit_time_interval: "6 hours"})
["Q6H", "6 hours"]
iex> HL7v2.Type.RI.encode(%HL7v2.Type.RI{repeat_pattern: "BID"})
["BID"]
iex> HL7v2.Type.RI.encode(nil)
[]
"""
@spec encode(t() | nil) :: list()
def encode(nil), do: []
def encode(%__MODULE__{} = ri) do
[
ri.repeat_pattern || "",
ri.explicit_time_interval || ""
]
|> Type.trim_trailing()
end
end