ca.uhn.hl7v2.model.v231.message

Class VXR_V03

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.VXR_V03

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class VXR_V03
extends AbstractMessage

Represents a VXR_V03 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: PID (PID - patient identification segment)
• 6: PD1 (PD1 - patient additional demographic segment) optional
• 7: NK1 (NK1 - next of kin / associated parties segment-) optional repeating
• 8: VXR_V03_PV1PV2 (a Group object) optional
• 9: VXR_V03_IN1IN2IN3 (a Group object) optional repeating
• 10: VXR_V03_ORCRXARXROBXNTE (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
VXR_V03() Creates a new VXR_V03 message with DefaultModelClassFactory.
VXR_V03(ModelClassFactory factory) Creates a new VXR_V03 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
VXR_V03_IN1IN2IN3	getIN1IN2IN3() Returns the first repetition of IN1IN2IN3 (a Group object) - creates it if necessary
VXR_V03_IN1IN2IN3	getIN1IN2IN3(int rep) Returns a specific repetition of IN1IN2IN3 (a Group object) - creates it if necessary
List<VXR_V03_IN1IN2IN3>	getIN1IN2IN3All() Returns a non-modifiable List containing all current existing repetitions of IN1IN2IN3.
int	getIN1IN2IN3Reps() Returns the number of existing repetitions of IN1IN2IN3
MSA	getMSA() Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
NK1	getNK1() Returns the first repetition of NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary
NK1	getNK1(int rep) Returns a specific repetition of NK1 (NK1 - next of kin / associated parties segment-) - 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
VXR_V03_ORCRXARXROBXNTE	getORCRXARXROBXNTE() Returns the first repetition of ORCRXARXROBXNTE (a Group object) - creates it if necessary
VXR_V03_ORCRXARXROBXNTE	getORCRXARXROBXNTE(int rep) Returns a specific repetition of ORCRXARXROBXNTE (a Group object) - creates it if necessary
List<VXR_V03_ORCRXARXROBXNTE>	getORCRXARXROBXNTEAll() Returns a non-modifiable List containing all current existing repetitions of ORCRXARXROBXNTE.
int	getORCRXARXROBXNTEReps() Returns the number of existing repetitions of ORCRXARXROBXNTE
PD1	getPD1() Returns PD1 (PD1 - patient additional demographic segment) - creates it if necessary
PID	getPID() Returns PID (PID - patient identification segment) - creates it if necessary
VXR_V03_PV1PV2	getPV1PV2() Returns PV1PV2 (a Group object) - creates it if necessary
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"
VXR_V03_IN1IN2IN3	insertIN1IN2IN3(int rep) Inserts a specific repetition of IN1IN2IN3 (a Group object)
void	insertIN1IN2IN3(VXR_V03_IN1IN2IN3 structure, int rep) Inserts a specific repetition of IN1IN2IN3 (a Group object)
NK1	insertNK1(int rep) Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
void	insertNK1(NK1 structure, int rep) Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
VXR_V03_ORCRXARXROBXNTE	insertORCRXARXROBXNTE(int rep) Inserts a specific repetition of ORCRXARXROBXNTE (a Group object)
void	insertORCRXARXROBXNTE(VXR_V03_ORCRXARXROBXNTE structure, int rep) Inserts a specific repetition of ORCRXARXROBXNTE (a Group object)
VXR_V03_IN1IN2IN3	removeIN1IN2IN3(int rep) Removes a specific repetition of IN1IN2IN3 (a Group object)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)
VXR_V03_ORCRXARXROBXNTE	removeORCRXARXROBXNTE(int rep) Removes a specific repetition of ORCRXARXROBXNTE (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

VXR_V03

public VXR_V03()

Creates a new VXR_V03 message with DefaultModelClassFactory.

VXR_V03

public VXR_V03(ModelClassFactory factory)

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

getPID

public PID getPID()

Returns PID (PID - patient identification segment) - creates it if necessary

getPD1

public PD1 getPD1()

Returns PD1 (PD1 - patient additional demographic segment) - creates it if necessary

getNK1

public NK1 getNK1()

Returns the first repetition of NK1 (NK1 - next of kin / associated parties segment-) - creates it if necessary

getNK1

public NK1 getNK1(int rep)

Returns a specific repetition of NK1 (NK1 - next of kin / associated parties 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.

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 (NK1 - next of kin / associated parties segment-)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNK1

public NK1 insertNK1(int rep)
              throws HL7Exception

Inserts a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNK1

public NK1 removeNK1(int rep)
              throws HL7Exception

Removes a specific repetition of NK1 (NK1 - next of kin / associated parties segment-)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getPV1PV2

public VXR_V03_PV1PV2 getPV1PV2()

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

getIN1IN2IN3

public VXR_V03_IN1IN2IN3 getIN1IN2IN3()

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

getIN1IN2IN3

public VXR_V03_IN1IN2IN3 getIN1IN2IN3(int rep)

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

getIN1IN2IN3Reps

public int getIN1IN2IN3Reps()

Returns the number of existing repetitions of IN1IN2IN3

getIN1IN2IN3All

public List<VXR_V03_IN1IN2IN3> getIN1IN2IN3All()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertIN1IN2IN3

public void insertIN1IN2IN3(VXR_V03_IN1IN2IN3 structure,
                   int rep)
                     throws HL7Exception

Inserts a specific repetition of IN1IN2IN3 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertIN1IN2IN3

public VXR_V03_IN1IN2IN3 insertIN1IN2IN3(int rep)
                                  throws HL7Exception

Inserts a specific repetition of IN1IN2IN3 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeIN1IN2IN3

public VXR_V03_IN1IN2IN3 removeIN1IN2IN3(int rep)
                                  throws HL7Exception

Removes a specific repetition of IN1IN2IN3 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getORCRXARXROBXNTE

public VXR_V03_ORCRXARXROBXNTE getORCRXARXROBXNTE()

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

getORCRXARXROBXNTE

public VXR_V03_ORCRXARXROBXNTE getORCRXARXROBXNTE(int rep)

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

getORCRXARXROBXNTEReps

public int getORCRXARXROBXNTEReps()

Returns the number of existing repetitions of ORCRXARXROBXNTE

getORCRXARXROBXNTEAll

public List<VXR_V03_ORCRXARXROBXNTE> getORCRXARXROBXNTEAll()
                                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertORCRXARXROBXNTE

public void insertORCRXARXROBXNTE(VXR_V03_ORCRXARXROBXNTE structure,
                         int rep)
                           throws HL7Exception

Inserts a specific repetition of ORCRXARXROBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORCRXARXROBXNTE

public VXR_V03_ORCRXARXROBXNTE insertORCRXARXROBXNTE(int rep)
                                              throws HL7Exception

Inserts a specific repetition of ORCRXARXROBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORCRXARXROBXNTE

public VXR_V03_ORCRXARXROBXNTE removeORCRXARXROBXNTE(int rep)
                                              throws HL7Exception

Removes a specific repetition of ORCRXARXROBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)