ca.uhn.hl7v2.model.v26.message

Class EHC_E04

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_E04

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class EHC_E04
extends AbstractMessage

Represents a EHC_E04 message structure (see chapter 16.3.5). 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: NTE (Notes and Comments) optional repeating
• 6: EHC_E04_PRODUCT_SERVICE_SECTION (a Group object) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
EHC_E04() Creates a new EHC_E04 message with DefaultModelClassFactory.
EHC_E04(ModelClassFactory factory) Creates a new EHC_E04 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
IVC	getIVC() Returns IVC (Invoice Segment) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
EHC_E04_PRODUCT_SERVICE_SECTION	getPRODUCT_SERVICE_SECTION() Returns the first repetition of PRODUCT_SERVICE_SECTION (a Group object) - creates it if necessary
EHC_E04_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_E04_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
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"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertPRODUCT_SERVICE_SECTION(EHC_E04_PRODUCT_SERVICE_SECTION structure, int rep) Inserts a specific repetition of PRODUCT_SERVICE_SECTION (a Group object)
EHC_E04_PRODUCT_SERVICE_SECTION	insertPRODUCT_SERVICE_SECTION(int rep) Inserts a specific repetition of PRODUCT_SERVICE_SECTION (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)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
EHC_E04_PRODUCT_SERVICE_SECTION	removePRODUCT_SERVICE_SECTION(int rep) Removes a specific repetition of PRODUCT_SERVICE_SECTION (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_E04

public EHC_E04()

Creates a new EHC_E04 message with DefaultModelClassFactory.

EHC_E04

public EHC_E04(ModelClassFactory factory)

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

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getPRODUCT_SERVICE_SECTION

public EHC_E04_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_E04_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_E04_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_E04_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_E04_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_E04_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)