ex_hl7 v1.0.0 API Reference

Main module of the ex_hl7 library.

Functions that decode and encode HL7 fields, repetitions, components and subcomponents.

Generic functions used by HL7 composite field macros

Behavior representing a module used to build HL7 composites based on their composite ID.

2.9.3 CE - coded element

2.16.5.1 ERR-1 Error code and location (CM) 00024

6.5.6.14 IN1-14 Authorization information (CM) 00439

2.16.9.9 MSH-9 Message type (CM) 00009

7.4.1.15 OBR-15 Specimen source (CM) 00249

7.4.1.23 OBR-23 Charge to practice (CM) 00256

7.4.1.26 OBR-26 Parent result (CM) 00259

7.4.1.29 OBR-29 Parent (CM) 00261

7.4.1.32 OBR-32 Principal result interpreter (CM) 00264

11.6.3.7 PRD-7 Provider identifiers (CM) 01162

Custom composite type for PRD-7.2

QPD_Q15-3 Provider ID number (CM)

4.3.10 Order sequencing component (CM)

4.3.2 Interval component (CM)

2.9.7 CN - composite ID number and name

2.9.9 CP - composite price

2.9.10 CQ - composite quantity with units

2.9.12 CX - extended composite ID with check digit

2.9.54.10 Name validity range (DR)

2.9.17 EI - entity identifier

2.9.19 FN - family name

2.9.5.4 Assigning authority (HD)

2.9.26 MO - money

2.9.29 PL - person location

4.3 Quantity/Timing (TQ) data type definition

2.9.51 XAD - extended address

2.9.52 XCN - extended composite ID number and name for persons

2.9.54 XPN - extended person name

2.9.55 XTN - extended telecommunication number

Macros and functions used to define HL7 composite fields

Stores configuration variables for the HL7 parser.

Lexer used by the HL7 parser to retrieve tokens from a buffer.

Module used to read, write and retrieve segments from an HL7 message.

Reader for the HL7 protocol. You can test its functionality with the following lines on ìex

Generic functions used by HL7 segment macros

Behavior representing a module used to build HL7 segments based on their segment ID.

11.6.2 AUT - authorization information segment

Builder for the default HL7 segments

6.5.2 DG1 - diagnosis segment

2.16.4 DSC - continuation pointer segment

5.5.1 DSP - display data segment

2.16.5 ERR - error segment

3.4.1 EVN - event type segment

6.5.6 IN1 - insurance segment

2.16.8 MSA - message acknowledgment segment

2.16.9 MSH - message header segment

2.16.10 NTE - notes and comments segment

7.4.2 OBX - observation/result segment

3.4.2 PID - patient identification segment

6.5.4 PR1 - procedures segment

11.6.3 PRD - provider data segment

3.4.3 PV1 - patient visit segment

3.4.4 PV2 - patient visit - additional information segment

5.5.2 QAK - query acknowledgment segment

5.5.3 QPD - query parameter definition - procedure totals

5.5.5 RCP - response control parameter segment

11.6.1 RF1 - referral information segment

Procedure authorization information

Additional insurance information

Macros and functions used to define HL7 segments

Type specifications used by the library.

Writer for the HL7 protocol that converts a message into its wire format.