HL7v2.Type.TX (HL7v2 v3.10.1)

Copy Markdown View Source

Text Data (TX) -- HL7v2 primitive data type.

Lossless storage: the value is stored and returned as a plain binary string. The HL7 spec says TX is display-oriented narrative text where leading spaces are significant and trailing spaces should be removed, but this implementation preserves all input bytes for round-trip fidelity. No whitespace normalization, escape sequence processing, or charset validation is performed.

Summary

Functions

encode(value)

Encodes a text value. Returns the string as-is, or empty string for nil.

parse(value)

Parses a text value. Returns the string as-is (preserving leading whitespace), or nil for empty/nil input.

Functions

encode(value)

@spec encode(binary() | nil) :: binary()

Encodes a text value. Returns the string as-is, or empty string for nil.

Examples

iex> HL7v2.Type.TX.encode("  indented text")
"  indented text"

iex> HL7v2.Type.TX.encode(nil)
""

parse(value)

@spec parse(binary() | nil) :: binary() | nil

Parses a text value. Returns the string as-is (preserving leading whitespace), or nil for empty/nil input.

Examples

iex> HL7v2.Type.TX.parse("  indented text")
"  indented text"

iex> HL7v2.Type.TX.parse("simple text")
"simple text"

iex> HL7v2.Type.TX.parse("")
nil

iex> HL7v2.Type.TX.parse(nil)
nil