Packages
hl7v2
3.3.2
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/msg.ex
defmodule HL7v2.Type.MSG do
@moduledoc """
Message Type (MSG) -- HL7v2 composite data type.
Used in MSH-9 to identify the message type, trigger event, and structure.
3 components:
1. Message Code (ID) -- Table 0076: ADT, ORM, ORU, ACK, etc.
2. Trigger Event (ID) -- Table 0003: A01, O01, R01, etc.
3. Message Structure (ID) -- Table 0354: ADT_A01, ORM_O01, etc.
"""
@behaviour HL7v2.Type
alias HL7v2.Type
defstruct [:message_code, :trigger_event, :message_structure]
@type t :: %__MODULE__{
message_code: binary() | nil,
trigger_event: binary() | nil,
message_structure: binary() | nil
}
@doc """
Parses a MSG from a list of components.
## Examples
iex> HL7v2.Type.MSG.parse(["ADT", "A01", "ADT_A01"])
%HL7v2.Type.MSG{message_code: "ADT", trigger_event: "A01", message_structure: "ADT_A01"}
iex> HL7v2.Type.MSG.parse(["ADT", "A01"])
%HL7v2.Type.MSG{message_code: "ADT", trigger_event: "A01"}
iex> HL7v2.Type.MSG.parse([])
%HL7v2.Type.MSG{}
"""
@spec parse(list()) :: t()
def parse(components) when is_list(components) do
%__MODULE__{
message_code: Type.get_component(components, 0),
trigger_event: Type.get_component(components, 1),
message_structure: Type.get_component(components, 2)
}
end
@doc """
Encodes a MSG to a list of component strings.
## Examples
iex> HL7v2.Type.MSG.encode(%HL7v2.Type.MSG{message_code: "ADT", trigger_event: "A01", message_structure: "ADT_A01"})
["ADT", "A01", "ADT_A01"]
iex> HL7v2.Type.MSG.encode(%HL7v2.Type.MSG{message_code: "ADT", trigger_event: "A01"})
["ADT", "A01"]
iex> HL7v2.Type.MSG.encode(nil)
[]
"""
@spec encode(t() | nil) :: list()
def encode(nil), do: []
def encode(%__MODULE__{} = msg) do
[
msg.message_code || "",
msg.trigger_event || "",
msg.message_structure || ""
]
|> Type.trim_trailing()
end
end