ca.uhn.hl7v2.model.v231.group
Class PRR_PC5_PRBNTEVARROLVARPTHVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v231.group.PRR_PC5_PRBNTEVARROLVARPTHVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

All Implemented Interfaces:

Group, Structure, Serializable

public class PRR_PC5_PRBNTEVARROLVARPTHVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR
extends AbstractGroup

Represents a PRR_PC5_PRBNTEVARROLVARPTHVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: PRB (Problem Detail)
• 2: NTE (NTE - notes and comments segment) optional repeating
• 3: VAR (Variance) optional repeating
• 4: PRR_PC5_ROLVAR (a Group object) optional repeating
• 5: PRR_PC5_PTHVAR (a Group object) optional repeating
• 6: PRR_PC5_OBXNTE (a Group object) optional repeating
• 7: PRR_PC5_GOLNTEVARROLVAROBXNTE (a Group object) optional repeating
• 8: PRR_PC5_ORCOBRRXONTEVAROBXNTEVAR (a Group object) optional repeating

See Also:

Serialized Form

Constructor Summary

PRR_PC5_PRBNTEVARROLVARPTHVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(Group parent, ModelClassFactory factory)
Creates a new PRR_PC5_PRBNTEVARROLVARPTHVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR group

Method Summary

PRR_PC5_GOLNTEVARROLVAROBXNTE	getGOLNTEVARROLVAROBXNTE() Returns the first repetition of GOLNTEVARROLVAROBXNTE (a Group object) - creates it if necessary
PRR_PC5_GOLNTEVARROLVAROBXNTE	getGOLNTEVARROLVAROBXNTE(int rep) Returns a specific repetition of GOLNTEVARROLVAROBXNTE (a Group object) - creates it if necessary
int	getGOLNTEVARROLVAROBXNTEReps() Returns the number of existing repetitions of GOLNTEVARROLVAROBXNTE
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
PRR_PC5_OBXNTE	getOBXNTE() Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
PRR_PC5_OBXNTE	getOBXNTE(int rep) Returns a specific repetition of OBXNTE (a Group object) - creates it if necessary
int	getOBXNTEReps() Returns the number of existing repetitions of OBXNTE
PRR_PC5_ORCOBRRXONTEVAROBXNTEVAR	getORCOBRRXONTEVAROBXNTEVAR() Returns the first repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object) - creates it if necessary
PRR_PC5_ORCOBRRXONTEVAROBXNTEVAR	getORCOBRRXONTEVAROBXNTEVAR(int rep) Returns a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object) - creates it if necessary
int	getORCOBRRXONTEVAROBXNTEVARReps() Returns the number of existing repetitions of ORCOBRRXONTEVAROBXNTEVAR
PRB	getPRB() Returns PRB (Problem Detail) - creates it if necessary
PRR_PC5_PTHVAR	getPTHVAR() Returns the first repetition of PTHVAR (a Group object) - creates it if necessary
PRR_PC5_PTHVAR	getPTHVAR(int rep) Returns a specific repetition of PTHVAR (a Group object) - creates it if necessary
int	getPTHVARReps() Returns the number of existing repetitions of PTHVAR
PRR_PC5_ROLVAR	getROLVAR() Returns the first repetition of ROLVAR (a Group object) - creates it if necessary
PRR_PC5_ROLVAR	getROLVAR(int rep) Returns a specific repetition of ROLVAR (a Group object) - creates it if necessary
int	getROLVARReps() Returns the number of existing repetitions of ROLVAR
VAR	getVAR() Returns the first repetition of VAR (Variance) - creates it if necessary
VAR	getVAR(int rep) Returns a specific repetition of VAR (Variance) - creates it if necessary
int	getVARReps() Returns the number of existing repetitions of VAR
String	getVersion() Returns "2.3.1"
PRR_PC5_GOLNTEVARROLVAROBXNTE	insertGOLNTEVARROLVAROBXNTE(int rep) Inserts a specific repetition of GOLNTEVARROLVAROBXNTE (a Group object)
void	insertGOLNTEVARROLVAROBXNTE(PRR_PC5_GOLNTEVARROLVAROBXNTE structure, int rep) Inserts a specific repetition of GOLNTEVARROLVAROBXNTE (a Group object)
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)
PRR_PC5_OBXNTE	insertOBXNTE(int rep) Inserts a specific repetition of OBXNTE (a Group object)
void	insertOBXNTE(PRR_PC5_OBXNTE structure, int rep) Inserts a specific repetition of OBXNTE (a Group object)
PRR_PC5_ORCOBRRXONTEVAROBXNTEVAR	insertORCOBRRXONTEVAROBXNTEVAR(int rep) Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)
void	insertORCOBRRXONTEVAROBXNTEVAR(PRR_PC5_ORCOBRRXONTEVAROBXNTEVAR structure, int rep) Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)
PRR_PC5_PTHVAR	insertPTHVAR(int rep) Inserts a specific repetition of PTHVAR (a Group object)
void	insertPTHVAR(PRR_PC5_PTHVAR structure, int rep) Inserts a specific repetition of PTHVAR (a Group object)
PRR_PC5_ROLVAR	insertROLVAR(int rep) Inserts a specific repetition of ROLVAR (a Group object)
void	insertROLVAR(PRR_PC5_ROLVAR structure, int rep) Inserts a specific repetition of ROLVAR (a Group object)
VAR	insertVAR(int rep) Inserts a specific repetition of VAR (Variance)
void	insertVAR(VAR structure, int rep) Inserts a specific repetition of VAR (Variance)
PRR_PC5_GOLNTEVARROLVAROBXNTE	removeGOLNTEVARROLVAROBXNTE(int rep) Removes a specific repetition of GOLNTEVARROLVAROBXNTE (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
PRR_PC5_OBXNTE	removeOBXNTE(int rep) Removes a specific repetition of OBXNTE (a Group object)
PRR_PC5_ORCOBRRXONTEVAROBXNTEVAR	removeORCOBRRXONTEVAROBXNTEVAR(int rep) Removes a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)
PRR_PC5_PTHVAR	removePTHVAR(int rep) Removes a specific repetition of PTHVAR (a Group object)
PRR_PC5_ROLVAR	removeROLVAR(int rep) Removes a specific repetition of ROLVAR (a Group object)
VAR	removeVAR(int rep) Removes a specific repetition of VAR (Variance)

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getClass, getMessage, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PRR_PC5_PRBNTEVARROLVARPTHVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

public PRR_PC5_PRBNTEVARROLVARPTHVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(Group parent,
                                                                                        ModelClassFactory factory)

Creates a new PRR_PC5_PRBNTEVARROLVARPTHVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getPRB

public PRB getPRB()

Returns PRB (Problem Detail) - 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)

getVAR

public VAR getVAR()

Returns the first repetition of VAR (Variance) - creates it if necessary

getVAR

public VAR getVAR(int rep)

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

getVARReps

public int getVARReps()

Returns the number of existing repetitions of VAR

insertVAR

public void insertVAR(VAR structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of VAR (Variance)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertVAR

public VAR insertVAR(int rep)
              throws HL7Exception

Inserts a specific repetition of VAR (Variance)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeVAR

public VAR removeVAR(int rep)
              throws HL7Exception

Removes a specific repetition of VAR (Variance)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getROLVAR

public PRR_PC5_ROLVAR getROLVAR()

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

getROLVAR

public PRR_PC5_ROLVAR getROLVAR(int rep)

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

getROLVARReps

public int getROLVARReps()

Returns the number of existing repetitions of ROLVAR

insertROLVAR

public void insertROLVAR(PRR_PC5_ROLVAR structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of ROLVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertROLVAR

public PRR_PC5_ROLVAR insertROLVAR(int rep)
                            throws HL7Exception

Inserts a specific repetition of ROLVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeROLVAR

public PRR_PC5_ROLVAR removeROLVAR(int rep)
                            throws HL7Exception

Removes a specific repetition of ROLVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPTHVAR

public PRR_PC5_PTHVAR getPTHVAR()

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

getPTHVAR

public PRR_PC5_PTHVAR getPTHVAR(int rep)

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

getPTHVARReps

public int getPTHVARReps()

Returns the number of existing repetitions of PTHVAR

insertPTHVAR

public void insertPTHVAR(PRR_PC5_PTHVAR structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of PTHVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPTHVAR

public PRR_PC5_PTHVAR insertPTHVAR(int rep)
                            throws HL7Exception

Inserts a specific repetition of PTHVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePTHVAR

public PRR_PC5_PTHVAR removePTHVAR(int rep)
                            throws HL7Exception

Removes a specific repetition of PTHVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getOBXNTE

public PRR_PC5_OBXNTE getOBXNTE()

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

getOBXNTE

public PRR_PC5_OBXNTE getOBXNTE(int rep)

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

getOBXNTEReps

public int getOBXNTEReps()

Returns the number of existing repetitions of OBXNTE

insertOBXNTE

public void insertOBXNTE(PRR_PC5_OBXNTE structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBXNTE

public PRR_PC5_OBXNTE insertOBXNTE(int rep)
                            throws HL7Exception

Inserts a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBXNTE

public PRR_PC5_OBXNTE removeOBXNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getGOLNTEVARROLVAROBXNTE

public PRR_PC5_GOLNTEVARROLVAROBXNTE getGOLNTEVARROLVAROBXNTE()

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

getGOLNTEVARROLVAROBXNTE

public PRR_PC5_GOLNTEVARROLVAROBXNTE getGOLNTEVARROLVAROBXNTE(int rep)

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

getGOLNTEVARROLVAROBXNTEReps

public int getGOLNTEVARROLVAROBXNTEReps()

Returns the number of existing repetitions of GOLNTEVARROLVAROBXNTE

insertGOLNTEVARROLVAROBXNTE

public void insertGOLNTEVARROLVAROBXNTE(PRR_PC5_GOLNTEVARROLVAROBXNTE structure,
                                        int rep)
                                 throws HL7Exception

Inserts a specific repetition of GOLNTEVARROLVAROBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertGOLNTEVARROLVAROBXNTE

public PRR_PC5_GOLNTEVARROLVAROBXNTE insertGOLNTEVARROLVAROBXNTE(int rep)
                                                          throws HL7Exception

Inserts a specific repetition of GOLNTEVARROLVAROBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeGOLNTEVARROLVAROBXNTE

public PRR_PC5_GOLNTEVARROLVAROBXNTE removeGOLNTEVARROLVAROBXNTE(int rep)
                                                          throws HL7Exception

Removes a specific repetition of GOLNTEVARROLVAROBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getORCOBRRXONTEVAROBXNTEVAR

public PRR_PC5_ORCOBRRXONTEVAROBXNTEVAR getORCOBRRXONTEVAROBXNTEVAR()

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

getORCOBRRXONTEVAROBXNTEVAR

public PRR_PC5_ORCOBRRXONTEVAROBXNTEVAR getORCOBRRXONTEVAROBXNTEVAR(int rep)

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

getORCOBRRXONTEVAROBXNTEVARReps

public int getORCOBRRXONTEVAROBXNTEVARReps()

Returns the number of existing repetitions of ORCOBRRXONTEVAROBXNTEVAR

insertORCOBRRXONTEVAROBXNTEVAR

public void insertORCOBRRXONTEVAROBXNTEVAR(PRR_PC5_ORCOBRRXONTEVAROBXNTEVAR structure,
                                           int rep)
                                    throws HL7Exception

Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORCOBRRXONTEVAROBXNTEVAR

public PRR_PC5_ORCOBRRXONTEVAROBXNTEVAR insertORCOBRRXONTEVAROBXNTEVAR(int rep)
                                                                throws HL7Exception

Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORCOBRRXONTEVAROBXNTEVAR

public PRR_PC5_ORCOBRRXONTEVAROBXNTEVAR removeORCOBRRXONTEVAROBXNTEVAR(int rep)
                                                                throws HL7Exception

Removes a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)