ca.uhn.hl7v2.model.v26.group

Class PPV_PCA_PATIENT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v26.group.PPV_PCA_PATIENT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class PPV_PCA_PATIENT
extends AbstractGroup

Represents a PPV_PCA_PATIENT 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: PID (Patient Identification)
• 2: PPV_PCA_PATIENT_VISIT (a Group object) optional
• 3: PPV_PCA_GOAL (a Group object) repeating

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
PPV_PCA_PATIENT(Group parent, ModelClassFactory factory) Creates a new PPV_PCA_PATIENT group

Method Summary

Modifier and Type	Method and Description
PPV_PCA_GOAL	getGOAL() Returns the first repetition of GOAL (a Group object) - creates it if necessary
PPV_PCA_GOAL	getGOAL(int rep) Returns a specific repetition of GOAL (a Group object) - creates it if necessary
List<PPV_PCA_GOAL>	getGOALAll() Returns a non-modifiable List containing all current existing repetitions of GOAL.
int	getGOALReps() Returns the number of existing repetitions of GOAL
PPV_PCA_PATIENT_VISIT	getPATIENT_VISIT() Returns PATIENT_VISIT (a Group object) - creates it if necessary
PID	getPID() Returns PID (Patient Identification) - creates it if necessary
String	getVersion() Returns "2.6"
PPV_PCA_GOAL	insertGOAL(int rep) Inserts a specific repetition of GOAL (a Group object)
void	insertGOAL(PPV_PCA_GOAL structure, int rep) Inserts a specific repetition of GOAL (a Group object)
PPV_PCA_GOAL	removeGOAL(int rep) Removes a specific repetition of GOAL (a Group object)

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

PPV_PCA_PATIENT

public PPV_PCA_PATIENT(Group parent,
                       ModelClassFactory factory)

Creates a new PPV_PCA_PATIENT group

Method Detail

getVersion

public String getVersion()

Returns "2.6"

getPID

public PID getPID()

Returns PID (Patient Identification) - creates it if necessary

getPATIENT_VISIT

public PPV_PCA_PATIENT_VISIT getPATIENT_VISIT()

Returns PATIENT_VISIT (a Group object) - creates it if necessary

getGOAL

public PPV_PCA_GOAL getGOAL()

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

getGOAL

public PPV_PCA_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<PPV_PCA_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(PPV_PCA_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 PPV_PCA_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 PPV_PCA_GOAL removeGOAL(int rep)
                        throws HL7Exception

Removes a specific repetition of GOAL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)