HL7v2.Type.AUI (HL7v2 v3.10.1)

Copy Markdown View Source

Authorization Information (AUI) -- HL7v2 composite data type.

Used to convey insurance authorization details.

3 components:

  1. Authorization Number (ST)
  2. Date (DT)
  3. Source (ST)

Summary

Types

t()

Functions

encode(aui)

Encodes an AUI to a list of component strings.

parse(components)

Parses an AUI from a list of components.

Types

t()

@type t() :: %HL7v2.Type.AUI{
  authorization_number: binary() | nil,
  date: Date.t() | HL7v2.Type.DT.t() | nil,
  source: binary() | nil
}

Functions

encode(aui)

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

Encodes an AUI to a list of component strings.

Examples

iex> HL7v2.Type.AUI.encode(%HL7v2.Type.AUI{authorization_number: "AUTH123", date: ~D[2026-03-15], source: "BCBS"})
["AUTH123", "20260315", "BCBS"]

iex> HL7v2.Type.AUI.encode(%HL7v2.Type.AUI{authorization_number: "AUTH123"})
["AUTH123"]

iex> HL7v2.Type.AUI.encode(nil)
[]

parse(components)

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

Parses an AUI from a list of components.

Examples

iex> HL7v2.Type.AUI.parse(["AUTH123", "20260315", "BCBS"])
%HL7v2.Type.AUI{authorization_number: "AUTH123", date: ~D[2026-03-15], source: "BCBS"}

iex> HL7v2.Type.AUI.parse(["AUTH123"])
%HL7v2.Type.AUI{authorization_number: "AUTH123"}

iex> HL7v2.Type.AUI.parse([])
%HL7v2.Type.AUI{}