HL7v2.Type.IS (HL7v2 v3.10.1)

Copy Markdown View Source

Coded Value for User-Defined Tables (IS) -- HL7v2 primitive data type.

Lossless storage: the value is stored and returned as a plain binary string. The HL7 spec constrains IS values to site-defined (user-defined) tables, but this implementation does not enforce table membership — any string is accepted.

Summary

Functions

encode(value)

Encodes an IS value. Returns the string as-is, or empty string for nil.

parse(value)

Parses an IS string. Returns the string as-is, or nil for empty/nil input.

Functions

encode(value)

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

Encodes an IS value. Returns the string as-is, or empty string for nil.

Examples

iex> HL7v2.Type.IS.encode("ICU")
"ICU"

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

parse(value)

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

Parses an IS string. Returns the string as-is, or nil for empty/nil input.

Examples

iex> HL7v2.Type.IS.parse("ICU")
"ICU"

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

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