ex_hl7 v0.3.0 HL7.Composite

Generic functions used by HL7 composite field macros

Summary

t()

Creates the map corresponding to the underlying struct in a composite field

Converts the struct holding the composite field data into the tuple format accepted by the functions in HL7.Writer

Converts a composite field into an iolist suitable to send over a socket or write to a file

Checks if a composite field is empty. This function is implemented as a macro so that it can be used in guards

descriptor :: {name :: atom, type :: atom}

option ::
  {:separators, [{key :: atom, separator :: byte}]} |
  {:trim, boolean}

t :: map

decode(composite, descriptor, tuple)

decode(t, [descriptor], binary | tuple) ::
  t |
  no_return

Creates the map corresponding to the underlying struct in a composite field.

encode(composite, descriptor)

encode(t, [descriptor]) ::
  HL7.Type.field |
  no_return

Converts the struct holding the composite field data into the tuple format accepted by the functions in HL7.Writer.

encode(composite, list, acc)

id(composite)

id(t) :: HL7.Type.composite_id

maybe_decode_value(value, type)

maybe_encode_value(value, type)

module(id)

module(HL7.Type.composite_id) :: atom

new(composite_id)

new(HL7.Type.composite_id) :: {module :: atom, t}

to_iodata(composite, descriptor, options)

to_iodata(t, [descriptor], [option]) ::
  iodata |
  no_return

Converts a composite field into an iolist suitable to send over a socket or write to a file.

empty?(value)

Checks if a composite field is empty. This function is implemented as a macro so that it can be used in guards.