The hl7-client Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The hl7-client Reference Manual

This is the hl7-client Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 05:58:39 2022 GMT+0.

Table of Contents


1 Introduction

hl7-client

Common-Lisp client for sending HL7-Messages with MLLP envelope over TCP/IP socket.

The HL7 Version 2 Messaging Standard — Application Protocol for Electronic Data Exchange in Healthcare Environments — is considered to be the workhorse of data exchange in healthcare and is the most widely implemented standard for healthcare information in the world.

Source: http://www.hl7.org/about/FAQs/index.cfm?ref=nav ("General HL7 FAQ" > "Version 2" > "What is Version 2?")

The client sends HL7-Messages in MLLP evelopes to a TCP/IP socket and returns the acknowledges.

There is no validation of messages or acknowledges done by the client so it will NOT stop when an NACK-Message occurs.

License

http://opensource.org/licenses/BSD-3-Clause

Installation

HL7-Client is 'quickloadable':

(ql:quickload "hl7-client")

Usage

(hl7-client:send server port message-or-message-list)

hl7-client:send returns a list with the HL7-acknowledges

Example

For testing purposes there is a function (hl7-client:get-hl7-test-message) which returns a HL7-Message with random message-ID.

CL-USER> (hl7-client:SEND "localhost" 24777 (hl7-client:get-hl7-test-message))
("MSH|^~\\&|Receiving-App^^|Receiving-Facility^^|Sending-App^^|Sending-Facility^^|20150101195400^||ACK|9089|P^|2.2^^|||||||^^^^^|^MMSA|AA|9089^M")
CL-USER> (hl7-client:SEND "localhost" 24777 (list (hl7-client:get-hl7-test-message) (hl7-client:get-hl7-test-message)))
("MSH|^~\\&|Receiving-App^^|Receiving-Facility^^|Sending-App^^|Sending-Facility^^|20150101195400^||ACK|1800|P^|2.2^^|||||||^^^^^|^MMSA|AA|1800^M"
 "MSH|^~\\&|Receiving-App^^|Receiving-Facility^^|Sending-App^^|Sending-Facility^^|20150101195400^||ACK|1309|P^|2.2^^|||||||^^^^^|^MMSA|AA|1309^M")
CL-USER> 

^M = #\Return

Dependencies

Installable via Quicklisp:

(ql:quickload "usocket")

Development

I developed and tested hl7-client on:

ToDo


2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 hl7-client

hl7-client - send HL7-Messages over TCP/IP with MLLP

Author

Martin R. Enders <martin@martin-enders.de>

License

BSD

Dependency

usocket (system).

Source

hl7-client.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 hl7-client/hl7-client.asd

Source

hl7-client.asd.

Parent Component

hl7-client (system).

ASDF Systems

hl7-client.


3.1.2 hl7-client/package.lisp

Source

hl7-client.asd.

Parent Component

hl7-client (system).

Packages

hl7-client.


3.1.3 hl7-client/hl7-client.lisp

Dependency

package.lisp (file).

Source

hl7-client.asd.

Parent Component

hl7-client (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 hl7-client

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Ordinary functions

Function: get-hl7-test-message (&optional message-control-id)
Package

hl7-client.

Source

hl7-client.lisp.

Function: send (server port message-or-message-list)
Package

hl7-client.

Source

hl7-client.lisp.


5.2 Internals


Previous: , Up: Internals   [Contents][Index]

5.2.1 Ordinary functions

Function: get-hl7-test-message-list (&optional number-of-messages)
Package

hl7-client.

Source

hl7-client.lisp.

Function: mllp-send-message (stream line)

Print Message with MLLP Envelope to stream

Package

hl7-client.

Source

hl7-client.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables