Packages
hl7v2
0.1.0
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.ex
defmodule HL7v2 do
@moduledoc """
Pure Elixir HL7 v2.x toolkit.
Schema-driven parsing, typed segment structs, programmatic message
building, validation, and integrated MLLP transport.
## Parsing
# Raw mode — lossless, delimiter-based
{:ok, raw} = HL7v2.parse(text)
# Typed mode — validated structs
{:ok, msg} = HL7v2.parse(text, mode: :typed)
## Building
msg =
HL7v2.Message.new("ADT", "A01", sending_application: "PHAOS")
|> HL7v2.Message.add_segment(%HL7v2.Segment.PID{...})
text = HL7v2.encode(msg)
## MLLP Transport
{:ok, _} = HL7v2.MLLP.Listener.start_link(port: 2575, handler: MyHandler)
"""
alias HL7v2.Parser
@doc """
Parses an HL7v2 message from a binary string.
## Options
- `:mode` — `:raw` (default) or `:typed`
- `:validate` — `true` to validate after parsing (default `false`)
## Examples
{:ok, msg} = HL7v2.parse("MSH|^~\\\\&|...")
{:ok, msg} = HL7v2.parse(text, mode: :typed, validate: true)
"""
@spec parse(binary(), keyword()) :: {:ok, term()} | {:error, term()}
def parse(text, opts \\ []) do
Parser.parse(text, opts)
end
@doc """
Encodes an HL7v2 message to wire format.
"""
@spec encode(term()) :: binary()
def encode(message) do
HL7v2.Encoder.encode(message)
end
@doc """
Validates an HL7v2 message.
Returns `:ok` or `{:error, [error]}`.
Not yet implemented — will be available after Phase 6 (Validation Engine).
"""
@spec validate(term()) :: :ok | {:error, [map()]}
def validate(_message) do
{:error, :not_implemented}
end
end