## Uses of Interface
cdac.medinfo.sdk.hl7282.commoninterface.ISegment

- Packages that use ISegment
  Package | Description
  --- | ---
  cdac.medinfo.sdk.hl7282.baselibs.messages | Provides Classes necessary to create Message, Acknowledgement and also contains Exception classes which are specific to message operations like serialize, validate & parse.
  cdac.medinfo.sdk.hl7282.baselibs.segments | Provides classes which implement segments in HL7 standard.
  cdac.medinfo.sdk.hl7282.commoninterface | Defines contract for base library and HL7 model.

- - ### Uses of ISegment in cdac.medinfo.sdk.hl7282.baselibs.messages

    Methods in cdac.medinfo.sdk.hl7282.baselibs.messages that return ISegment
    Modifier and Type | Method and Description
    --- | ---
    `ISegment` | LocalExtensionAgent.`createSegment(java.lang.String strSegmentName)` Creates empty Segment for specified locally extended segment.

    Methods in cdac.medinfo.sdk.hl7282.baselibs.messages that return types with arguments of type ISegment
    Modifier and Type | Method and Description
    --- | ---
    `ISingleCollection<ISegment>` | Message.`getSegment(ISegmentKey enumSegments)` Get the Segment Collection from the Message with the help of provided Segment Key.
    `ISingleCollection<ISegment>` | Group.`getSegment(ISegmentKey enumSegments)` Gives collection of segment of name enumSegments as passed by user.
    `ISingleCollection<ISegment>` | Group.`getSegmentCollection()` Retrieves collection of ISegment.

    Methods in cdac.medinfo.sdk.hl7282.baselibs.messages with parameters of type ISegment
    Modifier and Type | Method and Description
    --- | ---
    `void` | Group.`addSegment(ISegmentKey enumSegments, ISegment objSegment)` Adds segment in multi valued paired collection.

  - ### Uses of ISegment in cdac.medinfo.sdk.hl7282.baselibs.segments

    Classes in cdac.medinfo.sdk.hl7282.baselibs.segments that implement ISegment
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ABS` ABS - Abstract Segment
    `class` | `ACC` ACC - Accident Segment
    `class` | `ADD` ADD - Addendum Segment.
    `class` | `ADJ` ADJ - Adjustment This segment describes Provider and/or Payer adjustments to a Product/Service Line Item or Response Summary.
    `class` | `AFF` AFF - Professional Affiliation Segment
    `class` | `AIG` AIG - Appointment Information - General Resource Segment
    `class` | `AIL` AIL - Appointment Information-Location Resource Segment.
    `class` | `AIP` AIP - Appointment Information - Personnel Resource Segment
    `class` | `AIS` AIS - Appointment Information-Service Segment.
    `class` | `AL1` AL1 - Patient Allergy Information Segment
    `class` | `APR` APR - Appointment Preferences Segment
    `class` | `ARQ` ARQ - Appointment Request Segment
    `class` | `ARV` ARV - Access Restrictions segment.
    `class` | `AUT` AUT - Authorization Information Segment
    `class` | `BHS` BHS - batch header segment
    `class` | `BLC` BLC - Blood Code Segment.
    `class` | `BLG` BLG - Billing Segment.
    `class` | `BPO` BPO - Blood Product Order Segment.
    `class` | `BPX` BPX - Blood Product Dispense Status Segment.
    `class` | `BTS` BTS - Batch trailer segment
    `class` | `BTX` BTX - Blood Product Transfusion/Disposition Segment.
    `class` | `BUI` BUI - Blood Unit information Segment
    `class` | `CDM` CDM - Charge Description Master Segment.
    `class` | `CDO` CDO - Cumulative Dosage Segment.
    `class` | `CER` CER - Certificate Detail Segment
    `class` | `CM0` CM0 - Clinical Study Master Segment.
    `class` | `CM1` CM1 - Clinical Study Phase Master Segment
    `class` | `CM2` CM2 - Clinical Study Schedule Master Segment
    `class` | `CNS` CNS - Clear Notification Segment
    `class` | `ConsentSeg` CON - Consent Segment.
    `class` | `CSP` CSP - Clinical Study Phase Segment.
    `class` | `CSR` CSR - Clinical Study Registration Segment.
    `class` | `CSS` CSS - Clinical Study Data Schedule Segment.
    `class` | `CTD` CTD - Contact Data Segment.
    `class` | `CTI` CTI - Clinical Trial Identification Segment.
    `class` | `DB1` DB1 - Disability Segment.
    `class` | `DG1` DG1 - Diagnosis Segment.
    `class` | `DMI` DMI - Clinical Study Schedule Master Segment
    `class` | `DON` DON - Donation Segment
    `class` | `DPS` DPS - Diagnosis and Procedure Code Segment
    `class` | `DRG` DRG - Diagnosis Related Group Segment
    `class` | `DSC` DSC - continuation pointer segment
    `class` | `DSP` DSP - display data segment.
    `class` | `ECD` ECD - Equipment Command Segment
    `class` | `ECR` ECR - Equipment Command Response Segment
    `class` | `EDU` EDU - Educational Detail Segment
    `class` | `EQL` EQL - embedded query language segment
    `class` | `EQP` EQP - Equipment Log/Service Segment
    `class` | `EQU` EQU - Equipment Detail Segment
    `class` | `ERQ` ERQ - Event Replay Query Segment.
    `class` | `ERR` ERR - error segment
    `class` | `EVN` EVN - Event Type Segment
    `class` | `FAC` FAC - Facility Segment
    `class` | `FHS` FHS - File header segment
    `class` | `FT1` FT1 - Financial Transaction Segment
    `class` | `FTS` FTS - File trailer segment
    `class` | `GOL` GOL - Goal Detail Segment:
    `class` | `GP1` GP1 - Grouping/Reimbursement - Visit Segment.
    `class` | `GP2` GP2 Grouping/Reimbursement - Procedure Line Item Segment
    `class` | `GT1` GT1 - Guarantor Segment.
    `class` | `IAM` IAM - Patient Adverse Reaction Information Segment - Unique Identifier
    `class` | `IAR` IAR - Allergy Reaction Segment.
    `class` | `IIM` IIM - Inventory Item Master Segment
    `class` | `ILT` ILT - Material Lot Segment
    `class` | `IN1` IN1 - Insurance Segment
    `class` | `IN2` IN2 - Insurance Additional Information Segment.
    `class` | `IN3` IN3 - Insurance Additional Information, Certification Segment.
    `class` | `INV` INV - Inventory Detail Segment.
    `class` | `IPC` IPC - Imaging Procedure Control Segment.
    `class` | `IPR` IPR - Invoice Processing Results Segment The Invoice Processing Results (IPR) segment provides summary information about an adjudicated Product/Service Group or Product/Service Line Item
    `class` | `ISD` ISD - Interaction Status Detail Segment
    `class` | `ITM` ITM - Material Item Segment
    `class` | `IVC` IVC - Invoice Segment
    `class` | `IVT` IVT - Material Location Segment
    `class` | `LAN` LAN - Language Detail Segment
    `class` | `LCC` LCC - Location Charge Code Segment
    `class` | `LCH` LCH - Location Characteristic Segment
    `class` | `LDP` LDP - Location Department Segment.
    `class` | `LOC` LOC - Location Identification Segment.
    `class` | `LRL` LRL - Location Relationship Segment
    `class` | `MCP` MCP - Master File Coverage Policy Segment
    `class` | `MFA` MFA - Master File Acknowledgment Segment.
    `class` | `MFE` MFE - Master File Entry Segment.
    `class` | `MFI` MFI - Master File Identification Segment
    `class` | `MRG` MRG - Merge Patient Information Segment.
    `class` | `MSA` MSA - Message Acknowledgment Segment.
    `class` | `MSH` MSH - message header segment
    `class` | `NCK` NCK - System Clock Segment.
    `class` | `NDS` NDS - Notification Detail Segment
    `class` | `NK1` NK1 - Next of Kin / Associated Parties Segment.
    `class` | `NPU` NPU - Bed Status Update Segment
    `class` | `NSC` NSC - Application Status Change Segment.
    `class` | `NST` NST - Application Control-Level Statistics Segment
    `class` | `NTE` NTE - Notes and Comments Segment.
    `class` | `OBR` OBR - Observation Request Segment.
    `class` | `OBX` OBX - Observation/Result Segment.
    `class` | `ODS` ODS - dietary orders, supplements, and preferences segment.
    `class` | `ODT` ODT - diet tray instructions segment.
    `class` | `OM1` OM1 - General Segment (Fields That Apply to Most Observations).
    `class` | `OM2` OM2 - Numeric Observation Segment.
    `class` | `OM3` OM3 - Categorical Service/Test/Observation Segment
    `class` | `OM4` OM4 - Observations That Require Specimens Segment
    `class` | `OM5` OM5 - Observation Batteries (Sets) Segment
    `class` | `OM6` OM6 - Observations that are Calculated from Other Observations Segments.
    `class` | `OM7` OM7 - Additional Basic Attributes .
    `class` | `OMC` OCM - Additional Basic Attributes .
    `class` | `ORC` ORC - Common Order Segment.
    `class` | `ORG` ORG - Practitioner Organization Unit Segment
    `class` | `OVR` OVR - Override Segment
    `class` | `PAC` PAC - Shipment Package Segment .
    `class` | `PCE` PCE - Patient Charge Cost Center Exception
    `class` | `PCR` PCR - Possible Causal Relationship Segment.
    `class` | `PD1` PD1 - Patient Additional Demographic Segment
    `class` | `PDA` PDA - Patient Death and Autopsy Segment
    `class` | `PDC` PDC - Product Detail Country Segment
    `class` | `PEO` PEO - Product Experience Observation Segment.
    `class` | `PES` PES - Product Experience Sender Segment
    `class` | `PID` PID - Patient Identification Segment
    `class` | `PKG` PKG - Packaging Segment
    `class` | `PM1` PM1 - Payer Master File Segment
    `class` | `PMT` PMT - Payment Information Segment This segment contains information that describes a payment made by a Payer organization.
    `class` | `PR1` PR1 - Procedures Segment.
    `class` | `PRA` PRA - Practitioner Detail Segment
    `class` | `PRB` PRB - Problem Detail Segment.
    `class` | `PRC` PRC - Pricing Segment.
    `class` | `PRD` PRD - provider data segment
    `class` | `PRT` PRT - Participation Information Segment.
    `class` | `PSG` PSG - Product/Service Group Segment The Product/Service Group segment is used to form a logical grouping of Product/Service Line Items, Patients and Response Summaries for a particular Invoice.
    `class` | `PSH` PSH - Product Summary Header Segment.
    `class` | `PSL` PSL - Product/Service Line Item Segment The Product/Service Line Item segment is used to identify individual product/service items that typically are aggregated into an Invoice.
    `class` | `PSS` PSS - Product/Service Section Segment The Product/Service Section segment is used to form a logical grouping of Product/Service Group segments, Patients and Response Summaries for a particular Invoice.
    `class` | `PTH` PTH - Pathway Segment.
    `class` | `PV1` PV1 - Patient Visit Segment.
    `class` | `PV2` PV2 - Patient Visit - Additional Information Segment.
    `class` | `PYE` PYE - Payee Information Segment
    `class` | `QAK` QAK - Query Acknowledgment Segment.
    `class` | `QID` QID- Query Identification Segment
    `class` | `QPD` QPD - query parameter definition
    `class` | `QRI` QRI - query response instance segment.
    `class` | `RCP` RCP - Response Control Parameter Segment.
    `class` | `RDF` RDF - table row definition segment.
    `class` | `RDT` RDT - table row data segment.
    `class` | `REL` REL - Clinical Relationship Segment
    `class` | `RF1` RF1 - Referral Information Segment.
    `class` | `RFI` RFI - Request for Information
    `class` | `RGS` RGS - Resource Group Segment.
    `class` | `RMI` RMI - Risk Management Incident Segment.
    `class` | `ROL` ROL - Role Segment.
    `class` | `RQ1` RQ1 - Requisition Detail-1 Segment.
    `class` | `RQD` RQD - Requisition Detail Segment.
    `class` | `RXA` RXA - Pharmacy/Treatment Administration Segment.
    `class` | `RXC` RXC - Pharmacy/Treatment Component Order Segment.
    `class` | `RXD` RXD - Pharmacy/Treatment Dispense Segment.
    `class` | `RXE` RXE - Pharmacy/Treatment Encoded Order Segment.
    `class` | `RXG` RXG - Pharmacy/Treatment Give Segment.
    `class` | `RXO` RXO - Pharmacy/Treatment Order Segment.
    `class` | `RXR` RXR - Pharmacy/Treatment Route Segment.
    `class` | `RXV` RXV - Pharmacy/Treatment Infusion Segment.
    `class` | `SAC` SAC - Specimen Container Detail Segment.
    `class` | `SCD` SCD - Anti-Microbial Cycle Data Segment
    `class` | `SCH` SCH - Schedule Activity Information Segment.
    `class` | `SCP` SCP - Sterilizer Configuration Segment
    `class` | `SDD` SDD - Sterilization Device Data Segment
    `class` | `Segment` Segment is the abstract class which Declares the Methods Parse and Serialize.
    `class` | `SFT` SFT - software segment.
    `class` | `SGH` SGH - Segment Group Header
    `class` | `SGT` SGT - Segment Group Header
    `class` | `SHP` SHP - Shipment Segment .
    `class` | `SID` SID - Substance Identifier Segment.
    `class` | `SLT` SLT - Sterilization Lot Segment
    `class` | `SPM` SPM - Specimen Segment.
    `class` | `SPR` SPR - Stored Procedure Request.
    `class` | `STF` STF - Staff Identification Segment.
    `class` | `STZ` STZ - Sterilization Parameter Segment
    `class` | `TCC` TCC - Test Code Configuration Segment
    `class` | `TCD` TCD - Test Code Detail Segment.
    `class` | `TQ1` TQ1 - Timing/Quantity Segment.
    `class` | `TQ2` TQ2 - Timing/Quantity Relationship.
    `class` | `TXA` TXA - Transcription Document Header Segment.
    `class` | `UAC` UAC - User Authentication Credential Segment
    `class` | `UB2` UB2 - UniformBilling Data Segment.
    `class` | `VAR` VAR - Variance Segment
    `class` | `VND` VND - Purchasing Vendor Segment

    Methods in cdac.medinfo.sdk.hl7282.baselibs.segments that return ISegment
    Modifier and Type | Method and Description
    --- | ---
    `static ISegment` | SegmentFactory.`createSegment(java.lang.String strName)` Creates instance of Segment using name of segment.
    `ISegment` | SegmentSet.`getSegment(int iIndex)` Retrieves a Segment from a given index position.

    Methods in cdac.medinfo.sdk.hl7282.baselibs.segments that return types with arguments of type ISegment
    Modifier and Type | Method and Description
    --- | ---
    `ISingleCollection<ISegment>` | SegmentSet.`getList()` Retrieves list of segments
    `ICollectionIterator<ISegment>` | SegmentSet.`iterator()` Provides iterator over the collection of Segments

    Methods in cdac.medinfo.sdk.hl7282.baselibs.segments with parameters of type ISegment
    Modifier and Type | Method and Description
    --- | ---
    `void` | SegmentSet.`addSegment(ISegment objSegment)` Adds a segment in list.

  - ### Uses of ISegment in cdac.medinfo.sdk.hl7282.commoninterface

    Methods in cdac.medinfo.sdk.hl7282.commoninterface that return ISegment
    Modifier and Type | Method and Description
    --- | ---
    `ISegment` | ISegmentSet.`getSegment(int iIndex)` Retrieves segment instance from a given index position.

    Methods in cdac.medinfo.sdk.hl7282.commoninterface that return types with arguments of type ISegment
    Modifier and Type | Method and Description
    --- | ---
    `ISingleCollection<ISegment>` | ISegmentSet.`getList()` Retrieves list of segments.
    `ISingleCollection<ISegment>` | IGroup.`getSegment(ISegmentKey enumSegments)` Gives collection of segment of name enumSegments as passed by user.
    `ISingleCollection<ISegment>` | IGroup.`getSegmentCollection()` Retrieves collection of ISegment.
    `ICollectionIterator<ISegment>` | ISegmentSet.`iterator()` Retrieves a iterator to iterate through Segment List.

    Methods in cdac.medinfo.sdk.hl7282.commoninterface with parameters of type ISegment
    Modifier and Type | Method and Description
    --- | ---
    `void` | ISegmentSet.`addSegment(ISegment objSegment)` Adds a Segment in list.
    `void` | IGroup.`addSegment(ISegmentKey enumSegments, ISegment objSegment)` Adds segment in multi valued paired collection.