Package ca.uhn.hl7v2.model.v24.group

Class RSP_Z82_VISIT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.RSP_Z82_VISIT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RSP_Z82_VISIT
extends AbstractGroup

Represents a RSP_Z82_VISIT 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: AL1 (Patient allergy information) repeating
• 2: RSP_Z82_PATIENT_VISIT (a Group object) optional

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AL1	getAL1()	Returns the first repetition of AL1 (Patient allergy information) - creates it if necessary
AL1	getAL1(int rep)	Returns a specific repetition of AL1 (Patient allergy information) - creates it if necessary
List<AL1>	getAL1All()	Returns a non-modifiable List containing all current existing repetitions of AL1.
int	getAL1Reps()	Returns the number of existing repetitions of AL1
RSP_Z82_PATIENT_VISIT	getPATIENT_VISIT()	Returns PATIENT_VISIT (a Group object) - creates it if necessary
String	getVersion()	Returns "2.4"
AL1	insertAL1(int rep)	Inserts a specific repetition of AL1 (Patient allergy information)
void	insertAL1(AL1 structure, int rep)	Inserts a specific repetition of AL1 (Patient allergy information)
AL1	removeAL1(int rep)	Removes a specific repetition of AL1 (Patient allergy information)

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

RSP_Z82_VISIT

public RSP_Z82_VISIT(Group parent,
 ModelClassFactory factory)

Creates a new RSP_Z82_VISIT group

Method Details

getVersion

public String getVersion()

Returns "2.4"

getAL1

public AL1 getAL1()

Returns the first repetition of AL1 (Patient allergy information) - creates it if necessary

getAL1

public AL1 getAL1(int rep)

Returns a specific repetition of AL1 (Patient allergy information) - 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.

getAL1Reps

public int getAL1Reps()

Returns the number of existing repetitions of AL1

getAL1All

public List<AL1> getAL1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertAL1

public void insertAL1(AL1 structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of AL1 (Patient allergy information)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertAL1

public AL1 insertAL1(int rep)
              throws HL7Exception

Inserts a specific repetition of AL1 (Patient allergy information)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeAL1

public AL1 removeAL1(int rep)
              throws HL7Exception

Removes a specific repetition of AL1 (Patient allergy information)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPATIENT_VISIT

public RSP_Z82_PATIENT_VISIT getPATIENT_VISIT()

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