Packages
hl7v2
3.3.3
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/hd.ex
defmodule HL7v2.Type.HD do
@moduledoc """
Hierarchic Designator (HD) -- HL7v2 composite data type.
Used to identify sending/receiving applications, facilities, and assigning
authorities. Appears as a top-level component and as a sub-component inside
CX, EI, PL, and XON.
3 components:
1. Namespace ID (IS)
2. Universal ID (ST)
3. Universal ID Type (ID) -- DNS, GUID, ISO, UUID, etc.
When HD appears inside another composite (e.g., CX.4), its internal parts
are encoded as sub-components using `&`.
"""
@behaviour HL7v2.Type
alias HL7v2.Type
defstruct [:namespace_id, :universal_id, :universal_id_type]
@type t :: %__MODULE__{
namespace_id: binary() | nil,
universal_id: binary() | nil,
universal_id_type: binary() | nil
}
@doc """
Parses an HD from a list of components (or sub-components).
## Examples
iex> HL7v2.Type.HD.parse(["HOSP", "2.16.840.1.113883.19.4.6", "ISO"])
%HL7v2.Type.HD{namespace_id: "HOSP", universal_id: "2.16.840.1.113883.19.4.6", universal_id_type: "ISO"}
iex> HL7v2.Type.HD.parse(["MRN"])
%HL7v2.Type.HD{namespace_id: "MRN"}
iex> HL7v2.Type.HD.parse([])
%HL7v2.Type.HD{}
"""
@spec parse(list()) :: t()
def parse(components) when is_list(components) do
%__MODULE__{
namespace_id: Type.get_component(components, 0),
universal_id: Type.get_component(components, 1),
universal_id_type: Type.get_component(components, 2)
}
end
@doc """
Encodes an HD to a list of component/sub-component strings.
## Examples
iex> HL7v2.Type.HD.encode(%HL7v2.Type.HD{namespace_id: "HOSP", universal_id: "2.16.840.1.113883.19.4.6", universal_id_type: "ISO"})
["HOSP", "2.16.840.1.113883.19.4.6", "ISO"]
iex> HL7v2.Type.HD.encode(%HL7v2.Type.HD{namespace_id: "MRN"})
["MRN"]
iex> HL7v2.Type.HD.encode(nil)
[]
"""
@spec encode(t() | nil) :: list()
def encode(nil), do: []
def encode(%__MODULE__{} = hd_type) do
[
hd_type.namespace_id || "",
hd_type.universal_id || "",
hd_type.universal_id_type || ""
]
|> Type.trim_trailing()
end
end