ca.uhn.hl7v2.model.v281.group

Class CCU_I20_PATHWAY

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.CCU_I20_PATHWAY

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class CCU_I20_PATHWAY
extends AbstractGroup

Represents a CCU_I20_PATHWAY 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: PTH (Pathway)
• 2: VAR (Variance) optional repeating
• 3: CCU_I20_ROLE_PATHWAY (a Group object) optional repeating
• 4: CCU_I20_PATHWAY_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
CCU_I20_PATHWAY(Group parent, ModelClassFactory factory) Creates a new CCU_I20_PATHWAY group

Method Summary

Modifier and Type	Method and Description
CCU_I20_PATHWAY_OBSERVATION	getPATHWAY_OBSERVATION() Returns the first repetition of PATHWAY_OBSERVATION (a Group object) - creates it if necessary
CCU_I20_PATHWAY_OBSERVATION	getPATHWAY_OBSERVATION(int rep) Returns a specific repetition of PATHWAY_OBSERVATION (a Group object) - creates it if necessary
List<CCU_I20_PATHWAY_OBSERVATION>	getPATHWAY_OBSERVATIONAll() Returns a non-modifiable List containing all current existing repetitions of PATHWAY_OBSERVATION.
int	getPATHWAY_OBSERVATIONReps() Returns the number of existing repetitions of PATHWAY_OBSERVATION
PTH	getPTH() Returns PTH (Pathway) - creates it if necessary
CCU_I20_ROLE_PATHWAY	getROLE_PATHWAY() Returns the first repetition of ROLE_PATHWAY (a Group object) - creates it if necessary
CCU_I20_ROLE_PATHWAY	getROLE_PATHWAY(int rep) Returns a specific repetition of ROLE_PATHWAY (a Group object) - creates it if necessary
List<CCU_I20_ROLE_PATHWAY>	getROLE_PATHWAYAll() Returns a non-modifiable List containing all current existing repetitions of ROLE_PATHWAY.
int	getROLE_PATHWAYReps() Returns the number of existing repetitions of ROLE_PATHWAY
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	insertPATHWAY_OBSERVATION(CCU_I20_PATHWAY_OBSERVATION structure, int rep) Inserts a specific repetition of PATHWAY_OBSERVATION (a Group object)
CCU_I20_PATHWAY_OBSERVATION	insertPATHWAY_OBSERVATION(int rep) Inserts a specific repetition of PATHWAY_OBSERVATION (a Group object)
void	insertROLE_PATHWAY(CCU_I20_ROLE_PATHWAY structure, int rep) Inserts a specific repetition of ROLE_PATHWAY (a Group object)
CCU_I20_ROLE_PATHWAY	insertROLE_PATHWAY(int rep) Inserts a specific repetition of ROLE_PATHWAY (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)
CCU_I20_PATHWAY_OBSERVATION	removePATHWAY_OBSERVATION(int rep) Removes a specific repetition of PATHWAY_OBSERVATION (a Group object)
CCU_I20_ROLE_PATHWAY	removeROLE_PATHWAY(int rep) Removes a specific repetition of ROLE_PATHWAY (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

CCU_I20_PATHWAY

public CCU_I20_PATHWAY(Group parent,
                       ModelClassFactory factory)

Creates a new CCU_I20_PATHWAY group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getPTH

public PTH getPTH()

Returns PTH (Pathway) - 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_PATHWAY

public CCU_I20_ROLE_PATHWAY getROLE_PATHWAY()

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

getROLE_PATHWAY

public CCU_I20_ROLE_PATHWAY getROLE_PATHWAY(int rep)

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

getROLE_PATHWAYReps

public int getROLE_PATHWAYReps()

Returns the number of existing repetitions of ROLE_PATHWAY

getROLE_PATHWAYAll

public List<CCU_I20_ROLE_PATHWAY> getROLE_PATHWAYAll()
                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertROLE_PATHWAY

public void insertROLE_PATHWAY(CCU_I20_ROLE_PATHWAY structure,
                               int rep)
                        throws HL7Exception

Inserts a specific repetition of ROLE_PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertROLE_PATHWAY

public CCU_I20_ROLE_PATHWAY insertROLE_PATHWAY(int rep)
                                        throws HL7Exception

Inserts a specific repetition of ROLE_PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeROLE_PATHWAY

public CCU_I20_ROLE_PATHWAY removeROLE_PATHWAY(int rep)
                                        throws HL7Exception

Removes a specific repetition of ROLE_PATHWAY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPATHWAY_OBSERVATION

public CCU_I20_PATHWAY_OBSERVATION getPATHWAY_OBSERVATION()

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

getPATHWAY_OBSERVATION

public CCU_I20_PATHWAY_OBSERVATION getPATHWAY_OBSERVATION(int rep)

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

getPATHWAY_OBSERVATIONReps

public int getPATHWAY_OBSERVATIONReps()

Returns the number of existing repetitions of PATHWAY_OBSERVATION

getPATHWAY_OBSERVATIONAll

public List<CCU_I20_PATHWAY_OBSERVATION> getPATHWAY_OBSERVATIONAll()
                                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertPATHWAY_OBSERVATION

public void insertPATHWAY_OBSERVATION(CCU_I20_PATHWAY_OBSERVATION structure,
                                      int rep)
                               throws HL7Exception

Inserts a specific repetition of PATHWAY_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPATHWAY_OBSERVATION

public CCU_I20_PATHWAY_OBSERVATION insertPATHWAY_OBSERVATION(int rep)
                                                      throws HL7Exception

Inserts a specific repetition of PATHWAY_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePATHWAY_OBSERVATION

public CCU_I20_PATHWAY_OBSERVATION removePATHWAY_OBSERVATION(int rep)
                                                      throws HL7Exception

Removes a specific repetition of PATHWAY_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)