hl7

README

HL7 v2 - Marshal and Unmarshal

Documentation

Index

• type DecodeDataError
  • func (e *DecodeDataError) Error() string
• type DecodeOption
• type DecodeSegmentError
  • func (e *DecodeSegmentError) Error() string
  • func (e *DecodeSegmentError) Unwrap() error
• type Decoder
  • func NewDecoder(registry Registry, opt *DecodeOption) *Decoder
  • func (d *Decoder) Decode(data []byte) (any, error)
  • func (d *Decoder) DecodeGroup(list []any) (any, error)
  • func (d *Decoder) DecodeList(data []byte) ([]any, error)
• type EncodeOption
• type Encoder
  • func NewEncoder(opt *EncodeOption) *Encoder
  • func (e *Encoder) Encode(message any) ([]byte, error)
• type Registry
• type RegistryLookup
• type SegmentError
  • func (e SegmentError) Error() string
  • func (e SegmentError) Unwrap() []error
• type Varies

Types

type DecodeDataError

type DecodeDataError struct {
	Tag   string
	Value string
}

func (*DecodeDataError) Error

func (e *DecodeDataError) Error() string

type DecodeOption

type DecodeOption struct {
	ErrorZSegment  bool // Error on an unknown Zxx segment when true.
	HeaderOnly     bool // Only decode first segment, usually the header.
	IgnoreFieldSep bool // Ignore field separator values in text fields.
}

Decode options for the HL7 decoder.

type DecodeSegmentError

type DecodeSegmentError struct {
	Line        int
	SegmentName string
	FieldName   string
	FieldType   string
	Ordinal     int32
	Inner       error
}

func (*DecodeSegmentError) Error

func (e *DecodeSegmentError) Error() string

func (*DecodeSegmentError) Unwrap

func (e *DecodeSegmentError) Unwrap() error

type Decoder

type Decoder struct {
	// contains filtered or unexported fields
}

Decode bytes into HL7 structures.

func NewDecoder

func NewDecoder(registry Registry, opt *DecodeOption) *Decoder

Create a new Decoder. A registry must be provided. Option is optional.

func (*Decoder) Decode

func (d *Decoder) Decode(data []byte) (any, error)

Decode takes an hl7 message and returns a final trigger with all segments grouped.

func (*Decoder) DecodeGroup

func (d *Decoder) DecodeGroup(list []any) (any, error)

Group a list of elements into trigger groupings. A value and error may be present at the same time.

func (*Decoder) DecodeList

func (d *Decoder) DecodeList(data []byte) ([]any, error)

Decode returns a list of segments without any grouping applied.

type EncodeOption

type EncodeOption struct {
	TrimTrailingSeparator bool
}

Encoding options.

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

func NewEncoder

func NewEncoder(opt *EncodeOption) *Encoder

Create a new Encoder. Options may be nil.

func (*Encoder) Encode

func (e *Encoder) Encode(message any) ([]byte, error)

type Registry

type Registry interface {
	Version() string
	ControlSegment(string) (any, bool)
	Segment(string) (any, bool)
	Trigger(string) (any, bool)
	DataType(string) (any, bool)
}

type RegistryLookup

type RegistryLookup = map[string]any

type SegmentError

type SegmentError struct {
	ErrorList []error
	Segment   any
}

SegmentError may be returned as part of the DecodeList result. This allows a single segment to be decoded poorly with error, while still decoding the rest of the message. This will not be returned as an error.

func (SegmentError) Error

func (e SegmentError) Error() string

func (SegmentError) Unwrap

func (e SegmentError) Unwrap() []error

type Varies

type Varies interface {
	ChildVaries(reg func(string) (any, bool)) (reflect.Value, error)
}

Varies should be implemented on a segment that knows how to decode a child VARIES data type.