PPG_PCG_GOAL (HAPI - Java HL7 API - Generated Structures v2.5.1 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v251.group.PPG_PCG_GOAL

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class PPG_PCG_GOAL
extends AbstractGroup
```
Represents a PPG_PCG_GOAL 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: GOL (Goal Detail)
- 2: NTE (Notes and Comments) optional repeating
- 3: VAR (Variance) optional repeating
- 4: PPG_PCG_GOAL_ROLE (a Group object) optional repeating
- 5: PPG_PCG_GOAL_OBSERVATION (a Group object) optional repeating
- 6: PPG_PCG_PROBLEM (a Group object) optional repeating
- 7: PPG_PCG_ORDER (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

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

Constructors
Constructor and Description
`PPG_PCG_GOAL(Group parent, ModelClassFactory factory)` Creates a new PPG_PCG_GOAL group

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PPG_PCG_GOAL_OBSERVATION`	`getGOAL_OBSERVATION()` Returns the first repetition of GOAL_OBSERVATION (a Group object) - creates it if necessary
`PPG_PCG_GOAL_OBSERVATION`	`getGOAL_OBSERVATION(int rep)` Returns a specific repetition of GOAL_OBSERVATION (a Group object) - creates it if necessary
`List<PPG_PCG_GOAL_OBSERVATION>`	`getGOAL_OBSERVATIONAll()` Returns a non-modifiable List containing all current existing repetitions of GOAL_OBSERVATION.
`int`	`getGOAL_OBSERVATIONReps()` Returns the number of existing repetitions of GOAL_OBSERVATION
`PPG_PCG_GOAL_ROLE`	`getGOAL_ROLE()` Returns the first repetition of GOAL_ROLE (a Group object) - creates it if necessary
`PPG_PCG_GOAL_ROLE`	`getGOAL_ROLE(int rep)` Returns a specific repetition of GOAL_ROLE (a Group object) - creates it if necessary
`List<PPG_PCG_GOAL_ROLE>`	`getGOAL_ROLEAll()` Returns a non-modifiable List containing all current existing repetitions of GOAL_ROLE.
`int`	`getGOAL_ROLEReps()` Returns the number of existing repetitions of GOAL_ROLE
`GOL`	`getGOL()` Returns GOL (Goal Detail) - creates it if necessary
`NTE`	`getNTE()` Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
`NTE`	`getNTE(int rep)` Returns a specific repetition of NTE (Notes and Comments) - 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
`PPG_PCG_ORDER`	`getORDER()` Returns the first repetition of ORDER (a Group object) - creates it if necessary
`PPG_PCG_ORDER`	`getORDER(int rep)` Returns a specific repetition of ORDER (a Group object) - creates it if necessary
`List<PPG_PCG_ORDER>`	`getORDERAll()` Returns a non-modifiable List containing all current existing repetitions of ORDER.
`int`	`getORDERReps()` Returns the number of existing repetitions of ORDER
`PPG_PCG_PROBLEM`	`getPROBLEM()` Returns the first repetition of PROBLEM (a Group object) - creates it if necessary
`PPG_PCG_PROBLEM`	`getPROBLEM(int rep)` Returns a specific repetition of PROBLEM (a Group object) - creates it if necessary
`List<PPG_PCG_PROBLEM>`	`getPROBLEMAll()` Returns a non-modifiable List containing all current existing repetitions of PROBLEM.
`int`	`getPROBLEMReps()` Returns the number of existing repetitions of PROBLEM
`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.5.1"
`PPG_PCG_GOAL_OBSERVATION`	`insertGOAL_OBSERVATION(int rep)` Inserts a specific repetition of GOAL_OBSERVATION (a Group object)
`void`	`insertGOAL_OBSERVATION(PPG_PCG_GOAL_OBSERVATION structure, int rep)` Inserts a specific repetition of GOAL_OBSERVATION (a Group object)
`PPG_PCG_GOAL_ROLE`	`insertGOAL_ROLE(int rep)` Inserts a specific repetition of GOAL_ROLE (a Group object)
`void`	`insertGOAL_ROLE(PPG_PCG_GOAL_ROLE structure, int rep)` Inserts a specific repetition of GOAL_ROLE (a Group object)
`NTE`	`insertNTE(int rep)` Inserts a specific repetition of NTE (Notes and Comments)
`void`	`insertNTE(NTE structure, int rep)` Inserts a specific repetition of NTE (Notes and Comments)
`PPG_PCG_ORDER`	`insertORDER(int rep)` Inserts a specific repetition of ORDER (a Group object)
`void`	`insertORDER(PPG_PCG_ORDER structure, int rep)` Inserts a specific repetition of ORDER (a Group object)
`PPG_PCG_PROBLEM`	`insertPROBLEM(int rep)` Inserts a specific repetition of PROBLEM (a Group object)
`void`	`insertPROBLEM(PPG_PCG_PROBLEM structure, int rep)` Inserts a specific repetition of PROBLEM (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)
`PPG_PCG_GOAL_OBSERVATION`	`removeGOAL_OBSERVATION(int rep)` Removes a specific repetition of GOAL_OBSERVATION (a Group object)
`PPG_PCG_GOAL_ROLE`	`removeGOAL_ROLE(int rep)` Removes a specific repetition of GOAL_ROLE (a Group object)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)
`PPG_PCG_ORDER`	`removeORDER(int rep)` Removes a specific repetition of ORDER (a Group object)
`PPG_PCG_PROBLEM`	`removePROBLEM(int rep)` Removes a specific repetition of PROBLEM (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
  - PPG_PCG_GOAL
```
public PPG_PCG_GOAL(Group parent,
                    ModelClassFactory factory)
```
    Creates a new PPG_PCG_GOAL group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.5.1"
  - getGOL
```
public GOL getGOL()
```
    Returns GOL (Goal Detail) - creates it if necessary
  - getNTE
```
public NTE getNTE()
```
    Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
  - getNTE
```
public NTE getNTE(int rep)
```
    Returns a specific repetition of NTE (Notes and Comments) - 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 (Notes and Comments)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertNTE
```
public NTE insertNTE(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of NTE (Notes and Comments)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeNTE
```
public NTE removeNTE(int rep)
              throws HL7Exception
```
    Removes a specific repetition of NTE (Notes and Comments)
    
    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)
  - getGOAL_ROLE
```
public PPG_PCG_GOAL_ROLE getGOAL_ROLE()
```
    Returns the first repetition of GOAL_ROLE (a Group object) - creates it if necessary
  - getGOAL_ROLE
```
public PPG_PCG_GOAL_ROLE getGOAL_ROLE(int rep)
```
    Returns a specific repetition of GOAL_ROLE (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.
  - getGOAL_ROLEReps
```
public int getGOAL_ROLEReps()
```
    Returns the number of existing repetitions of GOAL_ROLE
  - getGOAL_ROLEAll
```
public List<PPG_PCG_GOAL_ROLE> getGOAL_ROLEAll()
                                        throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of GOAL_ROLE.
    
    Note that unlike getGOAL_ROLE(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertGOAL_ROLE
```
public void insertGOAL_ROLE(PPG_PCG_GOAL_ROLE structure,
                            int rep)
                     throws HL7Exception
```
    Inserts a specific repetition of GOAL_ROLE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertGOAL_ROLE
```
public PPG_PCG_GOAL_ROLE insertGOAL_ROLE(int rep)
                                  throws HL7Exception
```
    Inserts a specific repetition of GOAL_ROLE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeGOAL_ROLE
```
public PPG_PCG_GOAL_ROLE removeGOAL_ROLE(int rep)
                                  throws HL7Exception
```
    Removes a specific repetition of GOAL_ROLE (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getGOAL_OBSERVATION
```
public PPG_PCG_GOAL_OBSERVATION getGOAL_OBSERVATION()
```
    Returns the first repetition of GOAL_OBSERVATION (a Group object) - creates it if necessary
  - getGOAL_OBSERVATION
```
public PPG_PCG_GOAL_OBSERVATION getGOAL_OBSERVATION(int rep)
```
    Returns a specific repetition of GOAL_OBSERVATION (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.
  - getGOAL_OBSERVATIONReps
```
public int getGOAL_OBSERVATIONReps()
```
    Returns the number of existing repetitions of GOAL_OBSERVATION
  - getGOAL_OBSERVATIONAll
```
public List<PPG_PCG_GOAL_OBSERVATION> getGOAL_OBSERVATIONAll()
                                                      throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of GOAL_OBSERVATION.
    
    Note that unlike getGOAL_OBSERVATION(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertGOAL_OBSERVATION
```
public void insertGOAL_OBSERVATION(PPG_PCG_GOAL_OBSERVATION structure,
                                   int rep)
                            throws HL7Exception
```
    Inserts a specific repetition of GOAL_OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertGOAL_OBSERVATION
```
public PPG_PCG_GOAL_OBSERVATION insertGOAL_OBSERVATION(int rep)
                                                throws HL7Exception
```
    Inserts a specific repetition of GOAL_OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeGOAL_OBSERVATION
```
public PPG_PCG_GOAL_OBSERVATION removeGOAL_OBSERVATION(int rep)
                                                throws HL7Exception
```
    Removes a specific repetition of GOAL_OBSERVATION (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getPROBLEM
```
public PPG_PCG_PROBLEM getPROBLEM()
```
    Returns the first repetition of PROBLEM (a Group object) - creates it if necessary
  - getPROBLEM
```
public PPG_PCG_PROBLEM getPROBLEM(int rep)
```
    Returns a specific repetition of PROBLEM (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.
  - getPROBLEMReps
```
public int getPROBLEMReps()
```
    Returns the number of existing repetitions of PROBLEM
  - getPROBLEMAll
```
public List<PPG_PCG_PROBLEM> getPROBLEMAll()
                                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of PROBLEM.
    
    Note that unlike getPROBLEM(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertPROBLEM
```
public void insertPROBLEM(PPG_PCG_PROBLEM structure,
                          int rep)
                   throws HL7Exception
```
    Inserts a specific repetition of PROBLEM (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertPROBLEM
```
public PPG_PCG_PROBLEM insertPROBLEM(int rep)
                              throws HL7Exception
```
    Inserts a specific repetition of PROBLEM (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removePROBLEM
```
public PPG_PCG_PROBLEM removePROBLEM(int rep)
                              throws HL7Exception
```
    Removes a specific repetition of PROBLEM (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getORDER
```
public PPG_PCG_ORDER getORDER()
```
    Returns the first repetition of ORDER (a Group object) - creates it if necessary
  - getORDER
```
public PPG_PCG_ORDER getORDER(int rep)
```
    Returns a specific repetition of ORDER (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.
  - getORDERReps
```
public int getORDERReps()
```
    Returns the number of existing repetitions of ORDER
  - getORDERAll
```
public List<PPG_PCG_ORDER> getORDERAll()
                                throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ORDER.
    
    Note that unlike getORDER(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertORDER
```
public void insertORDER(PPG_PCG_ORDER structure,
                        int rep)
                 throws HL7Exception
```
    Inserts a specific repetition of ORDER (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertORDER
```
public PPG_PCG_ORDER insertORDER(int rep)
                          throws HL7Exception
```
    Inserts a specific repetition of ORDER (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeORDER
```
public PPG_PCG_ORDER removeORDER(int rep)
                          throws HL7Exception
```
    Removes a specific repetition of ORDER (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class PPG_PCG_GOAL

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

PPG_PCG_GOAL

Method Detail

getVersion

getGOL

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getVAR

getVAR

getVARReps

getVARAll

insertVAR

insertVAR

removeVAR

getGOAL_ROLE

getGOAL_ROLE

getGOAL_ROLEReps

getGOAL_ROLEAll

insertGOAL_ROLE

insertGOAL_ROLE

removeGOAL_ROLE

getGOAL_OBSERVATION

getGOAL_OBSERVATION

getGOAL_OBSERVATIONReps

getGOAL_OBSERVATIONAll

insertGOAL_OBSERVATION

insertGOAL_OBSERVATION

removeGOAL_OBSERVATION

getPROBLEM

getPROBLEM

getPROBLEMReps

getPROBLEMAll

insertPROBLEM

insertPROBLEM

removePROBLEM

getORDER

getORDER

getORDERReps

getORDERAll

insertORDER

insertORDER

removeORDER