HL7v2.Type.FC (HL7v2 v3.10.1)

Financial Class (FC) -- HL7v2 composite data type.

Used to classify patient financial responsibility.

2 components:

Financial Class Code (IS) -- Table 0064
Effective Date (TS) -- sub-components delimited by &

Summary

Types

t()

Functions

encode(fc)

Encodes an FC to a list of component strings.

parse(components)

Parses an FC from a list of components.

Types

t()

@type t() :: %HL7v2.Type.FC{
  effective_date: HL7v2.Type.TS.t() | nil,
  financial_class_code: binary() | nil
}

Functions

encode(fc)

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

Encodes an FC to a list of component strings.

Examples

iex> HL7v2.Type.FC.encode(%HL7v2.Type.FC{financial_class_code: "01"})
["01"]

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

parse(components)

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

Parses an FC from a list of components.

Examples

iex> HL7v2.Type.FC.parse(["01"])
%HL7v2.Type.FC{financial_class_code: "01"}

iex> HL7v2.Type.FC.parse(["01", "20260322"])
%HL7v2.Type.FC{financial_class_code: "01", effective_date: %HL7v2.Type.TS{time: %HL7v2.Type.DTM{year: 2026, month: 3, day: 22}}}

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