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/cd.ex
defmodule HL7v2.Type.CD do
@moduledoc """
Channel Definition (CD) -- HL7v2 composite data type.
Defines a waveform channel's identifier, source, sensitivity, calibration,
and sampling parameters. Used in OBX for waveform observations.
10 components:
1. Channel Identifier (WVI) -- sub-components
2. Waveform Source (WVS) -- sub-components
3. Channel Sensitivity and Units (CSU) -- sub-components
4. Channel Calibration Parameters (CCP) -- sub-components
5. Channel Sampling Frequency (NM)
6. Minimum Data Value (NR) -- sub-components
7. Maximum Data Value (NR) -- sub-components
8-10: reserved/raw
"""
@behaviour HL7v2.Type
alias HL7v2.Type
alias HL7v2.Type.{WVI, WVS, CSU, CCP, NR}
defstruct [
:channel_identifier,
:waveform_source,
:channel_sensitivity_and_units,
:channel_calibration_parameters,
:channel_sampling_frequency,
:minimum_data_value,
:maximum_data_value
]
@type t :: %__MODULE__{
channel_identifier: WVI.t() | nil,
waveform_source: WVS.t() | nil,
channel_sensitivity_and_units: CSU.t() | nil,
channel_calibration_parameters: CCP.t() | nil,
channel_sampling_frequency: binary() | nil,
minimum_data_value: NR.t() | nil,
maximum_data_value: NR.t() | nil
}
@doc """
Parses a CD from a list of components.
## Examples
iex> HL7v2.Type.CD.parse(["1&Lead I", "RA&LA"])
%HL7v2.Type.CD{
channel_identifier: %HL7v2.Type.WVI{channel_number: "1", channel_name: "Lead I"},
waveform_source: %HL7v2.Type.WVS{source_one_name: "RA", source_two_name: "LA"}
}
iex> HL7v2.Type.CD.parse([])
%HL7v2.Type.CD{}
"""
@spec parse(list()) :: t()
def parse(components) when is_list(components) do
%__MODULE__{
channel_identifier: Type.parse_sub(WVI, Type.get_component(components, 0)),
waveform_source: Type.parse_sub(WVS, Type.get_component(components, 1)),
channel_sensitivity_and_units: Type.parse_sub(CSU, Type.get_component(components, 2)),
channel_calibration_parameters: Type.parse_sub(CCP, Type.get_component(components, 3)),
channel_sampling_frequency: Type.get_component(components, 4),
minimum_data_value: Type.parse_sub(NR, Type.get_component(components, 5)),
maximum_data_value: Type.parse_sub(NR, Type.get_component(components, 6))
}
end
@doc """
Encodes a CD to a list of component strings.
## Examples
iex> HL7v2.Type.CD.encode(%HL7v2.Type.CD{channel_identifier: %HL7v2.Type.WVI{channel_number: "1", channel_name: "Lead I"}})
["1&Lead I"]
iex> HL7v2.Type.CD.encode(nil)
[]
"""
@spec encode(t() | nil) :: list()
def encode(nil), do: []
def encode(%__MODULE__{} = cd) do
[
Type.encode_sub(WVI, cd.channel_identifier),
Type.encode_sub(WVS, cd.waveform_source),
Type.encode_sub(CSU, cd.channel_sensitivity_and_units),
Type.encode_sub(CCP, cd.channel_calibration_parameters),
cd.channel_sampling_frequency || "",
Type.encode_sub(NR, cd.minimum_data_value),
Type.encode_sub(NR, cd.maximum_data_value)
]
|> Type.trim_trailing()
end
end