ca.uhn.hl7v2.model.v281.group

Class CCR_I16_GOAL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.CCR_I16_GOAL

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class CCR_I16_GOAL
extends AbstractGroup

Represents a CCR_I16_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: CCR_I16_ROLE_GOAL (a Group object) optional repeating
• 4: CCR_I16_GOAL_OBSERVATION (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
CCR_I16_GOAL(Group parent, ModelClassFactory factory) Creates a new CCR_I16_GOAL group

Method Summary

Modifier and Type	Method and Description
CCR_I16_GOAL_OBSERVATION	getGOAL_OBSERVATION() Returns the first repetition of GOAL_OBSERVATION (a Group object) - creates it if necessary
CCR_I16_GOAL_OBSERVATION	getGOAL_OBSERVATION(int rep) Returns a specific repetition of GOAL_OBSERVATION (a Group object) - creates it if necessary
List<CCR_I16_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
GOL	getGOL() Returns GOL (Goal Detail) - creates it if necessary
CCR_I16_ROLE_GOAL	getROLE_GOAL() Returns the first repetition of ROLE_GOAL (a Group object) - creates it if necessary
CCR_I16_ROLE_GOAL	getROLE_GOAL(int rep) Returns a specific repetition of ROLE_GOAL (a Group object) - creates it if necessary
List<CCR_I16_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.8.1"
void	insertGOAL_OBSERVATION(CCR_I16_GOAL_OBSERVATION structure, int rep) Inserts a specific repetition of GOAL_OBSERVATION (a Group object)
CCR_I16_GOAL_OBSERVATION	insertGOAL_OBSERVATION(int rep) Inserts a specific repetition of GOAL_OBSERVATION (a Group object)
void	insertROLE_GOAL(CCR_I16_ROLE_GOAL structure, int rep) Inserts a specific repetition of ROLE_GOAL (a Group object)
CCR_I16_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)
CCR_I16_GOAL_OBSERVATION	removeGOAL_OBSERVATION(int rep) Removes a specific repetition of GOAL_OBSERVATION (a Group object)
CCR_I16_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

CCR_I16_GOAL

public CCR_I16_GOAL(Group parent,
                    ModelClassFactory factory)

Creates a new CCR_I16_GOAL group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

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 CCR_I16_ROLE_GOAL getROLE_GOAL()

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

getROLE_GOAL

public CCR_I16_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<CCR_I16_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(CCR_I16_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 CCR_I16_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 CCR_I16_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)

getGOAL_OBSERVATION

public CCR_I16_GOAL_OBSERVATION getGOAL_OBSERVATION()

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

getGOAL_OBSERVATION

public CCR_I16_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<CCR_I16_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(CCR_I16_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 CCR_I16_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 CCR_I16_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)