EHC_E12 (HAPI - 04 - Generated Structures v2.6 2.0 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.AbstractMessage
    - - ca.uhn.hl7v2.model.v26.message.EHC_E12

All Implemented Interfaces:

Group, Message, Structure, Serializable
```
public class EHC_E12
extends AbstractMessage
```
Represents a EHC_E12 message structure (see chapter 16.3.7). This structure contains the following elements:
- 1: MSH (Message Header)
- 2: SFT (Software Segment) optional repeating
- 3: UAC (User Authentication Credential Segment) optional repeating
- 4: RFI (Request for Information)
- 5: CTD (Contact Data) optional repeating
- 6: IVC (Invoice Segment)
- 7: PSS (Product/Service Section)
- 8: PSG (Product/Service Group)
- 9: PID (Patient Identification) optional
- 10: PSL (Product/Service Line Item) optional repeating
- 11: EHC_E12_REQUEST (a Group object) repeating
See Also:
Serialized Form

Field Summary
- Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure
  log

Constructor Summary

Constructors
Constructor and Description
`EHC_E12()` Creates a new EHC_E12 message with DefaultModelClassFactory.
`EHC_E12(ModelClassFactory factory)` Creates a new EHC_E12 message with custom ModelClassFactory.

Method Summary

Methods
Modifier and Type	Method and Description
`CTD`	`getCTD()` Returns the first repetition of CTD (Contact Data) - creates it if necessary
`CTD`	`getCTD(int rep)` Returns a specific repetition of CTD (Contact Data) - creates it if necessary
`List<CTD>`	`getCTDAll()` Returns a non-modifiable List containing all current existing repetitions of CTD.
`int`	`getCTDReps()` Returns the number of existing repetitions of CTD
`IVC`	`getIVC()` Returns IVC (Invoice Segment) - creates it if necessary
`MSH`	`getMSH()` Returns MSH (Message Header) - creates it if necessary
`PID`	`getPID()` Returns PID (Patient Identification) - creates it if necessary
`PSG`	`getPSG()` Returns PSG (Product/Service Group) - creates it if necessary
`PSL`	`getPSL()` Returns the first repetition of PSL (Product/Service Line Item) - creates it if necessary
`PSL`	`getPSL(int rep)` Returns a specific repetition of PSL (Product/Service Line Item) - creates it if necessary
`List<PSL>`	`getPSLAll()` Returns a non-modifiable List containing all current existing repetitions of PSL.
`int`	`getPSLReps()` Returns the number of existing repetitions of PSL
`PSS`	`getPSS()` Returns PSS (Product/Service Section) - creates it if necessary
`EHC_E12_REQUEST`	`getREQUEST()` Returns the first repetition of REQUEST (a Group object) - creates it if necessary
`EHC_E12_REQUEST`	`getREQUEST(int rep)` Returns a specific repetition of REQUEST (a Group object) - creates it if necessary
`List<EHC_E12_REQUEST>`	`getREQUESTAll()` Returns a non-modifiable List containing all current existing repetitions of REQUEST.
`int`	`getREQUESTReps()` Returns the number of existing repetitions of REQUEST
`RFI`	`getRFI()` Returns RFI (Request for Information) - creates it if necessary
`SFT`	`getSFT()` Returns the first repetition of SFT (Software Segment) - creates it if necessary
`SFT`	`getSFT(int rep)` Returns a specific repetition of SFT (Software Segment) - creates it if necessary
`List<SFT>`	`getSFTAll()` Returns a non-modifiable List containing all current existing repetitions of SFT.
`int`	`getSFTReps()` Returns the number of existing repetitions of SFT
`UAC`	`getUAC()` Returns the first repetition of UAC (User Authentication Credential Segment) - creates it if necessary
`UAC`	`getUAC(int rep)` Returns a specific repetition of UAC (User Authentication Credential Segment) - creates it if necessary
`List<UAC>`	`getUACAll()` Returns a non-modifiable List containing all current existing repetitions of UAC.
`int`	`getUACReps()` Returns the number of existing repetitions of UAC
`String`	`getVersion()` Returns "2.6"
`void`	`insertCTD(CTD structure, int rep)` Inserts a specific repetition of CTD (Contact Data)
`CTD`	`insertCTD(int rep)` Inserts a specific repetition of CTD (Contact Data)
`PSL`	`insertPSL(int rep)` Inserts a specific repetition of PSL (Product/Service Line Item)
`void`	`insertPSL(PSL structure, int rep)` Inserts a specific repetition of PSL (Product/Service Line Item)
`void`	`insertREQUEST(EHC_E12_REQUEST structure, int rep)` Inserts a specific repetition of REQUEST (a Group object)
`EHC_E12_REQUEST`	`insertREQUEST(int rep)` Inserts a specific repetition of REQUEST (a Group object)
`SFT`	`insertSFT(int rep)` Inserts a specific repetition of SFT (Software Segment)
`void`	`insertSFT(SFT structure, int rep)` Inserts a specific repetition of SFT (Software Segment)
`UAC`	`insertUAC(int rep)` Inserts a specific repetition of UAC (User Authentication Credential Segment)
`void`	`insertUAC(UAC structure, int rep)` Inserts a specific repetition of UAC (User Authentication Credential Segment)
`CTD`	`removeCTD(int rep)` Removes a specific repetition of CTD (Contact Data)
`PSL`	`removePSL(int rep)` Removes a specific repetition of PSL (Product/Service Line Item)
`EHC_E12_REQUEST`	`removeREQUEST(int rep)` Removes a specific repetition of REQUEST (a Group object)
`SFT`	`removeSFT(int rep)` Removes a specific repetition of SFT (Software Segment)
`UAC`	`removeUAC(int rep)` Removes a specific repetition of UAC (User Authentication Credential Segment)

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage
encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup
add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Group
addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure
getName

- Constructor Detail
  - EHC_E12
```
public EHC_E12()
```
    Creates a new EHC_E12 message with DefaultModelClassFactory.
  - EHC_E12
```
public EHC_E12(ModelClassFactory factory)
```
    Creates a new EHC_E12 message with custom ModelClassFactory.
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.6"
    
    Specified by:
    
    getVersion in interface Message
    
    Overrides:
    
    getVersion in class AbstractMessage
  - getMSH
```
public MSH getMSH()
```
    Returns MSH (Message Header) - creates it if necessary
  - getSFT
```
public SFT getSFT()
```
    Returns the first repetition of SFT (Software Segment) - creates it if necessary
  - getSFT
```
public SFT getSFT(int rep)
```
    Returns a specific repetition of SFT (Software Segment) - creates it if necessary
    
    Parameters:
    rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
    
    Throws:
    
    HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.
  - getSFTReps
```
public int getSFTReps()
```
    Returns the number of existing repetitions of SFT
  - getSFTAll
```
public List<SFT> getSFTAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of SFT.
    
    Note that unlike getSFT(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertSFT
```
public void insertSFT(SFT structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of SFT (Software Segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertSFT
```
public SFT insertSFT(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of SFT (Software Segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeSFT
```
public SFT removeSFT(int rep)
              throws HL7Exception
```
    Removes a specific repetition of SFT (Software Segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getUAC
```
public UAC getUAC()
```
    Returns the first repetition of UAC (User Authentication Credential Segment) - creates it if necessary
  - getUAC
```
public UAC getUAC(int rep)
```
    Returns a specific repetition of UAC (User Authentication Credential Segment) - creates it if necessary
    
    Parameters:
    rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
    
    Throws:
    
    HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.
  - getUACReps
```
public int getUACReps()
```
    Returns the number of existing repetitions of UAC
  - getUACAll
```
public List<UAC> getUACAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of UAC.
    
    Note that unlike getUAC(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertUAC
```
public void insertUAC(UAC structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of UAC (User Authentication Credential Segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertUAC
```
public UAC insertUAC(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of UAC (User Authentication Credential Segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeUAC
```
public UAC removeUAC(int rep)
              throws HL7Exception
```
    Removes a specific repetition of UAC (User Authentication Credential Segment)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getRFI
```
public RFI getRFI()
```
    Returns RFI (Request for Information) - creates it if necessary
  - getCTD
```
public CTD getCTD()
```
    Returns the first repetition of CTD (Contact Data) - creates it if necessary
  - getCTD
```
public CTD getCTD(int rep)
```
    Returns a specific repetition of CTD (Contact Data) - creates it if necessary
    
    Parameters:
    rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
    
    Throws:
    
    HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.
  - getCTDReps
```
public int getCTDReps()
```
    Returns the number of existing repetitions of CTD
  - getCTDAll
```
public List<CTD> getCTDAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of CTD.
    
    Note that unlike getCTD(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertCTD
```
public void insertCTD(CTD structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of CTD (Contact Data)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertCTD
```
public CTD insertCTD(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of CTD (Contact Data)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeCTD
```
public CTD removeCTD(int rep)
              throws HL7Exception
```
    Removes a specific repetition of CTD (Contact Data)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getIVC
```
public IVC getIVC()
```
    Returns IVC (Invoice Segment) - creates it if necessary
  - getPSS
```
public PSS getPSS()
```
    Returns PSS (Product/Service Section) - creates it if necessary
  - getPSG
```
public PSG getPSG()
```
    Returns PSG (Product/Service Group) - creates it if necessary
  - getPID
```
public PID getPID()
```
    Returns PID (Patient Identification) - creates it if necessary
  - getPSL
```
public PSL getPSL()
```
    Returns the first repetition of PSL (Product/Service Line Item) - creates it if necessary
  - getPSL
```
public PSL getPSL(int rep)
```
    Returns a specific repetition of PSL (Product/Service Line Item) - creates it if necessary
    
    Parameters:
    rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
    
    Throws:
    
    HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.
  - getPSLReps
```
public int getPSLReps()
```
    Returns the number of existing repetitions of PSL
  - getPSLAll
```
public List<PSL> getPSLAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PSL.
    
    Note that unlike getPSL(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPSL
```
public void insertPSL(PSL structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of PSL (Product/Service Line Item)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertPSL
```
public PSL insertPSL(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of PSL (Product/Service Line Item)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removePSL
```
public PSL removePSL(int rep)
              throws HL7Exception
```
    Removes a specific repetition of PSL (Product/Service Line Item)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getREQUEST
```
public EHC_E12_REQUEST getREQUEST()
```
    Returns the first repetition of REQUEST (a Group object) - creates it if necessary
  - getREQUEST
```
public EHC_E12_REQUEST getREQUEST(int rep)
```
    Returns a specific repetition of REQUEST (a Group object) - creates it if necessary
    
    Parameters:
    rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)
    
    Throws:
    
    HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.
  - getREQUESTReps
```
public int getREQUESTReps()
```
    Returns the number of existing repetitions of REQUEST
  - getREQUESTAll
```
public List<EHC_E12_REQUEST> getREQUESTAll()
                                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of REQUEST.
    
    Note that unlike getREQUEST(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertREQUEST
```
public void insertREQUEST(EHC_E12_REQUEST structure,
                 int rep)
                   throws HL7Exception
```
    Inserts a specific repetition of REQUEST (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertREQUEST
```
public EHC_E12_REQUEST insertREQUEST(int rep)
                              throws HL7Exception
```
    Inserts a specific repetition of REQUEST (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeREQUEST
```
public EHC_E12_REQUEST removeREQUEST(int rep)
                              throws HL7Exception
```
    Removes a specific repetition of REQUEST (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)

Class EHC_E12

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.hl7v2.model.Group

Methods inherited from interface ca.uhn.hl7v2.model.Structure

Constructor Detail

EHC_E12

EHC_E12

Method Detail

getVersion

getMSH

getSFT

getSFT

getSFTReps

getSFTAll

insertSFT

insertSFT

removeSFT

getUAC

getUAC

getUACReps

getUACAll

insertUAC

insertUAC

removeUAC

getRFI

getCTD

getCTD

getCTDReps

getCTDAll

insertCTD

insertCTD

removeCTD

getIVC

getPSS

getPSG

getPID

getPSL

getPSL

getPSLReps

getPSLAll

insertPSL

insertPSL

removePSL

getREQUEST

getREQUEST

getREQUESTReps

getREQUESTAll

insertREQUEST

insertREQUEST

removeREQUEST