Add HL7 struct storing HL7 data as nested maps

README.md

@@ -3,6 +3,11 @@
 [![hex.pm downloads](https://img.shields.io/hexpm/dt/elixir_hl7.svg)](https://hex.pm/packages/elixir_hl7)
 [![hex.pm license](https://img.shields.io/hexpm/l/elixir_hl7.svg)](https://hex.pm/packages/elixir_hl7)
 
+Note: We are now building a simpler and more Elixir-friendly API for this library, centered on
+the `HL7` and `HL7.Path` modules. These will hopefully lead to the deprecation of
+`HL7.Query` and much of the related code. These will likely not be removed for some time, and their
+removal will coincide with a major version release. For now, the two systems can exchange data when needed.
+
 An Elixir library for working with HL7 v2.x healthcare data 
 
 Elixir HL7 provides functions to parse, query and modify healthcare data that conforms to the HL7 v2.x standards. 
@@ -26,13 +31,12 @@ Add this library to your mix.exs file:
 
 ```elixir
 defp deps do
-  [{:elixir_hl7, "~> 0.6.4"}]
+  [{:elixir_hl7, "~> 0.9.0"}]
 end
 ```
 
 Check out the `HL7.Examples` module for sample data that you can use to explore the API. 
 
-
 ## Route
 
 HL7 messages can be minimally validated to gather header (MSH segment) information for quick routing and acknowledgements.
@@ -182,9 +186,7 @@ Also, please be aware of the details of the license (Apache 2.0).
 
 # Roadmap
 
-1) Planning to add a loose selector like `OBX*` to basically split on a segment type, to create groups beginning a specific segment name.
-2) Working to release a complementary MLLP library
-3) Building a sister library to handle FHIR messages
+Extending the `HL7` base namespace to provide a simpler and more powerful API.
 
 # License
 

VERSION

@@ -1 +1 @@
-0.8.1
+0.9.0

benchmark.exs

@@ -4,11 +4,12 @@ alias HL7.Examples
 
 msg = Examples.wikipedia_sample_hl7()
 alt = Examples.wikipedia_sample_hl7_alt_delimiters()
+list = msg |> Message.to_list()
 
-list = Examples.wikipedia_sample_hl7() |> HL7.Message.to_list() |> List.flatten() |> Enum.take(10)
 Benchee.run(%{
   "raw" => fn -> msg |> Message.raw() end,
-  "new" => fn -> msg |> Message.new(%{accept_latin1: true}) end,
+  "maps" => fn -> msg |> HL7.Maps.new() end,
+  "new" => fn -> msg |> Message.new() end,
   "new-copy" => fn -> msg |> Message.new(%{copy: true}) end,
   "new-alt" => fn -> alt |> Message.new() end,
   "round-trip" => fn -> msg |> Message.new() |> to_string() end
@@ -56,11 +57,11 @@ Benchee.run(%{
 # round-trip       20.40 K       49.02 μs    ±20.06%       46.53 μs       86.84 μs
 # new-alt          15.64 K       63.95 μs    ±14.60%       61.53 μs      104.48 μs
 
-# with latin1 conversion
-
-# raw              75.87 K       13.18 μs   ±113.53%       12.36 μs       24.25 μs
-# new              51.93 K       19.26 μs    ±28.73%       17.37 μs       38.47 μs
-# new-copy         47.77 K       20.93 μs    ±29.84%       19.21 μs       39.15 μs
-# round-trip       20.32 K       49.21 μs    ±18.52%       47.62 μs       80.37 μs
-# new-alt          15.50 K       64.53 μs    ±12.32%       62.72 μs       97.16 μs
+# add Maps output for use with the new HPath sigil
 
+# raw             137.72 K
+# new              43.00 K - 3.20x slower +15.99 μs
+# new-copy         38.38 K - 3.59x slower +18.80 μs
+# maps             32.75 K - 4.21x slower +23.27 μs
+# round-trip       22.61 K - 6.09x slower +36.96 μs
+# new-alt          16.78 K - 8.21x slower +52.32 μs