EHC_E20 (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_E20

All Implemented Interfaces:

Group, Message, Structure, Serializable
```
public class EHC_E20
extends AbstractMessage
```
Represents a EHC_E20 message structure (see chapter 16.3.10). 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: IVC (Invoice Segment)
- 5: CTD (Contact Data) repeating
- 6: LOC (Location Identification) optional repeating
- 7: ROL (Role) optional repeating
- 8: EHC_E20_PAT_INFO (a Group object) repeating
- 9: EHC_E20_PSL_ITEM_INFO (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_E20()` Creates a new EHC_E20 message with DefaultModelClassFactory.
`EHC_E20(ModelClassFactory factory)` Creates a new EHC_E20 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
`LOC`	`getLOC()` Returns the first repetition of LOC (Location Identification) - creates it if necessary
`LOC`	`getLOC(int rep)` Returns a specific repetition of LOC (Location Identification) - creates it if necessary
`List<LOC>`	`getLOCAll()` Returns a non-modifiable List containing all current existing repetitions of LOC.
`int`	`getLOCReps()` Returns the number of existing repetitions of LOC
`MSH`	`getMSH()` Returns MSH (Message Header) - creates it if necessary
`EHC_E20_PAT_INFO`	`getPAT_INFO()` Returns the first repetition of PAT_INFO (a Group object) - creates it if necessary
`EHC_E20_PAT_INFO`	`getPAT_INFO(int rep)` Returns a specific repetition of PAT_INFO (a Group object) - creates it if necessary
`List<EHC_E20_PAT_INFO>`	`getPAT_INFOAll()` Returns a non-modifiable List containing all current existing repetitions of PAT_INFO.
`int`	`getPAT_INFOReps()` Returns the number of existing repetitions of PAT_INFO
`EHC_E20_PSL_ITEM_INFO`	`getPSL_ITEM_INFO()` Returns the first repetition of PSL_ITEM_INFO (a Group object) - creates it if necessary
`EHC_E20_PSL_ITEM_INFO`	`getPSL_ITEM_INFO(int rep)` Returns a specific repetition of PSL_ITEM_INFO (a Group object) - creates it if necessary
`List<EHC_E20_PSL_ITEM_INFO>`	`getPSL_ITEM_INFOAll()` Returns a non-modifiable List containing all current existing repetitions of PSL_ITEM_INFO.
`int`	`getPSL_ITEM_INFOReps()` Returns the number of existing repetitions of PSL_ITEM_INFO
`ROL`	`getROL()` Returns the first repetition of ROL (Role) - creates it if necessary
`ROL`	`getROL(int rep)` Returns a specific repetition of ROL (Role) - creates it if necessary
`List<ROL>`	`getROLAll()` Returns a non-modifiable List containing all current existing repetitions of ROL.
`int`	`getROLReps()` Returns the number of existing repetitions of ROL
`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)
`LOC`	`insertLOC(int rep)` Inserts a specific repetition of LOC (Location Identification)
`void`	`insertLOC(LOC structure, int rep)` Inserts a specific repetition of LOC (Location Identification)
`void`	`insertPAT_INFO(EHC_E20_PAT_INFO structure, int rep)` Inserts a specific repetition of PAT_INFO (a Group object)
`EHC_E20_PAT_INFO`	`insertPAT_INFO(int rep)` Inserts a specific repetition of PAT_INFO (a Group object)
`void`	`insertPSL_ITEM_INFO(EHC_E20_PSL_ITEM_INFO structure, int rep)` Inserts a specific repetition of PSL_ITEM_INFO (a Group object)
`EHC_E20_PSL_ITEM_INFO`	`insertPSL_ITEM_INFO(int rep)` Inserts a specific repetition of PSL_ITEM_INFO (a Group object)
`ROL`	`insertROL(int rep)` Inserts a specific repetition of ROL (Role)
`void`	`insertROL(ROL structure, int rep)` Inserts a specific repetition of ROL (Role)
`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)
`LOC`	`removeLOC(int rep)` Removes a specific repetition of LOC (Location Identification)
`EHC_E20_PAT_INFO`	`removePAT_INFO(int rep)` Removes a specific repetition of PAT_INFO (a Group object)
`EHC_E20_PSL_ITEM_INFO`	`removePSL_ITEM_INFO(int rep)` Removes a specific repetition of PSL_ITEM_INFO (a Group object)
`ROL`	`removeROL(int rep)` Removes a specific repetition of ROL (Role)
`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_E20
```
public EHC_E20()
```
    Creates a new EHC_E20 message with DefaultModelClassFactory.
  - EHC_E20
```
public EHC_E20(ModelClassFactory factory)
```
    Creates a new EHC_E20 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)
  - getIVC
```
public IVC getIVC()
```
    Returns IVC (Invoice Segment) - 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)
  - getLOC
```
public LOC getLOC()
```
    Returns the first repetition of LOC (Location Identification) - creates it if necessary
  - getLOC
```
public LOC getLOC(int rep)
```
    Returns a specific repetition of LOC (Location Identification) - 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.
  - getLOCReps
```
public int getLOCReps()
```
    Returns the number of existing repetitions of LOC
  - getLOCAll
```
public List<LOC> getLOCAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of LOC.
    
    Note that unlike getLOC(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertLOC
```
public void insertLOC(LOC structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of LOC (Location Identification)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertLOC
```
public LOC insertLOC(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of LOC (Location Identification)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeLOC
```
public LOC removeLOC(int rep)
              throws HL7Exception
```
    Removes a specific repetition of LOC (Location Identification)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getROL
```
public ROL getROL()
```
    Returns the first repetition of ROL (Role) - creates it if necessary
  - getROL
```
public ROL getROL(int rep)
```
    Returns a specific repetition of ROL (Role) - 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.
  - getROLReps
```
public int getROLReps()
```
    Returns the number of existing repetitions of ROL
  - getROLAll
```
public List<ROL> getROLAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ROL.
    
    Note that unlike getROL(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertROL
```
public void insertROL(ROL structure,
             int rep)
               throws HL7Exception
```
    Inserts a specific repetition of ROL (Role)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertROL
```
public ROL insertROL(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of ROL (Role)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removeROL
```
public ROL removeROL(int rep)
              throws HL7Exception
```
    Removes a specific repetition of ROL (Role)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getPAT_INFO
```
public EHC_E20_PAT_INFO getPAT_INFO()
```
    Returns the first repetition of PAT_INFO (a Group object) - creates it if necessary
  - getPAT_INFO
```
public EHC_E20_PAT_INFO getPAT_INFO(int rep)
```
    Returns a specific repetition of PAT_INFO (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.
  - getPAT_INFOReps
```
public int getPAT_INFOReps()
```
    Returns the number of existing repetitions of PAT_INFO
  - getPAT_INFOAll
```
public List<EHC_E20_PAT_INFO> getPAT_INFOAll()
                                      throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PAT_INFO.
    
    Note that unlike getPAT_INFO(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPAT_INFO
```
public void insertPAT_INFO(EHC_E20_PAT_INFO structure,
                  int rep)
                    throws HL7Exception
```
    Inserts a specific repetition of PAT_INFO (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertPAT_INFO
```
public EHC_E20_PAT_INFO insertPAT_INFO(int rep)
                                throws HL7Exception
```
    Inserts a specific repetition of PAT_INFO (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removePAT_INFO
```
public EHC_E20_PAT_INFO removePAT_INFO(int rep)
                                throws HL7Exception
```
    Removes a specific repetition of PAT_INFO (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)
  - getPSL_ITEM_INFO
```
public EHC_E20_PSL_ITEM_INFO getPSL_ITEM_INFO()
```
    Returns the first repetition of PSL_ITEM_INFO (a Group object) - creates it if necessary
  - getPSL_ITEM_INFO
```
public EHC_E20_PSL_ITEM_INFO getPSL_ITEM_INFO(int rep)
```
    Returns a specific repetition of PSL_ITEM_INFO (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.
  - getPSL_ITEM_INFOReps
```
public int getPSL_ITEM_INFOReps()
```
    Returns the number of existing repetitions of PSL_ITEM_INFO
  - getPSL_ITEM_INFOAll
```
public List<EHC_E20_PSL_ITEM_INFO> getPSL_ITEM_INFOAll()
                                                throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PSL_ITEM_INFO.
    
    Note that unlike getPSL_ITEM_INFO(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPSL_ITEM_INFO
```
public void insertPSL_ITEM_INFO(EHC_E20_PSL_ITEM_INFO structure,
                       int rep)
                         throws HL7Exception
```
    Inserts a specific repetition of PSL_ITEM_INFO (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - insertPSL_ITEM_INFO
```
public EHC_E20_PSL_ITEM_INFO insertPSL_ITEM_INFO(int rep)
                                          throws HL7Exception
```
    Inserts a specific repetition of PSL_ITEM_INFO (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#insertRepetition(Structure, int)
  - removePSL_ITEM_INFO
```
public EHC_E20_PSL_ITEM_INFO removePSL_ITEM_INFO(int rep)
                                          throws HL7Exception
```
    Removes a specific repetition of PSL_ITEM_INFO (a Group object)
    
    Throws:
    
    HL7Exception
    See Also:
    AbstractGroup#removeRepetition(String, int)

Class EHC_E20

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_E20

EHC_E20

Method Detail

getVersion

getMSH

getSFT

getSFT

getSFTReps

getSFTAll

insertSFT

insertSFT

removeSFT

getUAC

getUAC

getUACReps

getUACAll

insertUAC

insertUAC

removeUAC

getIVC

getCTD

getCTD

getCTDReps

getCTDAll

insertCTD

insertCTD

removeCTD

getLOC

getLOC

getLOCReps

getLOCAll

insertLOC

insertLOC

removeLOC

getROL

getROL

getROLReps

getROLAll

insertROL

insertROL

removeROL

getPAT_INFO

getPAT_INFO

getPAT_INFOReps

getPAT_INFOAll

insertPAT_INFO

insertPAT_INFO

removePAT_INFO

getPSL_ITEM_INFO

getPSL_ITEM_INFO

getPSL_ITEM_INFOReps

getPSL_ITEM_INFOAll

insertPSL_ITEM_INFO

insertPSL_ITEM_INFO

removePSL_ITEM_INFO