Package ca.uhn.hl7v2.model.v251.message

Class VXU_V04

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v251.message.VXU_V04

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class VXU_V04
extends AbstractMessage

Represents a VXU_V04 message structure (see chapter 4.17.6). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: PID (Patient Identification)
• 4: PD1 (Patient Additional Demographic) optional
• 5: NK1 (Next of Kin / Associated Parties) optional repeating
• 6: VXU_V04_PATIENT (a Group object) optional
• 7: GT1 (Guarantor) optional repeating
• 8: VXU_V04_INSURANCE (a Group object) optional repeating
• 9: VXU_V04_ORDER (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	Description
VXU_V04()	Creates a new VXU_V04 message with DefaultModelClassFactory.
VXU_V04(ModelClassFactory factory)	Creates a new VXU_V04 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
GT1	getGT1()	Returns the first repetition of GT1 (Guarantor) - creates it if necessary
GT1	getGT1(int rep)	Returns a specific repetition of GT1 (Guarantor) - creates it if necessary
List<GT1>	getGT1All()	Returns a non-modifiable List containing all current existing repetitions of GT1.
int	getGT1Reps()	Returns the number of existing repetitions of GT1
VXU_V04_INSURANCE	getINSURANCE()	Returns the first repetition of INSURANCE (a Group object) - creates it if necessary
VXU_V04_INSURANCE	getINSURANCE(int rep)	Returns a specific repetition of INSURANCE (a Group object) - creates it if necessary
List<VXU_V04_INSURANCE>	getINSURANCEAll()	Returns a non-modifiable List containing all current existing repetitions of INSURANCE.
int	getINSURANCEReps()	Returns the number of existing repetitions of INSURANCE
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
NK1	getNK1()	Returns the first repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
NK1	getNK1(int rep)	Returns a specific repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary
List<NK1>	getNK1All()	Returns a non-modifiable List containing all current existing repetitions of NK1.
int	getNK1Reps()	Returns the number of existing repetitions of NK1
VXU_V04_ORDER	getORDER()	Returns the first repetition of ORDER (a Group object) - creates it if necessary
VXU_V04_ORDER	getORDER(int rep)	Returns a specific repetition of ORDER (a Group object) - creates it if necessary
List<VXU_V04_ORDER>	getORDERAll()	Returns a non-modifiable List containing all current existing repetitions of ORDER.
int	getORDERReps()	Returns the number of existing repetitions of ORDER
VXU_V04_PATIENT	getPATIENT()	Returns PATIENT (a Group object) - creates it if necessary
PD1	getPD1()	Returns PD1 (Patient Additional Demographic) - creates it if necessary
PID	getPID()	Returns PID (Patient Identification) - 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
String	getVersion()	Returns "2.5.1"
GT1	insertGT1(int rep)	Inserts a specific repetition of GT1 (Guarantor)
void	insertGT1(GT1 structure, int rep)	Inserts a specific repetition of GT1 (Guarantor)
VXU_V04_INSURANCE	insertINSURANCE(int rep)	Inserts a specific repetition of INSURANCE (a Group object)
void	insertINSURANCE(VXU_V04_INSURANCE structure, int rep)	Inserts a specific repetition of INSURANCE (a Group object)
NK1	insertNK1(int rep)	Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
void	insertNK1(NK1 structure, int rep)	Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)
VXU_V04_ORDER	insertORDER(int rep)	Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(VXU_V04_ORDER structure, int rep)	Inserts a specific repetition of ORDER (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)
GT1	removeGT1(int rep)	Removes a specific repetition of GT1 (Guarantor)
VXU_V04_INSURANCE	removeINSURANCE(int rep)	Removes a specific repetition of INSURANCE (a Group object)
NK1	removeNK1(int rep)	Removes a specific repetition of NK1 (Next of Kin / Associated Parties)
VXU_V04_ORDER	removeORDER(int rep)	Removes a specific repetition of ORDER (a Group object)
SFT	removeSFT(int rep)	Removes a specific repetition of SFT (Software Segment)

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

accept, copy, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, toString

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

add, add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insert, insertRepetition, insertRepetition, isChoiceElement, isEmpty, isGroup, isRepeating, isRequired, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

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, isChoiceElement, isGroup, isRepeating, isRequired

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

getName

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

isEmpty, provideLocation

Constructor Details

VXU_V04

public VXU_V04()

Creates a new VXU_V04 message with DefaultModelClassFactory.

VXU_V04

public VXU_V04(ModelClassFactory factory)

Creates a new VXU_V04 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

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)

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getPD1

public PD1 getPD1()

Returns PD1 (Patient Additional Demographic) - creates it if necessary

getNK1

public NK1 getNK1()

Returns the first repetition of NK1 (Next of Kin / Associated Parties) - creates it if necessary

getNK1

public NK1 getNK1(int rep)

Returns a specific repetition of NK1 (Next of Kin / Associated Parties) - 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.

getNK1Reps

public int getNK1Reps()

Returns the number of existing repetitions of NK1

getNK1All

public List<NK1> getNK1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNK1

public void insertNK1(NK1 structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertNK1

public NK1 insertNK1(int rep)
              throws HL7Exception

Inserts a specific repetition of NK1 (Next of Kin / Associated Parties)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeNK1

public NK1 removeNK1(int rep)
              throws HL7Exception

Removes a specific repetition of NK1 (Next of Kin / Associated Parties)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPATIENT

public VXU_V04_PATIENT getPATIENT()

Returns PATIENT (a Group object) - creates it if necessary

getGT1

public GT1 getGT1()

Returns the first repetition of GT1 (Guarantor) - creates it if necessary

getGT1

public GT1 getGT1(int rep)

Returns a specific repetition of GT1 (Guarantor) - 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.

getGT1Reps

public int getGT1Reps()

Returns the number of existing repetitions of GT1

getGT1All

public List<GT1> getGT1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertGT1

public void insertGT1(GT1 structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of GT1 (Guarantor)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertGT1

public GT1 insertGT1(int rep)
              throws HL7Exception

Inserts a specific repetition of GT1 (Guarantor)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeGT1

public GT1 removeGT1(int rep)
              throws HL7Exception

Removes a specific repetition of GT1 (Guarantor)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getINSURANCE

public VXU_V04_INSURANCE getINSURANCE()

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

getINSURANCE

public VXU_V04_INSURANCE getINSURANCE(int rep)

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

getINSURANCEReps

public int getINSURANCEReps()

Returns the number of existing repetitions of INSURANCE

getINSURANCEAll

public List<VXU_V04_INSURANCE> getINSURANCEAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertINSURANCE

public void insertINSURANCE(VXU_V04_INSURANCE structure,
 int rep)
                     throws HL7Exception

Inserts a specific repetition of INSURANCE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertINSURANCE

public VXU_V04_INSURANCE insertINSURANCE(int rep)
                                  throws HL7Exception

Inserts a specific repetition of INSURANCE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeINSURANCE

public VXU_V04_INSURANCE removeINSURANCE(int rep)
                                  throws HL7Exception

Removes a specific repetition of INSURANCE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getORDER

public VXU_V04_ORDER getORDER()

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

getORDER

public VXU_V04_ORDER getORDER(int rep)

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

getORDERReps

public int getORDERReps()

Returns the number of existing repetitions of ORDER

getORDERAll

public List<VXU_V04_ORDER> getORDERAll()
                                throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER

public void insertORDER(VXU_V04_ORDER structure,
 int rep)
                 throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertORDER

public VXU_V04_ORDER insertORDER(int rep)
                          throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeORDER

public VXU_V04_ORDER removeORDER(int rep)
                          throws HL7Exception

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)