Package ca.uhn.hl7v2.model.v23.group

Class PGL_PC6_GOAL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.PGL_PC6_GOAL

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class PGL_PC6_GOAL
extends AbstractGroup

Represents a PGL_PC6_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 segment) optional repeating
• 3: VAR (Variance) optional repeating
• 4: PGL_PC6_GOAL_ROLE (a Group object) optional repeating
• 5: PGL_PC6_PATHWAY (a Group object) optional repeating
• 6: PGL_PC6_OBSERVATION (a Group object) optional repeating
• 7: PGL_PC6_PROBLEM (a Group object) optional repeating
• 8: PGL_PC6_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	Description
PGL_PC6_GOAL(Group parent, ModelClassFactory factory)	Creates a new PGL_PC6_GOAL group

Method Summary

Modifier and Type	Method	Description
PGL_PC6_GOAL_ROLE	getGOAL_ROLE()	Returns the first repetition of GOAL_ROLE (a Group object) - creates it if necessary
PGL_PC6_GOAL_ROLE	getGOAL_ROLE(int rep)	Returns a specific repetition of GOAL_ROLE (a Group object) - creates it if necessary
List<PGL_PC6_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 segment) - creates it if necessary
NTE	getNTE(int rep)	Returns a specific repetition of 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
PGL_PC6_OBSERVATION	getOBSERVATION()	Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
PGL_PC6_OBSERVATION	getOBSERVATION(int rep)	Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
List<PGL_PC6_OBSERVATION>	getOBSERVATIONAll()	Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
int	getOBSERVATIONReps()	Returns the number of existing repetitions of OBSERVATION
PGL_PC6_ORDER	getORDER()	Returns the first repetition of ORDER (a Group object) - creates it if necessary
PGL_PC6_ORDER	getORDER(int rep)	Returns a specific repetition of ORDER (a Group object) - creates it if necessary
List<PGL_PC6_ORDER>	getORDERAll()	Returns a non-modifiable List containing all current existing repetitions of ORDER.
int	getORDERReps()	Returns the number of existing repetitions of ORDER
PGL_PC6_PATHWAY	getPATHWAY()	Returns the first repetition of PATHWAY (a Group object) - creates it if necessary
PGL_PC6_PATHWAY	getPATHWAY(int rep)	Returns a specific repetition of PATHWAY (a Group object) - creates it if necessary
List<PGL_PC6_PATHWAY>	getPATHWAYAll()	Returns a non-modifiable List containing all current existing repetitions of PATHWAY.
int	getPATHWAYReps()	Returns the number of existing repetitions of PATHWAY
PGL_PC6_PROBLEM	getPROBLEM()	Returns the first repetition of PROBLEM (a Group object) - creates it if necessary
PGL_PC6_PROBLEM	getPROBLEM(int rep)	Returns a specific repetition of PROBLEM (a Group object) - creates it if necessary
List<PGL_PC6_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.3"
PGL_PC6_GOAL_ROLE	insertGOAL_ROLE(int rep)	Inserts a specific repetition of GOAL_ROLE (a Group object)
void	insertGOAL_ROLE(PGL_PC6_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 segment)
void	insertNTE(NTE structure, int rep)	Inserts a specific repetition of NTE (Notes and comments segment)
PGL_PC6_OBSERVATION	insertOBSERVATION(int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(PGL_PC6_OBSERVATION structure, int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
PGL_PC6_ORDER	insertORDER(int rep)	Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(PGL_PC6_ORDER structure, int rep)	Inserts a specific repetition of ORDER (a Group object)
PGL_PC6_PATHWAY	insertPATHWAY(int rep)	Inserts a specific repetition of PATHWAY (a Group object)
void	insertPATHWAY(PGL_PC6_PATHWAY structure, int rep)	Inserts a specific repetition of PATHWAY (a Group object)
PGL_PC6_PROBLEM	insertPROBLEM(int rep)	Inserts a specific repetition of PROBLEM (a Group object)
void	insertPROBLEM(PGL_PC6_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)
PGL_PC6_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 segment)
PGL_PC6_OBSERVATION	removeOBSERVATION(int rep)	Removes a specific repetition of OBSERVATION (a Group object)
PGL_PC6_ORDER	removeORDER(int rep)	Removes a specific repetition of ORDER (a Group object)
PGL_PC6_PATHWAY	removePATHWAY(int rep)	Removes a specific repetition of PATHWAY (a Group object)
PGL_PC6_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 Details

PGL_PC6_GOAL

public PGL_PC6_GOAL(Group parent,
 ModelClassFactory factory)

Creates a new PGL_PC6_GOAL group

Method Details

getVersion

public String getVersion()

Returns "2.3"

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 segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of 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 (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 (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 (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)

getGOAL_ROLE

public PGL_PC6_GOAL_ROLE getGOAL_ROLE()

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

getGOAL_ROLE

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

getPATHWAY

public PGL_PC6_PATHWAY getPATHWAY()

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

getPATHWAY

public PGL_PC6_PATHWAY getPATHWAY(int rep)

Returns a specific repetition of PATHWAY (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.

getPATHWAYReps

public int getPATHWAYReps()

Returns the number of existing repetitions of PATHWAY

getPATHWAYAll

public List<PGL_PC6_PATHWAY> getPATHWAYAll()
                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPATHWAY

public void insertPATHWAY(PGL_PC6_PATHWAY structure,
 int rep)
                   throws HL7Exception

Inserts a specific repetition of PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPATHWAY

public PGL_PC6_PATHWAY insertPATHWAY(int rep)
                              throws HL7Exception

Inserts a specific repetition of PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePATHWAY

public PGL_PC6_PATHWAY removePATHWAY(int rep)
                              throws HL7Exception

Removes a specific repetition of PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getOBSERVATION

public PGL_PC6_OBSERVATION getOBSERVATION()

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

getOBSERVATION

public PGL_PC6_OBSERVATION getOBSERVATION(int rep)

Returns a specific repetition of 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.

getOBSERVATIONReps

public int getOBSERVATIONReps()

Returns the number of existing repetitions of OBSERVATION

getOBSERVATIONAll

public List<PGL_PC6_OBSERVATION> getOBSERVATIONAll()
                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertOBSERVATION

public void insertOBSERVATION(PGL_PC6_OBSERVATION structure,
 int rep)
                       throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertOBSERVATION

public PGL_PC6_OBSERVATION insertOBSERVATION(int rep)
                                      throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeOBSERVATION

public PGL_PC6_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPROBLEM

public PGL_PC6_PROBLEM getPROBLEM()

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

getPROBLEM

public PGL_PC6_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<PGL_PC6_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(PGL_PC6_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 PGL_PC6_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 PGL_PC6_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 PGL_PC6_ORDER getORDER()

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

getORDER

public PGL_PC6_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<PGL_PC6_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(PGL_PC6_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 PGL_PC6_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 PGL_PC6_ORDER removeORDER(int rep)
                          throws HL7Exception

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)