HL7v2.Type.DIN (HL7v2 v3.10.1)

Date and Institution Name (DIN) -- HL7v2 composite data type.

Associates a date with an institution name. Used in PRA-5.

2 components:

Date (TS) -- sub-components delimited by &
Institution Name (CE) -- sub-components delimited by &

Summary

Types

t()

Functions

encode(din)

Encodes a DIN to a list of component strings.

parse(components)

Parses a DIN from a list of components.

Types

t()

@type t() :: %HL7v2.Type.DIN{
  date: HL7v2.Type.TS.t() | nil,
  institution_name: HL7v2.Type.CE.t() | nil
}

Functions

encode(din)

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

Encodes a DIN to a list of component strings.

Examples

iex> HL7v2.Type.DIN.encode(%HL7v2.Type.DIN{institution_name: %HL7v2.Type.CE{identifier: "HOSP1"}})
["", "HOSP1"]

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

parse(components)

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

Parses a DIN from a list of components.

Examples

iex> HL7v2.Type.DIN.parse(["20260101", "HOSP1&City Hospital&LOCAL"])
%HL7v2.Type.DIN{
  date: %HL7v2.Type.TS{time: %HL7v2.Type.DTM{year: 2026, month: 1, day: 1}},
  institution_name: %HL7v2.Type.CE{identifier: "HOSP1", text: "City Hospital", name_of_coding_system: "LOCAL"}
}

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