HL7v2.Type.CD (HL7v2 v3.10.1)

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:

Channel Identifier (WVI) -- sub-components
Waveform Source (WVS) -- sub-components
Channel Sensitivity and Units (CSU) -- sub-components
Channel Calibration Parameters (CCP) -- sub-components
Channel Sampling Frequency (NM)
Minimum Data Value (NR) -- sub-components
Maximum Data Value (NR) -- sub-components 8-10: reserved/raw

Summary

Types

t()

Functions

encode(cd)

Encodes a CD to a list of component strings.

parse(components)

Parses a CD from a list of components.

Types

t()

@type t() :: %HL7v2.Type.CD{
  channel_calibration_parameters: HL7v2.Type.CCP.t() | nil,
  channel_identifier: HL7v2.Type.WVI.t() | nil,
  channel_sampling_frequency: binary() | nil,
  channel_sensitivity_and_units: HL7v2.Type.CSU.t() | nil,
  maximum_data_value: HL7v2.Type.NR.t() | nil,
  minimum_data_value: HL7v2.Type.NR.t() | nil,
  waveform_source: HL7v2.Type.WVS.t() | nil
}

Functions

encode(cd)

@spec encode(t() | nil) :: list()

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)
[]

parse(components)

@spec parse(list()) :: t()

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{}