ca.uhn.hl7v2.model.v231.message

Class VXX_V02

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.VXX_V02

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class VXX_V02
extends AbstractMessage

Represents a VXX_V02 message structure (see chapter ?). This structure contains the following elements:

• 1: MSH (MSH - message header segment)
• 2: MSA (MSA - message acknowledgment segment)
• 3: QRD (QRD - original-style query definition segment)
• 4: QRF (QRF - original style query filter segment) optional
• 5: VXX_V02_PIDNK1 (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
VXX_V02() Creates a new VXX_V02 message with DefaultModelClassFactory.
VXX_V02(ModelClassFactory factory) Creates a new VXX_V02 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
MSA	getMSA() Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
VXX_V02_PIDNK1	getPIDNK1() Returns the first repetition of PIDNK1 (a Group object) - creates it if necessary
VXX_V02_PIDNK1	getPIDNK1(int rep) Returns a specific repetition of PIDNK1 (a Group object) - creates it if necessary
List<VXX_V02_PIDNK1>	getPIDNK1All() Returns a non-modifiable List containing all current existing repetitions of PIDNK1.
int	getPIDNK1Reps() Returns the number of existing repetitions of PIDNK1
QRD	getQRD() Returns QRD (QRD - original-style query definition segment) - creates it if necessary
QRF	getQRF() Returns QRF (QRF - original style query filter segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
VXX_V02_PIDNK1	insertPIDNK1(int rep) Inserts a specific repetition of PIDNK1 (a Group object)
void	insertPIDNK1(VXX_V02_PIDNK1 structure, int rep) Inserts a specific repetition of PIDNK1 (a Group object)
VXX_V02_PIDNK1	removePIDNK1(int rep) Removes a specific repetition of PIDNK1 (a Group object)

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

VXX_V02

public VXX_V02()

Creates a new VXX_V02 message with DefaultModelClassFactory.

VXX_V02

public VXX_V02(ModelClassFactory factory)

Creates a new VXX_V02 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (MSH - message header segment) - creates it if necessary

getMSA

public MSA getMSA()

Returns MSA (MSA - message acknowledgment segment) - creates it if necessary

getQRD

public QRD getQRD()

Returns QRD (QRD - original-style query definition segment) - creates it if necessary

getQRF

public QRF getQRF()

Returns QRF (QRF - original style query filter segment) - creates it if necessary

getPIDNK1

public VXX_V02_PIDNK1 getPIDNK1()

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

getPIDNK1

public VXX_V02_PIDNK1 getPIDNK1(int rep)

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

getPIDNK1Reps

public int getPIDNK1Reps()

Returns the number of existing repetitions of PIDNK1

getPIDNK1All

public List<VXX_V02_PIDNK1> getPIDNK1All()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertPIDNK1

public void insertPIDNK1(VXX_V02_PIDNK1 structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of PIDNK1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPIDNK1

public VXX_V02_PIDNK1 insertPIDNK1(int rep)
                            throws HL7Exception

Inserts a specific repetition of PIDNK1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePIDNK1

public VXX_V02_PIDNK1 removePIDNK1(int rep)
                            throws HL7Exception

Removes a specific repetition of PIDNK1 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)