README
¶
Overview
HL7v2 stands for "Health Level 7: Version 2" - a specification for shuttling clinical data around and between medical institutions. While working on Medtasker with Nimblic, I've written this library for reading the protocol and querying the messages it contains.
I have a blog post on my website if you'd like to hear a bit more of the story.
Install
$ go get github.com/nwehr/hl7
New Features
This fork adds the ability to Unpack() a Message or Segment into a struct using tags
package main
import (
"fmt"
"github.com/nwehr/hl7"
"strings"
"time"
)
var testMessage = strings.Replace(`MSH|^~\&||GA0000||VAERS PROCESSOR|20010331605||ORU^R01|20010422GA03|T|2.3.1|||AL|
PID|||1234^^^^SR~1234-12^^^^LR~00725^^^^MR||Doe^John^Fitzgerald^JR^^^L||20001007|M||2106-3^White^HL70005|||(678) 555-1212^^PRN|
NK1|1|Jones^Jane^Lee^^RN|VAB^Vaccine administered by (Name)^HL70063|
NK1|2|Jones^Jane^Lee^^RN|FVP^Form completed by (Name)-Vaccine provider^HL70063|||(404) 554-9097^^WPN|
ORC|CN|||||||||||1234567^Welby^Marcus^J^Jr^Dr.^MD^L|||||||||Peachtree Clinic||(404) 554-9097^^WPN||
OBR|1|||^CDC VAERS-1 (FDA) Report|||20010316|
OBX|1|NM|21612-7^Reported Patient Age^LN||05|mo^month^ANSI|
`, "\n", "\r", -1)
func main() {
m, _, _ := hl7.ParseMessage([]byte(testMessage))
patient := struct {
First string `hl7:"PID-5-2"`
Last string `hl7:"PID-5-1"`
Middle string `hl7:"PID-5-3"`
DOB time.Time `hl7:"PID-7"`
Gender string `hl7:"PID-8"`
}{}
m.Unpack(&patient)
fmt.Printf("%+v", patient)
}
License
3-clause BSD. A copy is included with the source.
Documentation
¶
Index ¶
- Variables
- func ParseMessage(buf []byte) (Message, *Delimiters, error)
- func ParseMessageWithSeperator(buf []byte, sep byte) (Message, *Delimiters, error)
- type Component
- type Delimiters
- type ErrInvalidHeader
- type ErrTooShort
- type Field
- type Message
- func (m *Message) Pack(in interface{}) (err error)
- func (m Message) Query(query string) (res string, err error)
- func (m Message) QuerySlice(query string) ([]string, error)
- func (m Message) Segment(name string, offset int) Segment
- func (m Message) Segments(name string) []Segment
- func (m *Message) SetString(query string, value string) error
- func (m Message) String() string
- func (m Message) Unpack(out interface{}) (err error)
- type Query
- type RepeatedComponent
- type RepeatedField
- type Segment
Constants ¶
This section is empty.
Variables ¶
var Locale *time.Location
Functions ¶
func ParseMessage ¶
func ParseMessage(buf []byte) (Message, *Delimiters, error)
ParseMessage takes input as a `[]byte`, and returns the whole message, the control characters (as `*Delimiters`), and maybe an error.
func ParseMessageWithSeperator ¶
func ParseMessageWithSeperator(buf []byte, sep byte) (Message, *Delimiters, error)
Types ¶
type Delimiters ¶
type Delimiters struct {
Field, Component, Repeat, Escape, RepeatedComponent byte
}
type ErrInvalidHeader ¶
type ErrInvalidHeader error
ErrInvalidHeader is returned if a message doesn't start with "MSH", or the header isn't exactly the correct length, or any of the control characters aren't unique
type ErrTooShort ¶
type ErrTooShort error
ErrTooShort is returned if a message isn't long enough to contain a valid header
type Query ¶
type Query struct {
Segment string
HasSegmentOffset bool
SegmentOffset int
HasField bool
IsRestField bool
Field int
HasRepeatedField bool
RepeatedField int
HasComponent bool
IsRestComponent bool
Component int
HasRepeatedComponent bool
IsRestRepeatedComponent bool
RepeatedComponent int
}
func ParseQuery ¶
type RepeatedComponent ¶
type RepeatedComponent string
type RepeatedField ¶
type RepeatedField []Component
func (RepeatedField) SliceOfStrings ¶
func (f RepeatedField) SliceOfStrings() []string
func (RepeatedField) String ¶
func (f RepeatedField) String() string
Source Files