Packages
hl7v2
0.5.4
3.10.1
3.9.0
3.8.0
3.7.0
3.6.0
3.5.0
3.4.0
3.3.6
3.3.5
3.3.4
3.3.3
3.3.2
3.3.1
3.3.0
3.2.0
3.1.1
3.1.0
3.0.2
3.0.1
3.0.0
2.11.0
2.10.0
2.9.1
2.9.0
2.8.2
2.8.1
2.8.0
2.7.1
2.7.0
2.6.0
2.5.0
2.4.0
2.3.0
2.2.0
2.1.3
2.1.2
2.1.1
2.1.0
1.4.6
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.0
1.2.0
1.1.0
1.0.0
0.6.0
0.5.6
0.5.5
0.5.4
0.5.3
0.5.2
0.5.1
0.5.0
0.1.0
Pure Elixir HL7 v2.x toolkit — schema-driven parsing, typed segments, message builder, MLLP transport
Current section
Files
Jump to
Current section
Files
lib/hl7v2/type/ei.ex
defmodule HL7v2.Type.EI do
@moduledoc """
Entity Identifier (EI) -- HL7v2 composite data type.
Used for order numbers, filler/placer numbers, and other entity identifiers.
4 components:
1. Entity Identifier (ST)
2. Namespace ID (IS)
3. Universal ID (ST)
4. Universal ID Type (ID)
Components 3 and 4 follow HD pairing rules: both must be valued or both null.
"""
@behaviour HL7v2.Type
alias HL7v2.Type
defstruct [:entity_identifier, :namespace_id, :universal_id, :universal_id_type]
@type t :: %__MODULE__{
entity_identifier: binary() | nil,
namespace_id: binary() | nil,
universal_id: binary() | nil,
universal_id_type: binary() | nil
}
@doc """
Parses an EI from a list of components.
## Examples
iex> HL7v2.Type.EI.parse(["ORD12345", "HOSP", "2.16.840.1.113883.19.4.6", "ISO"])
%HL7v2.Type.EI{entity_identifier: "ORD12345", namespace_id: "HOSP", universal_id: "2.16.840.1.113883.19.4.6", universal_id_type: "ISO"}
iex> HL7v2.Type.EI.parse(["ORD12345"])
%HL7v2.Type.EI{entity_identifier: "ORD12345"}
iex> HL7v2.Type.EI.parse([])
%HL7v2.Type.EI{}
"""
@spec parse(list()) :: t()
def parse(components) when is_list(components) do
%__MODULE__{
entity_identifier: Type.get_component(components, 0),
namespace_id: Type.get_component(components, 1),
universal_id: Type.get_component(components, 2),
universal_id_type: Type.get_component(components, 3)
}
end
@doc """
Encodes an EI to a list of component strings.
## Examples
iex> HL7v2.Type.EI.encode(%HL7v2.Type.EI{entity_identifier: "ORD12345", namespace_id: "HOSP"})
["ORD12345", "HOSP"]
iex> HL7v2.Type.EI.encode(nil)
[]
"""
@spec encode(t() | nil) :: list()
def encode(nil), do: []
def encode(%__MODULE__{} = ei) do
[
ei.entity_identifier || "",
ei.namespace_id || "",
ei.universal_id || "",
ei.universal_id_type || ""
]
|> Type.trim_trailing()
end
end