CCI_I22_GOAL (HAPI - Java HL7 API - Generated Structures v2.7 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v27.group.CCI_I22_GOAL

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class CCI_I22_GOAL
extends AbstractGroup
```
Represents a CCI_I22_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: VAR (Variance) optional repeating
- 3: CCI_I22_ROLE_GOAL (a Group object) optional repeating
- 4: OBX (Observation/Result) optional repeating
See Also:

Serialized Form

Field Summary
- Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure
  log

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GOL`	`getGOL()` Returns GOL (Goal Detail) - creates it if necessary
`OBX`	`getOBX()` Returns the first repetition of OBX (Observation/Result) - creates it if necessary
`OBX`	`getOBX(int rep)` Returns a specific repetition of OBX (Observation/Result) - creates it if necessary
`List<OBX>`	`getOBXAll()` Returns a non-modifiable List containing all current existing repetitions of OBX.
`int`	`getOBXReps()` Returns the number of existing repetitions of OBX
`CCI_I22_ROLE_GOAL`	`getROLE_GOAL()` Returns the first repetition of ROLE_GOAL (a Group object) - creates it if necessary
`CCI_I22_ROLE_GOAL`	`getROLE_GOAL(int rep)` Returns a specific repetition of ROLE_GOAL (a Group object) - creates it if necessary
`List<CCI_I22_ROLE_GOAL>`	`getROLE_GOALAll()` Returns a non-modifiable List containing all current existing repetitions of ROLE_GOAL.
`int`	`getROLE_GOALReps()` Returns the number of existing repetitions of ROLE_GOAL
`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.7"
`OBX`	`insertOBX(int rep)` Inserts a specific repetition of OBX (Observation/Result)
`void`	`insertOBX(OBX structure, int rep)` Inserts a specific repetition of OBX (Observation/Result)
`void`	`insertROLE_GOAL(CCI_I22_ROLE_GOAL structure, int rep)` Inserts a specific repetition of ROLE_GOAL (a Group object)
`CCI_I22_ROLE_GOAL`	`insertROLE_GOAL(int rep)` Inserts a specific repetition of ROLE_GOAL (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)
`OBX`	`removeOBX(int rep)` Removes a specific repetition of OBX (Observation/Result)
`CCI_I22_ROLE_GOAL`	`removeROLE_GOAL(int rep)` Removes a specific repetition of ROLE_GOAL (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
  - CCI_I22_GOAL
```
public CCI_I22_GOAL(Group parent,
                    ModelClassFactory factory)
```
    Creates a new CCI_I22_GOAL group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.7"
  - getGOL
```
public GOL getGOL()
```
    Returns GOL (Goal Detail) - creates it if necessary
  - 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)
  - getROLE_GOAL
```
public CCI_I22_ROLE_GOAL getROLE_GOAL()
```
    Returns the first repetition of ROLE_GOAL (a Group object) - creates it if necessary
  - getROLE_GOAL
```
public CCI_I22_ROLE_GOAL getROLE_GOAL(int rep)
```
    Returns a specific repetition of ROLE_GOAL (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.
  - getROLE_GOALReps
```
public int getROLE_GOALReps()
```
    Returns the number of existing repetitions of ROLE_GOAL
  - getROLE_GOALAll
```
public List<CCI_I22_ROLE_GOAL> getROLE_GOALAll()
                                        throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of ROLE_GOAL.
    
    Note that unlike getROLE_GOAL(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertROLE_GOAL
```
public void insertROLE_GOAL(CCI_I22_ROLE_GOAL structure,
                            int rep)
                     throws HL7Exception
```
    Inserts a specific repetition of ROLE_GOAL (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertROLE_GOAL
```
public CCI_I22_ROLE_GOAL insertROLE_GOAL(int rep)
                                  throws HL7Exception
```
    Inserts a specific repetition of ROLE_GOAL (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeROLE_GOAL
```
public CCI_I22_ROLE_GOAL removeROLE_GOAL(int rep)
                                  throws HL7Exception
```
    Removes a specific repetition of ROLE_GOAL (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)
  - getOBX
```
public OBX getOBX()
```
    Returns the first repetition of OBX (Observation/Result) - creates it if necessary
  - getOBX
```
public OBX getOBX(int rep)
```
    Returns a specific repetition of OBX (Observation/Result) - 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.
  - getOBXReps
```
public int getOBXReps()
```
    Returns the number of existing repetitions of OBX
  - getOBXAll
```
public List<OBX> getOBXAll()
                    throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of OBX.
    
    Note that unlike getOBX(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertOBX
```
public void insertOBX(OBX structure,
                      int rep)
               throws HL7Exception
```
    Inserts a specific repetition of OBX (Observation/Result)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertOBX
```
public OBX insertOBX(int rep)
              throws HL7Exception
```
    Inserts a specific repetition of OBX (Observation/Result)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeOBX
```
public OBX removeOBX(int rep)
              throws HL7Exception
```
    Removes a specific repetition of OBX (Observation/Result)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class CCI_I22_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

CCI_I22_GOAL

Method Detail

getVersion

getGOL

getVAR

getVAR

getVARReps

getVARAll

insertVAR

insertVAR

removeVAR

getROLE_GOAL

getROLE_GOAL

getROLE_GOALReps

getROLE_GOALAll

insertROLE_GOAL

insertROLE_GOAL

removeROLE_GOAL

getOBX

getOBX

getOBXReps

getOBXAll

insertOBX

insertOBX

removeOBX