ca.uhn.hl7v2.model.v251.group

Class PPT_PCL_PROBLEM

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.PPT_PCL_PROBLEM

All Implemented Interfaces:

Group, Structure, Serializable

public class PPT_PCL_PROBLEM
extends AbstractGroup

Represents a PPT_PCL_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 Details)
• 2: NTE (Notes and Comments) optional repeating
• 3: VAR (Variance) optional repeating
• 4: PPT_PCL_PROBLEM_ROLE (a Group object) optional repeating
• 5: PPT_PCL_PROBLEM_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
PPT_PCL_PROBLEM(Group parent, ModelClassFactory factory) Creates a new PPT_PCL_PROBLEM group

Method Summary

Methods

Modifier and Type	Method and Description
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
PRB	getPRB() Returns PRB (Problem Details) - creates it if necessary
PPT_PCL_PROBLEM_OBSERVATION	getPROBLEM_OBSERVATION() Returns the first repetition of PROBLEM_OBSERVATION (a Group object) - creates it if necessary
PPT_PCL_PROBLEM_OBSERVATION	getPROBLEM_OBSERVATION(int rep) Returns a specific repetition of PROBLEM_OBSERVATION (a Group object) - creates it if necessary
List<PPT_PCL_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
PPT_PCL_PROBLEM_ROLE	getPROBLEM_ROLE() Returns the first repetition of PROBLEM_ROLE (a Group object) - creates it if necessary
PPT_PCL_PROBLEM_ROLE	getPROBLEM_ROLE(int rep) Returns a specific repetition of PROBLEM_ROLE (a Group object) - creates it if necessary
List<PPT_PCL_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.5.1"
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)
PPT_PCL_PROBLEM_OBSERVATION	insertPROBLEM_OBSERVATION(int rep) Inserts a specific repetition of PROBLEM_OBSERVATION (a Group object)
void	insertPROBLEM_OBSERVATION(PPT_PCL_PROBLEM_OBSERVATION structure, int rep) Inserts a specific repetition of PROBLEM_OBSERVATION (a Group object)
PPT_PCL_PROBLEM_ROLE	insertPROBLEM_ROLE(int rep) Inserts a specific repetition of PROBLEM_ROLE (a Group object)
void	insertPROBLEM_ROLE(PPT_PCL_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)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
PPT_PCL_PROBLEM_OBSERVATION	removePROBLEM_OBSERVATION(int rep) Removes a specific repetition of PROBLEM_OBSERVATION (a Group object)
PPT_PCL_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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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

PPT_PCL_PROBLEM

public PPT_PCL_PROBLEM(Group parent,
               ModelClassFactory factory)

Creates a new PPT_PCL_PROBLEM group

Method Detail

getVersion

public String getVersion()

Returns "2.5.1"

getPRB

public PRB getPRB()

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

getPROBLEM_ROLE

public PPT_PCL_PROBLEM_ROLE getPROBLEM_ROLE()

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

getPROBLEM_ROLE

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

getPROBLEM_OBSERVATION

public PPT_PCL_PROBLEM_OBSERVATION getPROBLEM_OBSERVATION()

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

getPROBLEM_OBSERVATION

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