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/ts.ex
defmodule HL7v2.Type.TS do
@moduledoc """
Time Stamp (TS) -- HL7v2 composite data type.
Legacy composite with 2 components: time (DTM format) and degree of precision.
Retained for backward compatibility with v2.4 and earlier. In v2.5+, DTM is
preferred for new fields.
Component 2 (degree of precision) is deprecated. Values from Table 0529:
Y (year), L (month), D (day), H (hour), M (minute), S (second).
"""
@behaviour HL7v2.Type
alias HL7v2.Type
alias HL7v2.Type.DTM
defstruct [:time, :degree_of_precision]
@type t :: %__MODULE__{
time: DTM.t() | nil,
degree_of_precision: binary() | nil
}
@doc """
Parses a timestamp from a list of components.
## Examples
iex> HL7v2.Type.TS.parse(["20260322143022"])
%HL7v2.Type.TS{time: %HL7v2.Type.DTM{year: 2026, month: 3, day: 22, hour: 14, minute: 30, second: 22}}
iex> HL7v2.Type.TS.parse(["20260322", "D"])
%HL7v2.Type.TS{time: %HL7v2.Type.DTM{year: 2026, month: 3, day: 22}, degree_of_precision: "D"}
iex> HL7v2.Type.TS.parse([])
%HL7v2.Type.TS{}
"""
@spec parse(list()) :: t()
def parse(components) when is_list(components) do
%__MODULE__{
time: components |> Type.get_component(0) |> DTM.parse(),
degree_of_precision: Type.get_component(components, 1)
}
end
@doc """
Encodes a timestamp to a list of component strings.
## Examples
iex> HL7v2.Type.TS.encode(%HL7v2.Type.TS{time: %HL7v2.Type.DTM{year: 2026, month: 3, day: 22}})
["20260322"]
iex> HL7v2.Type.TS.encode(%HL7v2.Type.TS{time: %HL7v2.Type.DTM{year: 2026, month: 3, day: 22}, degree_of_precision: "D"})
["20260322", "D"]
iex> HL7v2.Type.TS.encode(nil)
[]
"""
@spec encode(t() | nil) :: list()
def encode(nil), do: []
def encode(%__MODULE__{} = ts) do
[
DTM.encode(ts.time),
ts.degree_of_precision || ""
]
|> Type.trim_trailing()
end
end