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

Class PPR_PC3_PROBLEM

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.PPR_PC3_PROBLEM

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class PPR_PC3_PROBLEM
extends AbstractGroup

Represents a PPR_PC3_PROBLEM 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 (Notes and comments segment) optional repeating
• 3: VAR (Variance) optional repeating
• 4: PPR_PC3_PROBLEM_ROLE (a Group object) optional repeating
• 5: PPR_PC3_PATHWAY (a Group object) optional repeating
• 6: PPR_PC3_PROBLEM_OBSERVATION (a Group object) optional repeating
• 7: PPR_PC3_GOAL (a Group object) optional repeating
• 8: PPR_PC3_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
PPR_PC3_PROBLEM(Group parent, ModelClassFactory factory)	Creates a new PPR_PC3_PROBLEM group

Method Summary

Modifier and Type	Method	Description
PPR_PC3_GOAL	getGOAL()	Returns the first repetition of GOAL (a Group object) - creates it if necessary
PPR_PC3_GOAL	getGOAL(int rep)	Returns a specific repetition of GOAL (a Group object) - creates it if necessary
List<PPR_PC3_GOAL>	getGOALAll()	Returns a non-modifiable List containing all current existing repetitions of GOAL.
int	getGOALReps()	Returns the number of existing repetitions of GOAL
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
PPR_PC3_ORDER	getORDER()	Returns the first repetition of ORDER (a Group object) - creates it if necessary
PPR_PC3_ORDER	getORDER(int rep)	Returns a specific repetition of ORDER (a Group object) - creates it if necessary
List<PPR_PC3_ORDER>	getORDERAll()	Returns a non-modifiable List containing all current existing repetitions of ORDER.
int	getORDERReps()	Returns the number of existing repetitions of ORDER
PPR_PC3_PATHWAY	getPATHWAY()	Returns the first repetition of PATHWAY (a Group object) - creates it if necessary
PPR_PC3_PATHWAY	getPATHWAY(int rep)	Returns a specific repetition of PATHWAY (a Group object) - creates it if necessary
List<PPR_PC3_PATHWAY>	getPATHWAYAll()	Returns a non-modifiable List containing all current existing repetitions of PATHWAY.
int	getPATHWAYReps()	Returns the number of existing repetitions of PATHWAY
PRB	getPRB()	Returns PRB (Problem Detail) - creates it if necessary
PPR_PC3_PROBLEM_OBSERVATION	getPROBLEM_OBSERVATION()	Returns the first repetition of PROBLEM_OBSERVATION (a Group object) - creates it if necessary
PPR_PC3_PROBLEM_OBSERVATION	getPROBLEM_OBSERVATION(int rep)	Returns a specific repetition of PROBLEM_OBSERVATION (a Group object) - creates it if necessary
List<PPR_PC3_PROBLEM_OBSERVATION>	getPROBLEM_OBSERVATIONAll()	Returns a non-modifiable List containing all current existing repetitions of PROBLEM_OBSERVATION.
int	getPROBLEM_OBSERVATIONReps()	Returns the number of existing repetitions of PROBLEM_OBSERVATION
PPR_PC3_PROBLEM_ROLE	getPROBLEM_ROLE()	Returns the first repetition of PROBLEM_ROLE (a Group object) - creates it if necessary
PPR_PC3_PROBLEM_ROLE	getPROBLEM_ROLE(int rep)	Returns a specific repetition of PROBLEM_ROLE (a Group object) - creates it if necessary
List<PPR_PC3_PROBLEM_ROLE>	getPROBLEM_ROLEAll()	Returns a non-modifiable List containing all current existing repetitions of PROBLEM_ROLE.
int	getPROBLEM_ROLEReps()	Returns the number of existing repetitions of PROBLEM_ROLE
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"
PPR_PC3_GOAL	insertGOAL(int rep)	Inserts a specific repetition of GOAL (a Group object)
void	insertGOAL(PPR_PC3_GOAL structure, int rep)	Inserts a specific repetition of GOAL (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)
PPR_PC3_ORDER	insertORDER(int rep)	Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(PPR_PC3_ORDER structure, int rep)	Inserts a specific repetition of ORDER (a Group object)
PPR_PC3_PATHWAY	insertPATHWAY(int rep)	Inserts a specific repetition of PATHWAY (a Group object)
void	insertPATHWAY(PPR_PC3_PATHWAY structure, int rep)	Inserts a specific repetition of PATHWAY (a Group object)
PPR_PC3_PROBLEM_OBSERVATION	insertPROBLEM_OBSERVATION(int rep)	Inserts a specific repetition of PROBLEM_OBSERVATION (a Group object)
void	insertPROBLEM_OBSERVATION(PPR_PC3_PROBLEM_OBSERVATION structure, int rep)	Inserts a specific repetition of PROBLEM_OBSERVATION (a Group object)
PPR_PC3_PROBLEM_ROLE	insertPROBLEM_ROLE(int rep)	Inserts a specific repetition of PROBLEM_ROLE (a Group object)
void	insertPROBLEM_ROLE(PPR_PC3_PROBLEM_ROLE structure, int rep)	Inserts a specific repetition of PROBLEM_ROLE (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)
PPR_PC3_GOAL	removeGOAL(int rep)	Removes a specific repetition of GOAL (a Group object)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and comments segment)
PPR_PC3_ORDER	removeORDER(int rep)	Removes a specific repetition of ORDER (a Group object)
PPR_PC3_PATHWAY	removePATHWAY(int rep)	Removes a specific repetition of PATHWAY (a Group object)
PPR_PC3_PROBLEM_OBSERVATION	removePROBLEM_OBSERVATION(int rep)	Removes a specific repetition of PROBLEM_OBSERVATION (a Group object)
PPR_PC3_PROBLEM_ROLE	removePROBLEM_ROLE(int rep)	Removes a specific repetition of PROBLEM_ROLE (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

PPR_PC3_PROBLEM

public PPR_PC3_PROBLEM(Group parent,
 ModelClassFactory factory)

Creates a new PPR_PC3_PROBLEM group

Method Details

getVersion

public String getVersion()

Returns "2.3"

getPRB

public PRB getPRB()

Returns PRB (Problem 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)

getPROBLEM_ROLE

public PPR_PC3_PROBLEM_ROLE getPROBLEM_ROLE()

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

getPROBLEM_ROLE

public PPR_PC3_PROBLEM_ROLE getPROBLEM_ROLE(int rep)

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

getPROBLEM_ROLEReps

public int getPROBLEM_ROLEReps()

Returns the number of existing repetitions of PROBLEM_ROLE

getPROBLEM_ROLEAll

public List<PPR_PC3_PROBLEM_ROLE> getPROBLEM_ROLEAll()
                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertPROBLEM_ROLE

public void insertPROBLEM_ROLE(PPR_PC3_PROBLEM_ROLE structure,
 int rep)
                        throws HL7Exception

Inserts a specific repetition of PROBLEM_ROLE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPROBLEM_ROLE

public PPR_PC3_PROBLEM_ROLE insertPROBLEM_ROLE(int rep)
                                        throws HL7Exception

Inserts a specific repetition of PROBLEM_ROLE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePROBLEM_ROLE

public PPR_PC3_PROBLEM_ROLE removePROBLEM_ROLE(int rep)
                                        throws HL7Exception

Removes a specific repetition of PROBLEM_ROLE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPATHWAY

public PPR_PC3_PATHWAY getPATHWAY()

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

getPATHWAY

public PPR_PC3_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<PPR_PC3_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(PPR_PC3_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 PPR_PC3_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 PPR_PC3_PATHWAY removePATHWAY(int rep)
                              throws HL7Exception

Removes a specific repetition of PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPROBLEM_OBSERVATION

public PPR_PC3_PROBLEM_OBSERVATION getPROBLEM_OBSERVATION()

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

getPROBLEM_OBSERVATION

public PPR_PC3_PROBLEM_OBSERVATION getPROBLEM_OBSERVATION(int rep)

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

getPROBLEM_OBSERVATIONReps

public int getPROBLEM_OBSERVATIONReps()

Returns the number of existing repetitions of PROBLEM_OBSERVATION

getPROBLEM_OBSERVATIONAll

public List<PPR_PC3_PROBLEM_OBSERVATION> getPROBLEM_OBSERVATIONAll()
                                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertPROBLEM_OBSERVATION

public void insertPROBLEM_OBSERVATION(PPR_PC3_PROBLEM_OBSERVATION structure,
 int rep)
                               throws HL7Exception

Inserts a specific repetition of PROBLEM_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPROBLEM_OBSERVATION

public PPR_PC3_PROBLEM_OBSERVATION insertPROBLEM_OBSERVATION(int rep)
                                                      throws HL7Exception

Inserts a specific repetition of PROBLEM_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePROBLEM_OBSERVATION

public PPR_PC3_PROBLEM_OBSERVATION removePROBLEM_OBSERVATION(int rep)
                                                      throws HL7Exception

Removes a specific repetition of PROBLEM_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getGOAL

public PPR_PC3_GOAL getGOAL()

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

getGOAL

public PPR_PC3_GOAL getGOAL(int rep)

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

getGOALReps

public int getGOALReps()

Returns the number of existing repetitions of GOAL

getGOALAll

public List<PPR_PC3_GOAL> getGOALAll()
                              throws HL7Exception

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

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

Throws:

HL7Exception

insertGOAL

public void insertGOAL(PPR_PC3_GOAL structure,
 int rep)
                throws HL7Exception

Inserts a specific repetition of GOAL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertGOAL

public PPR_PC3_GOAL insertGOAL(int rep)
                        throws HL7Exception

Inserts a specific repetition of GOAL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeGOAL

public PPR_PC3_GOAL removeGOAL(int rep)
                        throws HL7Exception

Removes a specific repetition of GOAL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getORDER

public PPR_PC3_ORDER getORDER()

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

getORDER

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

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)