ca.uhn.hl7v2.model.v26.message

Class EHC_E01

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_E01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class EHC_E01
extends AbstractMessage

Represents a EHC_E01 message structure (see chapter 16.3.1). 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: PYE (Payee Information) optional
• 6: CTD (Contact Data) optional repeating
• 7: AUT (Authorization Information) optional
• 8: LOC (Location Identification) optional repeating
• 9: ROL (Role) optional repeating
• 10: EHC_E01_PRODUCT_SERVICE_SECTION (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_E01() Creates a new EHC_E01 message with DefaultModelClassFactory.
EHC_E01(ModelClassFactory factory) Creates a new EHC_E01 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
AUT	getAUT() Returns AUT (Authorization Information) - creates it if necessary
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_E01_PRODUCT_SERVICE_SECTION	getPRODUCT_SERVICE_SECTION() Returns the first repetition of PRODUCT_SERVICE_SECTION (a Group object) - creates it if necessary
EHC_E01_PRODUCT_SERVICE_SECTION	getPRODUCT_SERVICE_SECTION(int rep) Returns a specific repetition of PRODUCT_SERVICE_SECTION (a Group object) - creates it if necessary
List<EHC_E01_PRODUCT_SERVICE_SECTION>	getPRODUCT_SERVICE_SECTIONAll() Returns a non-modifiable List containing all current existing repetitions of PRODUCT_SERVICE_SECTION.
int	getPRODUCT_SERVICE_SECTIONReps() Returns the number of existing repetitions of PRODUCT_SERVICE_SECTION
PYE	getPYE() Returns PYE (Payee Information) - creates it if necessary
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	insertPRODUCT_SERVICE_SECTION(EHC_E01_PRODUCT_SERVICE_SECTION structure, int rep) Inserts a specific repetition of PRODUCT_SERVICE_SECTION (a Group object)
EHC_E01_PRODUCT_SERVICE_SECTION	insertPRODUCT_SERVICE_SECTION(int rep) Inserts a specific repetition of PRODUCT_SERVICE_SECTION (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_E01_PRODUCT_SERVICE_SECTION	removePRODUCT_SERVICE_SECTION(int rep) Removes a specific repetition of PRODUCT_SERVICE_SECTION (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_E01

public EHC_E01()

Creates a new EHC_E01 message with DefaultModelClassFactory.

EHC_E01

public EHC_E01(ModelClassFactory factory)

Creates a new EHC_E01 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

getPYE

public PYE getPYE()

Returns PYE (Payee 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)

getAUT

public AUT getAUT()

Returns AUT (Authorization Information) - creates it if necessary

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)

getPRODUCT_SERVICE_SECTION

public EHC_E01_PRODUCT_SERVICE_SECTION getPRODUCT_SERVICE_SECTION()

Returns the first repetition of PRODUCT_SERVICE_SECTION (a Group object) - creates it if necessary

getPRODUCT_SERVICE_SECTION

public EHC_E01_PRODUCT_SERVICE_SECTION getPRODUCT_SERVICE_SECTION(int rep)

Returns a specific repetition of PRODUCT_SERVICE_SECTION (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.

getPRODUCT_SERVICE_SECTIONReps

public int getPRODUCT_SERVICE_SECTIONReps()

Returns the number of existing repetitions of PRODUCT_SERVICE_SECTION

getPRODUCT_SERVICE_SECTIONAll

public List<EHC_E01_PRODUCT_SERVICE_SECTION> getPRODUCT_SERVICE_SECTIONAll()
                                                                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of PRODUCT_SERVICE_SECTION.

Note that unlike getPRODUCT_SERVICE_SECTION(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertPRODUCT_SERVICE_SECTION

public void insertPRODUCT_SERVICE_SECTION(EHC_E01_PRODUCT_SERVICE_SECTION structure,
                                 int rep)
                                   throws HL7Exception

Inserts a specific repetition of PRODUCT_SERVICE_SECTION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRODUCT_SERVICE_SECTION

public EHC_E01_PRODUCT_SERVICE_SECTION insertPRODUCT_SERVICE_SECTION(int rep)
                                                              throws HL7Exception

Inserts a specific repetition of PRODUCT_SERVICE_SECTION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRODUCT_SERVICE_SECTION

public EHC_E01_PRODUCT_SERVICE_SECTION removePRODUCT_SERVICE_SECTION(int rep)
                                                              throws HL7Exception

Removes a specific repetition of PRODUCT_SERVICE_SECTION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)