HL7v2.Type.ID (HL7v2 v3.10.1)

Copy Markdown View Source

Coded Value for HL7-Defined Tables (ID) -- HL7v2 primitive data type.

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

Summary

Functions

encode(value)

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

parse(value)

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

Functions

encode(value)

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

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

Examples

iex> HL7v2.Type.ID.encode("MR")
"MR"

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

parse(value)

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

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

Examples

iex> HL7v2.Type.ID.parse("MR")
"MR"

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

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