PPV_PCA_PRBNTEVARROLVAROBXNTE (HAPI - Java HL7 API - Generated Structures v2.3.1 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v231.group.PPV_PCA_PRBNTEVARROLVAROBXNTE

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class PPV_PCA_PRBNTEVARROLVAROBXNTE
extends AbstractGroup
```
Represents a PPV_PCA_PRBNTEVARROLVAROBXNTE 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: PPV_PCA_ROLVAR (a Group object) optional repeating
- 5: PPV_PCA_OBXNTE (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
`PPV_PCA_PRBNTEVARROLVAROBXNTE(Group parent, ModelClassFactory factory)` Creates a new PPV_PCA_PRBNTEVARROLVAROBXNTE group

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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
`PPV_PCA_OBXNTE`	`getOBXNTE()` Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
`PPV_PCA_OBXNTE`	`getOBXNTE(int rep)` Returns a specific repetition of OBXNTE (a Group object) - creates it if necessary
`List<PPV_PCA_OBXNTE>`	`getOBXNTEAll()` Returns a non-modifiable List containing all current existing repetitions of OBXNTE.
`int`	`getOBXNTEReps()` Returns the number of existing repetitions of OBXNTE
`PRB`	`getPRB()` Returns PRB (Problem Detail) - creates it if necessary
`PPV_PCA_ROLVAR`	`getROLVAR()` Returns the first repetition of ROLVAR (a Group object) - creates it if necessary
`PPV_PCA_ROLVAR`	`getROLVAR(int rep)` Returns a specific repetition of ROLVAR (a Group object) - creates it if necessary
`List<PPV_PCA_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"
`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)
`PPV_PCA_OBXNTE`	`insertOBXNTE(int rep)` Inserts a specific repetition of OBXNTE (a Group object)
`void`	`insertOBXNTE(PPV_PCA_OBXNTE structure, int rep)` Inserts a specific repetition of OBXNTE (a Group object)
`PPV_PCA_ROLVAR`	`insertROLVAR(int rep)` Inserts a specific repetition of ROLVAR (a Group object)
`void`	`insertROLVAR(PPV_PCA_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)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (NTE - notes and comments segment)
`PPV_PCA_OBXNTE`	`removeOBXNTE(int rep)` Removes a specific repetition of OBXNTE (a Group object)
`PPV_PCA_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
accept, add, add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insert, insertRepetition, insertRepetition, isChoiceElement, isEmpty, isGroup, isRepeating, isRequired, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

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
  - PPV_PCA_PRBNTEVARROLVAROBXNTE
```
public PPV_PCA_PRBNTEVARROLVAROBXNTE(Group parent,
                                     ModelClassFactory factory)
```
    Creates a new PPV_PCA_PRBNTEVARROLVAROBXNTE 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 PPV_PCA_ROLVAR getROLVAR()
```
    Returns the first repetition of ROLVAR (a Group object) - creates it if necessary
  - getROLVAR
```
public PPV_PCA_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<PPV_PCA_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(PPV_PCA_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 PPV_PCA_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 PPV_PCA_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 PPV_PCA_OBXNTE getOBXNTE()
```
    Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
  - getOBXNTE
```
public PPV_PCA_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<PPV_PCA_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(PPV_PCA_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 PPV_PCA_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 PPV_PCA_OBXNTE removeOBXNTE(int rep)
                            throws HL7Exception
```
    Removes a specific repetition of OBXNTE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class PPV_PCA_PRBNTEVARROLVAROBXNTE

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PPV_PCA_PRBNTEVARROLVAROBXNTE

Method Detail

getVersion

getPRB

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getVAR

getVAR

getVARReps

getVARAll

insertVAR

insertVAR

removeVAR

getROLVAR

getROLVAR

getROLVARReps

getROLVARAll

insertROLVAR

insertROLVAR

removeROLVAR

getOBXNTE

getOBXNTE

getOBXNTEReps

getOBXNTEAll

insertOBXNTE

insertOBXNTE

removeOBXNTE