ca.uhn.hl7v2.model.v231.message
Class RGV_O01

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.AbstractMessage
          ca.uhn.hl7v2.model.v231.message.RGV_O01

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RGV_O01
extends AbstractMessage

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

• 1: MSH (MSH - message header segment)
• 2: NTE (NTE - notes and comments segment) optional repeating
• 3: RGV_O01_PIDNTEAL1PV1PV2 (a Group object) optional
• 4: RGV_O01_ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE (a Group object) repeating

See Also:

Serialized Form

Constructor Summary

RGV_O01()
Creates a new RGV_O01 message with DefaultModelClassFactory.

RGV_O01(ModelClassFactory factory)
Creates a new RGV_O01 message with custom ModelClassFactory.

Method Summary

MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - creates it if necessary
int	getNTEReps() Returns the number of existing repetitions of NTE
RGV_O01_ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE	getORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE() Returns the first repetition of ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE (a Group object) - creates it if necessary
RGV_O01_ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE	getORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE(int rep) Returns a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE (a Group object) - creates it if necessary
int	getORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTEReps() Returns the number of existing repetitions of ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE
RGV_O01_PIDNTEAL1PV1PV2	getPIDNTEAL1PV1PV2() Returns PIDNTEAL1PV1PV2 (a Group object) - creates it if necessary
String	getVersion() Returns "2.3.1"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
RGV_O01_ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE	insertORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE(int rep) Inserts a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE (a Group object)
void	insertORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE(RGV_O01_ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE structure, int rep) Inserts a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
RGV_O01_ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE	removeORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE(int rep) Removes a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE (a Group object)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, 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, getClass, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

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, getParent

Constructor Detail

RGV_O01

public RGV_O01()

Creates a new RGV_O01 message with DefaultModelClassFactory.

RGV_O01

public RGV_O01(ModelClassFactory factory)

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

getNTE

public NTE getNTE()

Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (NTE - notes and comments 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

insertNTE

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

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)

getPIDNTEAL1PV1PV2

public RGV_O01_PIDNTEAL1PV1PV2 getPIDNTEAL1PV1PV2()

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

getORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE

public RGV_O01_ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE getORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE()

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

getORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE

public RGV_O01_ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE getORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE(int rep)

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

getORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTEReps

public int getORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTEReps()

Returns the number of existing repetitions of ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE

insertORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE

public void insertORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE(RGV_O01_ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE structure,
                                                             int rep)
                                                      throws HL7Exception

Inserts a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

insertORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE

public RGV_O01_ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE insertORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE(int rep)
                                                                                                    throws HL7Exception

Inserts a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#insertRepetition(Structure, int)

removeORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE

public RGV_O01_ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE removeORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE(int rep)
                                                                                                    throws HL7Exception

Removes a specific repetition of ORCRXONTERXRRXCNTERXERXRRXCRXGRXRRXCOBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup\#removeRepetition(String, int)