ca.uhn.hl7v2.model.v231.group

Class PPP_PCB_PRBNTEVARROLVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.PPP_PCB_PRBNTEVARROLVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

All Implemented Interfaces:

Group, Structure, Serializable

public class PPP_PCB_PRBNTEVARROLVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR
extends AbstractGroup

Represents a PPP_PCB_PRBNTEVARROLVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR 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: PPP_PCB_ROLVAR (a Group object) optional repeating
• 5: PPP_PCB_OBXNTE (a Group object) optional repeating
• 6: PPP_PCB_GOLNTEVARROLVAROBXNTE (a Group object) optional repeating
• 7: PPP_PCB_ORCOBRRXONTEVAROBXNTEVAR (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
PPP_PCB_PRBNTEVARROLVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(Group parent, ModelClassFactory factory) Creates a new PPP_PCB_PRBNTEVARROLVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR group

Method Summary

Methods

Modifier and Type	Method and Description
PPP_PCB_GOLNTEVARROLVAROBXNTE	getGOLNTEVARROLVAROBXNTE() Returns the first repetition of GOLNTEVARROLVAROBXNTE (a Group object) - creates it if necessary
PPP_PCB_GOLNTEVARROLVAROBXNTE	getGOLNTEVARROLVAROBXNTE(int rep) Returns a specific repetition of GOLNTEVARROLVAROBXNTE (a Group object) - creates it if necessary
List<PPP_PCB_GOLNTEVARROLVAROBXNTE>	getGOLNTEVARROLVAROBXNTEAll() Returns a non-modifiable List containing all current existing repetitions of GOLNTEVARROLVAROBXNTE.
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
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
PPP_PCB_OBXNTE	getOBXNTE() Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
PPP_PCB_OBXNTE	getOBXNTE(int rep) Returns a specific repetition of OBXNTE (a Group object) - creates it if necessary
List<PPP_PCB_OBXNTE>	getOBXNTEAll() Returns a non-modifiable List containing all current existing repetitions of OBXNTE.
int	getOBXNTEReps() Returns the number of existing repetitions of OBXNTE
PPP_PCB_ORCOBRRXONTEVAROBXNTEVAR	getORCOBRRXONTEVAROBXNTEVAR() Returns the first repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object) - creates it if necessary
PPP_PCB_ORCOBRRXONTEVAROBXNTEVAR	getORCOBRRXONTEVAROBXNTEVAR(int rep) Returns a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object) - creates it if necessary
List<PPP_PCB_ORCOBRRXONTEVAROBXNTEVAR>	getORCOBRRXONTEVAROBXNTEVARAll() Returns a non-modifiable List containing all current existing repetitions of ORCOBRRXONTEVAROBXNTEVAR.
int	getORCOBRRXONTEVAROBXNTEVARReps() Returns the number of existing repetitions of ORCOBRRXONTEVAROBXNTEVAR
PRB	getPRB() Returns PRB (Problem Detail) - creates it if necessary
PPP_PCB_ROLVAR	getROLVAR() Returns the first repetition of ROLVAR (a Group object) - creates it if necessary
PPP_PCB_ROLVAR	getROLVAR(int rep) Returns a specific repetition of ROLVAR (a Group object) - creates it if necessary
List<PPP_PCB_ROLVAR>	getROLVARAll() Returns a non-modifiable List containing all current existing repetitions of ROLVAR.
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
List<VAR>	getVARAll() Returns a non-modifiable List containing all current existing repetitions of VAR.
int	getVARReps() Returns the number of existing repetitions of VAR
String	getVersion() Returns "2.3.1"
PPP_PCB_GOLNTEVARROLVAROBXNTE	insertGOLNTEVARROLVAROBXNTE(int rep) Inserts a specific repetition of GOLNTEVARROLVAROBXNTE (a Group object)
void	insertGOLNTEVARROLVAROBXNTE(PPP_PCB_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)
PPP_PCB_OBXNTE	insertOBXNTE(int rep) Inserts a specific repetition of OBXNTE (a Group object)
void	insertOBXNTE(PPP_PCB_OBXNTE structure, int rep) Inserts a specific repetition of OBXNTE (a Group object)
PPP_PCB_ORCOBRRXONTEVAROBXNTEVAR	insertORCOBRRXONTEVAROBXNTEVAR(int rep) Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)
void	insertORCOBRRXONTEVAROBXNTEVAR(PPP_PCB_ORCOBRRXONTEVAROBXNTEVAR structure, int rep) Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)
PPP_PCB_ROLVAR	insertROLVAR(int rep) Inserts a specific repetition of ROLVAR (a Group object)
void	insertROLVAR(PPP_PCB_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)
PPP_PCB_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)
PPP_PCB_OBXNTE	removeOBXNTE(int rep) Removes a specific repetition of OBXNTE (a Group object)
PPP_PCB_ORCOBRRXONTEVAROBXNTEVAR	removeORCOBRRXONTEVAROBXNTEVAR(int rep) Removes a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)
PPP_PCB_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, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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

getMessage, getParent

Methods inherited from class java.lang.Object

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

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

getMessage, getParent

Constructor Detail

PPP_PCB_PRBNTEVARROLVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

public PPP_PCB_PRBNTEVARROLVAROBXNTEGOLNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(Group parent,
                                                                          ModelClassFactory factory)

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

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

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

getVARAll

public List<VAR> getVARAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

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 PPP_PCB_ROLVAR getROLVAR()

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

getROLVAR

public PPP_PCB_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

getROLVARAll

public List<PPP_PCB_ROLVAR> getROLVARAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertROLVAR

public void insertROLVAR(PPP_PCB_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 PPP_PCB_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 PPP_PCB_ROLVAR removeROLVAR(int rep)
                            throws HL7Exception

Removes a specific repetition of ROLVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getOBXNTE

public PPP_PCB_OBXNTE getOBXNTE()

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

getOBXNTE

public PPP_PCB_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

getOBXNTEAll

public List<PPP_PCB_OBXNTE> getOBXNTEAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertOBXNTE

public void insertOBXNTE(PPP_PCB_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 PPP_PCB_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 PPP_PCB_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 PPP_PCB_GOLNTEVARROLVAROBXNTE getGOLNTEVARROLVAROBXNTE()

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

getGOLNTEVARROLVAROBXNTE

public PPP_PCB_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

getGOLNTEVARROLVAROBXNTEAll

public List<PPP_PCB_GOLNTEVARROLVAROBXNTE> getGOLNTEVARROLVAROBXNTEAll()
                                                                throws HL7Exception

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

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

Throws:

HL7Exception

insertGOLNTEVARROLVAROBXNTE

public void insertGOLNTEVARROLVAROBXNTE(PPP_PCB_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 PPP_PCB_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 PPP_PCB_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 PPP_PCB_ORCOBRRXONTEVAROBXNTEVAR getORCOBRRXONTEVAROBXNTEVAR()

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

getORCOBRRXONTEVAROBXNTEVAR

public PPP_PCB_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

getORCOBRRXONTEVAROBXNTEVARAll

public List<PPP_PCB_ORCOBRRXONTEVAROBXNTEVAR> getORCOBRRXONTEVAROBXNTEVARAll()
                                                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertORCOBRRXONTEVAROBXNTEVAR

public void insertORCOBRRXONTEVAROBXNTEVAR(PPP_PCB_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 PPP_PCB_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 PPP_PCB_ORCOBRRXONTEVAROBXNTEVAR removeORCOBRRXONTEVAROBXNTEVAR(int rep)
                                                                throws HL7Exception

Removes a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)