Skip to content

Update README #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
floralouise wants to merge 1 commit into from
Closed

Update README #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,33 @@
[![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

> ### Note {: .warning}
>
> We are now building a simpler and more Elixir-friendly API for this library, centered on
> the `HL7` and `HL7.Path` modules.
>
> These will lead to the deprecation of `HL7.Query` and much of the related code.
> However, those modules 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.

Elixir HL7 provides functions to parse, query and modify healthcare data that conforms to the HL7 v2.x standards.
It should be able to reconstruct any HL7 Message without data loss or corruption.

It also provides basic support for reading HL7 file streams with configurable delimiters (MLLP included).

This library has been tested on a fairly wide variety of real-world HL7 messages to ensure correctness and flexibility.

You can learn more about HL7 here:
* The official HL7 website ([hl7.org](http://www.hl7.org/index.cfm))
* Wikipedia's [HL7 article](https://en.wikipedia.org/wiki/Health_Level_7)

Please [report an issue](https://github.com/HCA-Healthcare/elixir-hl7/issues) if something appears to be handled incorrectly.

> ### Learn about HL7 {: .neutral}
>
> - The official HL7 website ([hl7.org](http://www.hl7.org/index.cfm))
> - Wikipedia's [HL7 article](https://en.wikipedia.org/wiki/Health_Level_7)

## Getting started

Full documentation can be found at [hex.pm](https://hexdocs.pm/elixir_hl7/readme.html).
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ defmodule HL7.MixProject do
[
{:benchee, "~> 1.1.0", only: :dev},
{:dialyxir, "~> 1.4.1", only: [:dev, :test], runtime: false},
{:ex_doc, "~> 0.26.0", only: :dev, runtime: false},
{:ex_doc, "~> 0.34.2", only: :dev, runtime: false},
{:junit_formatter, "~> 3.3.1", only: :test},
{:propcheck, "~> 1.4.1", only: [:test, :dev]},
{:nimble_parsec, "~> 1.4.0", only: [:test, :dev], runtime: false},
Expand Down