# HL7v2 v3.10.1 - Table of Contents

Pure Elixir HL7 v2.x toolkit — schema-driven parsing, typed segments, message builder, MLLP transport

## Pages

- [HL7v2](readme.md)
- [Changelog](changelog.md)
- [LICENSE](license.md)

- Guides
  - [Getting Started](getting-started.md)
  - [Conformance Profiles](conformance-profiles.md)
  - [IHE Profile Pack](ihe-profiles.md)
  - [Migration Guide](migration.md)

- Reference
  - [HL7 v2.5.1 Segment Definitions Reference](segments.md)
  - [HL7 v2.5.1 Data Type Definitions](data-types.md)
  - [HL7 v2.5.1 Message Structure Reference](message-structures.md)
  - [HL7v2 Encoding Rules Reference](encoding-rules.md)
  - [HL7 v2.x Encoding Specification](encoding-specification.md)

## Modules

- [HL7v2.Access](HL7v2.Access.md): Path-based access to HL7v2 message fields.
- [HL7v2.Conformance.Fixtures](HL7v2.Conformance.Fixtures.md): Conformance fixture corpus statistics.
- [HL7v2.MessageDefinition](HL7v2.MessageDefinition.md): Canonical message structure mappings and validation dispatch.
- [HL7v2.Path](HL7v2.Path.md): Represents a validated HL7v2 path.
- [HL7v2.Profile](HL7v2.Profile.md): Conformance profile for constraining HL7v2 message structures beyond
the base HL7 spec.
- [HL7v2.Profile.ComponentAccess](HL7v2.Profile.ComponentAccess.md): Positional component access for HL7 composite data type structs.
- [HL7v2.Profiles.Examples](HL7v2.Profiles.Examples.md): Example conformance profiles demonstrating common integrator patterns.
- [HL7v2.Profiles.IHE](HL7v2.Profiles.IHE.md): Pre-built IHE conformance profiles for HL7 v2.x transactions.
- [HL7v2.Profiles.IHE.Common](HL7v2.Profiles.IHE.Common.md): Shared constraint helpers for the IHE profile pack.
- [HL7v2.Profiles.IHE.LTW](HL7v2.Profiles.IHE.LTW.md): IHE Laboratory Testing Workflow (LTW) conformance profiles.
- [HL7v2.Profiles.IHE.PAM](HL7v2.Profiles.IHE.PAM.md): IHE Patient Administration Management (PAM) conformance profiles.
- [HL7v2.Profiles.IHE.PDQ](HL7v2.Profiles.IHE.PDQ.md): IHE Patient Demographics Query (PDQ) conformance profiles.
- [HL7v2.Profiles.IHE.PIX](HL7v2.Profiles.IHE.PIX.md): IHE Patient Identifier Cross-Reference (PIX) conformance profiles.
- [HL7v2.Profiles.IHE.RadSwf](HL7v2.Profiles.IHE.RadSwf.md): IHE Radiology Scheduled Workflow (RAD-SWF) conformance profiles.
- [HL7v2.Segment](HL7v2.Segment.md): Base behaviour and helpers for typed HL7v2 segments.
- [HL7v2.Sigil](HL7v2.Sigil.md): Compile-time validated HL7v2 path sigil.
- [HL7v2.Standard](HL7v2.Standard.md): HL7 v2.5.1 standard metadata — single source of truth.
- [HL7v2.Standard.Coverage](HL7v2.Standard.Coverage.md): Computes library coverage against the HL7 v2.5.1 standard.
- [HL7v2.Standard.MessageStructure](HL7v2.Standard.MessageStructure.md): HL7 v2.5.1 abstract message structure definitions.
- [HL7v2.Standard.Tables](HL7v2.Standard.Tables.md): HL7 v2.5.1 coded-value tables.
- [HL7v2.Standard.Version](HL7v2.Standard.Version.md): HL7 v2.x version utilities.
- [HL7v2.Standard.VersionDeltas](HL7v2.Standard.VersionDeltas.md): Tracks field optionality changes between HL7 v2.x versions.
- [HL7v2.Type](HL7v2.Type.md): Base behaviour for HL7v2 data types.

- Core
  - [HL7v2](HL7v2.md): Pure Elixir HL7 v2.x toolkit.
  - [HL7v2.Encoder](HL7v2.Encoder.md): Serializes HL7v2 messages to wire format.
  - [HL7v2.Escape](HL7v2.Escape.md): Encodes and decodes HL7v2 escape sequences.
  - [HL7v2.Parser](HL7v2.Parser.md): Parses HL7v2 messages into raw representation with canonical round-trip fidelity.
  - [HL7v2.RawMessage](HL7v2.RawMessage.md): Represents a parsed HL7v2 message in raw form.
  - [HL7v2.Separator](HL7v2.Separator.md): Detects and manages HL7v2 message delimiters from MSH-1/MSH-2.

- Typed Messages
  - [HL7v2.Ack](HL7v2.Ack.md): Builds HL7v2 ACK/NAK response messages.
  - [HL7v2.Message](HL7v2.Message.md): Programmatic HL7v2 message construction.
  - [HL7v2.TypedMessage](HL7v2.TypedMessage.md): Typed HL7v2 message with parsed segment structs.
  - [HL7v2.TypedParser](HL7v2.TypedParser.md): Converts a raw-parsed HL7v2 message into typed segment structs.

- Segments
  - [HL7v2.Segment.ABS](HL7v2.Segment.ABS.md): Abstract (ABS) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.ACC](HL7v2.Segment.ACC.md): Accident (ACC) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.ADD](HL7v2.Segment.ADD.md): Addendum (ADD) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.AFF](HL7v2.Segment.AFF.md): Professional Affiliation (AFF) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.AIG](HL7v2.Segment.AIG.md): Appointment Information — General Resource (AIG) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.AIL](HL7v2.Segment.AIL.md): Appointment Information — Location Resource (AIL) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.AIP](HL7v2.Segment.AIP.md): Appointment Information — Personnel Resource (AIP) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.AIS](HL7v2.Segment.AIS.md): Appointment Information — Service (AIS) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.AL1](HL7v2.Segment.AL1.md): Patient Allergy Information (AL1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.APR](HL7v2.Segment.APR.md): Appointment Preferences (APR) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.ARQ](HL7v2.Segment.ARQ.md): Appointment Request (ARQ) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.ARV](HL7v2.Segment.ARV.md): Access Restriction (ARV) segment — HL7v2 v2.6+.
  - [HL7v2.Segment.AUT](HL7v2.Segment.AUT.md): Authorization Information (AUT) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.BHS](HL7v2.Segment.BHS.md): Batch Header (BHS) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.BLC](HL7v2.Segment.BLC.md): Blood Code (BLC) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.BLG](HL7v2.Segment.BLG.md): Billing (BLG) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.BPO](HL7v2.Segment.BPO.md): Blood Product Order (BPO) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.BPX](HL7v2.Segment.BPX.md): Blood Product Dispense Status (BPX) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.BTS](HL7v2.Segment.BTS.md): Batch Trailer (BTS) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.BTX](HL7v2.Segment.BTX.md): Blood Product Transfusion/Disposition (BTX) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.CDM](HL7v2.Segment.CDM.md): Charge Description Master (CDM) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.CER](HL7v2.Segment.CER.md): Certificate Detail (CER) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.CM0](HL7v2.Segment.CM0.md): Clinical Study Master (CM0) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.CM1](HL7v2.Segment.CM1.md): Clinical Study Phase Master (CM1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.CM2](HL7v2.Segment.CM2.md): Clinical Study Schedule Master (CM2) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.CNS](HL7v2.Segment.CNS.md): Clear Notification (CNS) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.CON](HL7v2.Segment.CON.md): Consent (CON) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.CSP](HL7v2.Segment.CSP.md): Clinical Study Phase (CSP) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.CSR](HL7v2.Segment.CSR.md): Clinical Study Registration (CSR) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.CSS](HL7v2.Segment.CSS.md): Clinical Study Data Schedule (CSS) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.CTD](HL7v2.Segment.CTD.md): Contact Data (CTD) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.CTI](HL7v2.Segment.CTI.md): Clinical Trial Identification (CTI) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.DB1](HL7v2.Segment.DB1.md): Disability (DB1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.DG1](HL7v2.Segment.DG1.md): Diagnosis (DG1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.DRG](HL7v2.Segment.DRG.md): Diagnosis Related Group (DRG) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.DSC](HL7v2.Segment.DSC.md): Continuation Pointer (DSC) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.DSP](HL7v2.Segment.DSP.md): Display Data (DSP) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.ECD](HL7v2.Segment.ECD.md): Equipment Command (ECD) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.ECR](HL7v2.Segment.ECR.md): Equipment Command Response (ECR) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.EDU](HL7v2.Segment.EDU.md): Educational Detail (EDU) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.EQL](HL7v2.Segment.EQL.md): Embedded Query Language (EQL) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.EQP](HL7v2.Segment.EQP.md): Equipment Log Service (EQP) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.EQU](HL7v2.Segment.EQU.md): Equipment Detail (EQU) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.ERQ](HL7v2.Segment.ERQ.md): Event Replay Query (ERQ) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.ERR](HL7v2.Segment.ERR.md): Error (ERR) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.EVN](HL7v2.Segment.EVN.md): Event Type (EVN) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.FAC](HL7v2.Segment.FAC.md): Facility (FAC) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.FHS](HL7v2.Segment.FHS.md): File Header (FHS) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.FT1](HL7v2.Segment.FT1.md): Financial Transaction (FT1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.FTS](HL7v2.Segment.FTS.md): File Trailer (FTS) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.GOL](HL7v2.Segment.GOL.md): Goal Detail (GOL) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.GP1](HL7v2.Segment.GP1.md): Grouping/Reimbursement — Visit (GP1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.GP2](HL7v2.Segment.GP2.md): Grouping/Reimbursement -- Procedure Line Item (GP2) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.GT1](HL7v2.Segment.GT1.md): Guarantor (GT1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.IAM](HL7v2.Segment.IAM.md): Patient Adverse Reaction Information (IAM) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.IAR](HL7v2.Segment.IAR.md): Allergy Reaction (IAR) segment — HL7v2 v2.7+.
  - [HL7v2.Segment.IIM](HL7v2.Segment.IIM.md): Inventory Item Master (IIM) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.ILT](HL7v2.Segment.ILT.md): Material Lot (ILT) segment — HL7v2 v2.6+ (Chapter 17 Materials Management).
  - [HL7v2.Segment.IN1](HL7v2.Segment.IN1.md): Insurance (IN1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.IN2](HL7v2.Segment.IN2.md): Insurance Additional Information (IN2) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.IN3](HL7v2.Segment.IN3.md): Insurance Additional Information, Certification (IN3) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.INV](HL7v2.Segment.INV.md): Inventory Detail (INV) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.IPC](HL7v2.Segment.IPC.md): Imaging Procedure Control (IPC) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.ISD](HL7v2.Segment.ISD.md): Interaction Status Detail (ISD) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.ITM](HL7v2.Segment.ITM.md): Material Item Master (ITM) segment — HL7v2 v2.6+ (Chapter 17 Materials Management).
  - [HL7v2.Segment.IVT](HL7v2.Segment.IVT.md): Material Location (IVT) segment — HL7v2 v2.6+ (Chapter 17 Materials Management).
  - [HL7v2.Segment.LAN](HL7v2.Segment.LAN.md): Language Detail (LAN) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.LCC](HL7v2.Segment.LCC.md): Location Charge Code (LCC) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.LCH](HL7v2.Segment.LCH.md): Location Characteristic (LCH) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.LDP](HL7v2.Segment.LDP.md): Location Department (LDP) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.LOC](HL7v2.Segment.LOC.md): Location Identification (LOC) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.LRL](HL7v2.Segment.LRL.md): Location Relationship (LRL) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.MFA](HL7v2.Segment.MFA.md): Master File Acknowledgment (MFA) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.MFE](HL7v2.Segment.MFE.md): Master File Entry (MFE) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.MFI](HL7v2.Segment.MFI.md): Master File Identification (MFI) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.MRG](HL7v2.Segment.MRG.md): Merge Patient Information (MRG) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.MSA](HL7v2.Segment.MSA.md): Message Acknowledgment (MSA) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.MSH](HL7v2.Segment.MSH.md): Message Header (MSH) segment — HL7v2 v2.5.1, with v2.7+ extensions.
  - [HL7v2.Segment.NCK](HL7v2.Segment.NCK.md): System Clock (NCK) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.NDS](HL7v2.Segment.NDS.md): Notification Detail (NDS) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.NK1](HL7v2.Segment.NK1.md): Next of Kin / Associated Parties (NK1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.NPU](HL7v2.Segment.NPU.md): Bed Status Update (NPU) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.NSC](HL7v2.Segment.NSC.md): Application Status Change (NSC) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.NST](HL7v2.Segment.NST.md): Application Control Level Statistics (NST) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.NTE](HL7v2.Segment.NTE.md): Notes and Comments (NTE) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.OBR](HL7v2.Segment.OBR.md): Observation Request (OBR) segment — HL7v2 v2.5.1, with v2.7+ extensions.
  - [HL7v2.Segment.OBX](HL7v2.Segment.OBX.md): Observation/Result (OBX) segment -- HL7v2 v2.5.1, with v2.7+ extensions.
  - [HL7v2.Segment.OBXValue](HL7v2.Segment.OBXValue.md): Dispatches OBX-5 (observation_value) parsing based on OBX-2 (value_type).
  - [HL7v2.Segment.ODS](HL7v2.Segment.ODS.md): Dietary Orders, Supplements, and Preferences (ODS) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.ODT](HL7v2.Segment.ODT.md): Diet Tray Instructions (ODT) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.OM1](HL7v2.Segment.OM1.md): General Segment (OM1) -- HL7v2 v2.5.1.
  - [HL7v2.Segment.OM2](HL7v2.Segment.OM2.md): Numeric Observation (OM2) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.OM3](HL7v2.Segment.OM3.md): Categorical Service/Test/Observation (OM3) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.OM4](HL7v2.Segment.OM4.md): Observations that Require Specimens (OM4) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.OM5](HL7v2.Segment.OM5.md): Observation Batteries (OM5) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.OM6](HL7v2.Segment.OM6.md): Observations Calculated from Others (OM6) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.OM7](HL7v2.Segment.OM7.md): Additional Basic Attributes (OM7) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.ORC](HL7v2.Segment.ORC.md): Common Order (ORC) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.ORG](HL7v2.Segment.ORG.md): Practitioner Organization Unit (ORG) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.OVR](HL7v2.Segment.OVR.md): Override Segment (OVR) -- HL7v2 v2.5.1.
  - [HL7v2.Segment.PCR](HL7v2.Segment.PCR.md): Possible Causal Relationship (PCR) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.PD1](HL7v2.Segment.PD1.md): Patient Additional Demographic (PD1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.PDA](HL7v2.Segment.PDA.md): Patient Death and Autopsy (PDA) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.PDC](HL7v2.Segment.PDC.md): Product Detail Country (PDC) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.PEO](HL7v2.Segment.PEO.md): Product Experience Observation (PEO) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.PES](HL7v2.Segment.PES.md): Product Experience Sender (PES) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.PID](HL7v2.Segment.PID.md): Patient Identification (PID) segment — HL7v2 v2.5.1, with v2.7+ extensions.
  - [HL7v2.Segment.PKG](HL7v2.Segment.PKG.md): Item Packaging (PKG) segment — HL7v2 v2.6+ (Chapter 17 Materials Management).
  - [HL7v2.Segment.PR1](HL7v2.Segment.PR1.md): Procedures (PR1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.PRA](HL7v2.Segment.PRA.md): Practitioner Detail (PRA) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.PRB](HL7v2.Segment.PRB.md): Problem Details (PRB) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.PRC](HL7v2.Segment.PRC.md): Pricing (PRC) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.PRD](HL7v2.Segment.PRD.md): Provider Data (PRD) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.PRT](HL7v2.Segment.PRT.md): Participation Information (PRT) segment — HL7v2 v2.7+.
  - [HL7v2.Segment.PSH](HL7v2.Segment.PSH.md): Product Summary Header (PSH) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.PTH](HL7v2.Segment.PTH.md): Pathway (PTH) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.PV1](HL7v2.Segment.PV1.md): Patient Visit (PV1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.PV2](HL7v2.Segment.PV2.md): Patient Visit — Additional Information (PV2) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.QAK](HL7v2.Segment.QAK.md): Query Acknowledgment (QAK) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.QID](HL7v2.Segment.QID.md): Query Identification (QID) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.QPD](HL7v2.Segment.QPD.md): Query Parameter Definition (QPD) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.QRD](HL7v2.Segment.QRD.md): Original-Style Query Definition (QRD) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.QRF](HL7v2.Segment.QRF.md): Original Style Query Filter (QRF) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.QRI](HL7v2.Segment.QRI.md): Query Response Instance (QRI) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.RCP](HL7v2.Segment.RCP.md): Response Control Parameter (RCP) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.RDF](HL7v2.Segment.RDF.md): Table Row Definition (RDF) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.RDT](HL7v2.Segment.RDT.md): Table Row Data (RDT) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.RF1](HL7v2.Segment.RF1.md): Referral Information (RF1) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.RGS](HL7v2.Segment.RGS.md): Resource Group Segment (RGS) — HL7v2 v2.5.1.
  - [HL7v2.Segment.RMI](HL7v2.Segment.RMI.md): Risk Management Incident (RMI) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.ROL](HL7v2.Segment.ROL.md): Role (ROL) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.RQ1](HL7v2.Segment.RQ1.md): Requisition Detail-1 (RQ1) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.RQD](HL7v2.Segment.RQD.md): Requisition Detail (RQD) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.RXA](HL7v2.Segment.RXA.md): Pharmacy/Treatment Administration (RXA) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.RXC](HL7v2.Segment.RXC.md): Pharmacy/Treatment Component Order (RXC) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.RXD](HL7v2.Segment.RXD.md): Pharmacy/Treatment Dispense (RXD) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.RXE](HL7v2.Segment.RXE.md): Pharmacy/Treatment Encoded Order (RXE) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.RXG](HL7v2.Segment.RXG.md): Pharmacy/Treatment Give (RXG) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.RXO](HL7v2.Segment.RXO.md): Pharmacy/Treatment Order (RXO) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.RXR](HL7v2.Segment.RXR.md): Pharmacy/Treatment Route (RXR) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.SAC](HL7v2.Segment.SAC.md): Specimen Container Detail (SAC) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.SCD](HL7v2.Segment.SCD.md): Anti-Microbial Cycle Data (SCD) segment -- HL7v2 v2.6 extension.
  - [HL7v2.Segment.SCH](HL7v2.Segment.SCH.md): Scheduling Activity Information (SCH) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.SCP](HL7v2.Segment.SCP.md): Sterilizer Configuration (SCP) segment — HL7v2 v2.6+ (Chapter 17 Materials Management).
  - [HL7v2.Segment.SDD](HL7v2.Segment.SDD.md): Sterilization Device Data (SDD) segment -- HL7v2 v2.6 extension.
  - [HL7v2.Segment.SFT](HL7v2.Segment.SFT.md): Software Segment (SFT) — HL7v2 v2.5.1.
  - [HL7v2.Segment.SID](HL7v2.Segment.SID.md): Substance Identifier (SID) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.SLT](HL7v2.Segment.SLT.md): Sterilization Lot (SLT) segment — HL7v2 v2.6+ (Chapter 17 Materials Management).
  - [HL7v2.Segment.SPM](HL7v2.Segment.SPM.md): Specimen (SPM) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.SPR](HL7v2.Segment.SPR.md): Stored Procedure Request Definition (SPR) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.STF](HL7v2.Segment.STF.md): Staff Identification (STF) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.STZ](HL7v2.Segment.STZ.md): Sterilization Parameter (STZ) segment — HL7v2 v2.6+ (Chapter 17 Materials Management).
  - [HL7v2.Segment.TCC](HL7v2.Segment.TCC.md): Test Code Configuration (TCC) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.TCD](HL7v2.Segment.TCD.md): Test Code Detail (TCD) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.TQ1](HL7v2.Segment.TQ1.md): Timing/Quantity (TQ1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.TQ2](HL7v2.Segment.TQ2.md): Timing/Quantity Relationship (TQ2) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.TXA](HL7v2.Segment.TXA.md): Transcription Document Header (TXA) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.UAC](HL7v2.Segment.UAC.md): User Authentication Credential (UAC) segment — HL7v2 v2.7+.
  - [HL7v2.Segment.UB1](HL7v2.Segment.UB1.md): UB82 (UB1) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.UB2](HL7v2.Segment.UB2.md): UB92 Data (UB2) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.URD](HL7v2.Segment.URD.md): Results/Update Definition (URD) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.URS](HL7v2.Segment.URS.md): Unsolicited Selection (URS) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.VAR](HL7v2.Segment.VAR.md): Variance (VAR) segment — HL7v2 v2.5.1.
  - [HL7v2.Segment.VND](HL7v2.Segment.VND.md): Purchasing Vendor (VND) segment — HL7v2 v2.6+ (Chapter 17 Materials Management).
  - [HL7v2.Segment.VTQ](HL7v2.Segment.VTQ.md): Virtual Table Query Request (VTQ) segment -- HL7v2 v2.5.1.
  - [HL7v2.Segment.ZXX](HL7v2.Segment.ZXX.md): Generic Z-Segment (ZXX) — HL7v2 v2.5.1.

- Data Types
  - [HL7v2.Type.AD](HL7v2.Type.AD.md): Address (AD) -- HL7v2 composite data type.
  - [HL7v2.Type.AUI](HL7v2.Type.AUI.md): Authorization Information (AUI) -- HL7v2 composite data type.
  - [HL7v2.Type.CCD](HL7v2.Type.CCD.md): Charge Code and Date (CCD) -- HL7v2 composite data type.
  - [HL7v2.Type.CCP](HL7v2.Type.CCP.md): Channel Calibration Parameters (CCP) -- HL7v2 composite data type.
  - [HL7v2.Type.CD](HL7v2.Type.CD.md): Channel Definition (CD) -- HL7v2 composite data type.
  - [HL7v2.Type.CE](HL7v2.Type.CE.md): Coded Element (CE) -- HL7v2 composite data type.
  - [HL7v2.Type.CF](HL7v2.Type.CF.md): Coded Element with Formatted Values (CF) -- HL7v2 composite data type.
  - [HL7v2.Type.CNE](HL7v2.Type.CNE.md): Coded with No Exceptions (CNE) -- HL7v2 composite data type.
  - [HL7v2.Type.CNN](HL7v2.Type.CNN.md): Composite Number and Name without Authority (CNN) -- HL7v2 composite data type.
  - [HL7v2.Type.CP](HL7v2.Type.CP.md): Composite Price (CP) -- HL7v2 composite data type.
  - [HL7v2.Type.CQ](HL7v2.Type.CQ.md): Composite Quantity with Units (CQ) -- HL7v2 composite data type.
  - [HL7v2.Type.CSU](HL7v2.Type.CSU.md): Channel Sensitivity and Units (CSU) -- HL7v2 composite data type.
  - [HL7v2.Type.CWE](HL7v2.Type.CWE.md): Coded with Exceptions (CWE) -- HL7v2 composite data type.
  - [HL7v2.Type.CX](HL7v2.Type.CX.md): Extended Composite ID with Check Digit (CX) -- HL7v2 composite data type.
  - [HL7v2.Type.DDI](HL7v2.Type.DDI.md): Daily Deductible Information (DDI) -- HL7v2 composite data type.
  - [HL7v2.Type.DIN](HL7v2.Type.DIN.md): Date and Institution Name (DIN) -- HL7v2 composite data type.
  - [HL7v2.Type.DLD](HL7v2.Type.DLD.md): Discharge to Location and Date (DLD) -- HL7v2 composite data type.
  - [HL7v2.Type.DLN](HL7v2.Type.DLN.md): Driver's License Number (DLN) -- HL7v2 composite data type.
  - [HL7v2.Type.DLT](HL7v2.Type.DLT.md): Delta (DLT) -- HL7v2 composite data type.
  - [HL7v2.Type.DR](HL7v2.Type.DR.md): Date/Time Range (DR) -- HL7v2 composite data type.
  - [HL7v2.Type.DT](HL7v2.Type.DT.md): Date (DT) -- HL7v2 primitive data type.
  - [HL7v2.Type.DTM](HL7v2.Type.DTM.md): Date/Time (DTM) -- HL7v2 primitive data type.
  - [HL7v2.Type.DTN](HL7v2.Type.DTN.md): Day Type and Number (DTN) -- HL7v2 composite data type.
  - [HL7v2.Type.ED](HL7v2.Type.ED.md): Encapsulated Data (ED) -- HL7v2 composite data type.
  - [HL7v2.Type.EI](HL7v2.Type.EI.md): Entity Identifier (EI) -- HL7v2 composite data type.
  - [HL7v2.Type.EIP](HL7v2.Type.EIP.md): Entity Identifier Pair (EIP) -- HL7v2 composite data type.
  - [HL7v2.Type.ELD](HL7v2.Type.ELD.md): Error Location and Description (ELD) -- HL7v2 composite data type.
  - [HL7v2.Type.ERL](HL7v2.Type.ERL.md): Error Location (ERL) -- HL7v2 composite data type.
  - [HL7v2.Type.FC](HL7v2.Type.FC.md): Financial Class (FC) -- HL7v2 composite data type.
  - [HL7v2.Type.FN](HL7v2.Type.FN.md): Family Name (FN) -- HL7v2 sub-component composite type.
  - [HL7v2.Type.FT](HL7v2.Type.FT.md): Formatted Text Data (FT) -- HL7v2 primitive data type.
  - [HL7v2.Type.GTS](HL7v2.Type.GTS.md): General Timing Specification (GTS) -- HL7v2 primitive data type.
  - [HL7v2.Type.HD](HL7v2.Type.HD.md): Hierarchic Designator (HD) -- HL7v2 composite data type.
  - [HL7v2.Type.ICD](HL7v2.Type.ICD.md): Insurance Certification Definition (ICD) -- HL7v2 composite data type.
  - [HL7v2.Type.ID](HL7v2.Type.ID.md): Coded Value for HL7-Defined Tables (ID) -- HL7v2 primitive data type.
  - [HL7v2.Type.IS](HL7v2.Type.IS.md): Coded Value for User-Defined Tables (IS) -- HL7v2 primitive data type.
  - [HL7v2.Type.JCC](HL7v2.Type.JCC.md): Job Code/Class (JCC) -- HL7v2 composite data type.
  - [HL7v2.Type.LA1](HL7v2.Type.LA1.md): Location with Address Variation 1 (LA1) -- HL7v2 composite data type.
  - [HL7v2.Type.LA2](HL7v2.Type.LA2.md): Location with Address Variation 2 (LA2) -- HL7v2 composite data type.
  - [HL7v2.Type.MA](HL7v2.Type.MA.md): Multiplexed Array (MA) -- HL7v2 composite data type.
  - [HL7v2.Type.MO](HL7v2.Type.MO.md): Money (MO) -- HL7v2 composite data type.
  - [HL7v2.Type.MOC](HL7v2.Type.MOC.md): Money and Charge Code (MOC) -- HL7v2 composite data type.
  - [HL7v2.Type.MOP](HL7v2.Type.MOP.md): Money or Percentage (MOP) -- HL7v2 composite data type.
  - [HL7v2.Type.MSG](HL7v2.Type.MSG.md): Message Type (MSG) -- HL7v2 composite data type.
  - [HL7v2.Type.NA](HL7v2.Type.NA.md): Numeric Array (NA) -- HL7v2 composite data type.
  - [HL7v2.Type.NDL](HL7v2.Type.NDL.md): Name with Date and Location (NDL) -- HL7v2 composite data type.
  - [HL7v2.Type.NM](HL7v2.Type.NM.md): Numeric (NM) -- HL7v2 primitive data type.
  - [HL7v2.Type.NR](HL7v2.Type.NR.md): Numeric Range (NR) -- HL7v2 composite data type.
  - [HL7v2.Type.OCD](HL7v2.Type.OCD.md): Occurrence Code and Date (OCD) -- HL7v2 composite data type.
  - [HL7v2.Type.OSD](HL7v2.Type.OSD.md): Order Sequence Definition (OSD) -- HL7v2 composite data type.
  - [HL7v2.Type.OSP](HL7v2.Type.OSP.md): Occurrence Span Code and Date (OSP) -- HL7v2 composite data type.
  - [HL7v2.Type.PIP](HL7v2.Type.PIP.md): Practitioner Institutional Privileges (PIP) -- HL7v2 composite data type.
  - [HL7v2.Type.PL](HL7v2.Type.PL.md): Person Location (PL) -- HL7v2 composite data type.
  - [HL7v2.Type.PLN](HL7v2.Type.PLN.md): Practitioner License or Other ID Number (PLN) -- HL7v2 composite data type.
  - [HL7v2.Type.PPN](HL7v2.Type.PPN.md): Performing Person Time Stamp (PPN) -- HL7v2 composite data type.
  - [HL7v2.Type.PRL](HL7v2.Type.PRL.md): Parent Result Link (PRL) -- HL7v2 composite data type.
  - [HL7v2.Type.PT](HL7v2.Type.PT.md): Processing Type (PT) -- HL7v2 composite data type.
  - [HL7v2.Type.PTA](HL7v2.Type.PTA.md): Policy Type and Amount (PTA) -- HL7v2 composite data type.
  - [HL7v2.Type.QIP](HL7v2.Type.QIP.md): Query Input Parameter List (QIP) -- HL7v2 composite data type.
  - [HL7v2.Type.QSC](HL7v2.Type.QSC.md): Query Selection Criteria (QSC) -- HL7v2 composite data type.
  - [HL7v2.Type.RCD](HL7v2.Type.RCD.md): Row Column Definition (RCD) -- HL7v2 composite data type.
  - [HL7v2.Type.RFR](HL7v2.Type.RFR.md): Reference Range (RFR) -- HL7v2 composite data type.
  - [HL7v2.Type.RI](HL7v2.Type.RI.md): Repeat Interval (RI) -- HL7v2 composite data type.
  - [HL7v2.Type.RMC](HL7v2.Type.RMC.md): Room Coverage (RMC) -- HL7v2 composite data type.
  - [HL7v2.Type.RP](HL7v2.Type.RP.md): Reference Pointer (RP) -- HL7v2 composite data type.
  - [HL7v2.Type.RPT](HL7v2.Type.RPT.md): Repeat Pattern (RPT) -- HL7v2 composite data type.
  - [HL7v2.Type.SAD](HL7v2.Type.SAD.md): Street Address (SAD) -- HL7v2 sub-component composite type.
  - [HL7v2.Type.SCV](HL7v2.Type.SCV.md): Scheduling Class Value Pair (SCV) -- HL7v2 composite data type.
  - [HL7v2.Type.SI](HL7v2.Type.SI.md): Sequence ID (SI) -- HL7v2 primitive data type.
  - [HL7v2.Type.SN](HL7v2.Type.SN.md): Structured Numeric (SN) -- HL7v2 composite data type.
  - [HL7v2.Type.SPD](HL7v2.Type.SPD.md): Specialty Description (SPD) -- HL7v2 composite data type.
  - [HL7v2.Type.SPS](HL7v2.Type.SPS.md): Specimen Source (SPS) -- HL7v2 composite data type.
  - [HL7v2.Type.SRT](HL7v2.Type.SRT.md): Sort Order (SRT) -- HL7v2 composite data type.
  - [HL7v2.Type.ST](HL7v2.Type.ST.md): String Data (ST) -- HL7v2 primitive data type.
  - [HL7v2.Type.TM](HL7v2.Type.TM.md): Time (TM) -- HL7v2 primitive data type.
  - [HL7v2.Type.TN](HL7v2.Type.TN.md): Telephone Number (TN) -- HL7v2 primitive data type.
  - [HL7v2.Type.TQ](HL7v2.Type.TQ.md): Timing/Quantity (TQ) -- HL7v2 composite data type.
  - [HL7v2.Type.TS](HL7v2.Type.TS.md): Time Stamp (TS) -- HL7v2 composite data type.
  - [HL7v2.Type.TX](HL7v2.Type.TX.md): Text Data (TX) -- HL7v2 primitive data type.
  - [HL7v2.Type.UVC](HL7v2.Type.UVC.md): UB Value Code and Amount (UVC) -- HL7v2 composite data type.
  - [HL7v2.Type.VH](HL7v2.Type.VH.md): Visiting Hours (VH) -- HL7v2 composite data type.
  - [HL7v2.Type.VID](HL7v2.Type.VID.md): Version Identifier (VID) -- HL7v2 composite data type.
  - [HL7v2.Type.VR](HL7v2.Type.VR.md): Value Range (VR) -- HL7v2 composite data type.
  - [HL7v2.Type.WVI](HL7v2.Type.WVI.md): Channel Identifier (WVI) -- HL7v2 composite data type.
  - [HL7v2.Type.WVS](HL7v2.Type.WVS.md): Waveform Source (WVS) -- HL7v2 composite data type.
  - [HL7v2.Type.XAD](HL7v2.Type.XAD.md): Extended Address (XAD) -- HL7v2 composite data type.
  - [HL7v2.Type.XCN](HL7v2.Type.XCN.md): Extended Composite ID Number and Name for Persons (XCN) -- HL7v2 composite data type.
  - [HL7v2.Type.XON](HL7v2.Type.XON.md): Extended Composite Name and ID for Organizations (XON) -- HL7v2 composite data type.
  - [HL7v2.Type.XPN](HL7v2.Type.XPN.md): Extended Person Name (XPN) -- HL7v2 composite data type.
  - [HL7v2.Type.XTN](HL7v2.Type.XTN.md): Extended Telecommunication Number (XTN) -- HL7v2 composite data type.

- Validation
  - [HL7v2.Validation](HL7v2.Validation.md): Validates HL7v2 typed messages.
  - [HL7v2.Validation.FieldRules](HL7v2.Validation.FieldRules.md): Field-level validation rules for HL7v2 typed segments.
  - [HL7v2.Validation.MessageRules](HL7v2.Validation.MessageRules.md): Message-level validation rules for HL7v2 typed messages.
  - [HL7v2.Validation.ProfileRules](HL7v2.Validation.ProfileRules.md): Evaluates a `HL7v2.Profile` against a typed message and returns validation
errors. Called from `HL7v2.Validation.validate/2` when a `:profile` option
is provided.
  - [HL7v2.Validation.Structural](HL7v2.Validation.Structural.md): Positional structural validation against HL7 v2.5.1 abstract message definitions.

- MLLP Transport
  - [HL7v2.MLLP](HL7v2.MLLP.md): MLLP (Minimal Lower Layer Protocol) framing for HL7v2 messages.
  - [HL7v2.MLLP.Client](HL7v2.MLLP.Client.md): MLLP TCP client for sending HL7v2 messages.
  - [HL7v2.MLLP.Connection](HL7v2.MLLP.Connection.md): Ranch protocol handler for MLLP connections.
  - [HL7v2.MLLP.Handler](HL7v2.MLLP.Handler.md): Behaviour for MLLP message handlers.
  - [HL7v2.MLLP.Listener](HL7v2.MLLP.Listener.md): MLLP TCP listener using Ranch 2.x.
  - [HL7v2.MLLP.TLS](HL7v2.MLLP.TLS.md): TLS configuration helpers for MLLP connections.

- Telemetry
  - [HL7v2.Telemetry](HL7v2.Telemetry.md): Telemetry event helpers for HL7v2 operations.

## Mix Tasks

- [mix hl7v2.coverage](Mix.Tasks.Hl7v2.Coverage.md): Prints HL7 v2.5.1 coverage report for the hl7v2 library.
- [mix hl7v2.gen_docs](Mix.Tasks.Hl7v2.GenDocs.md): Generates reference documentation from code metadata.