ca.uhn.hl7v2.model.v281.group

Class VXU_V04_PATIENT_VISIT

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.VXU_V04_PATIENT_VISIT

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class VXU_V04_PATIENT_VISIT
extends AbstractGroup

Represents a VXU_V04_PATIENT_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: PV1 (Patient Visit)
• 2: PV2 (Patient Visit - Additional Information) optional
• 3: ARV (Access Restriction) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ARV	getARV() Returns the first repetition of ARV (Access Restriction) - creates it if necessary
ARV	getARV(int rep) Returns a specific repetition of ARV (Access Restriction) - creates it if necessary
List<ARV>	getARVAll() Returns a non-modifiable List containing all current existing repetitions of ARV.
int	getARVReps() Returns the number of existing repetitions of ARV
PV1	getPV1() Returns PV1 (Patient Visit) - creates it if necessary
PV2	getPV2() Returns PV2 (Patient Visit - Additional Information) - creates it if necessary
String	getVersion() Returns "2.8.1"
void	insertARV(ARV structure, int rep) Inserts a specific repetition of ARV (Access Restriction)
ARV	insertARV(int rep) Inserts a specific repetition of ARV (Access Restriction)
ARV	removeARV(int rep) Removes a specific repetition of ARV (Access Restriction)

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

VXU_V04_PATIENT_VISIT

public VXU_V04_PATIENT_VISIT(Group parent,
                             ModelClassFactory factory)

Creates a new VXU_V04_PATIENT_VISIT group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getPV1

public PV1 getPV1()

Returns PV1 (Patient Visit) - creates it if necessary

getPV2

public PV2 getPV2()

Returns PV2 (Patient Visit - Additional Information) - creates it if necessary

getARV

public ARV getARV()

Returns the first repetition of ARV (Access Restriction) - creates it if necessary

getARV

public ARV getARV(int rep)

Returns a specific repetition of ARV (Access Restriction) - 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.

getARVReps

public int getARVReps()

Returns the number of existing repetitions of ARV

getARVAll

public List<ARV> getARVAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertARV

public void insertARV(ARV structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of ARV (Access Restriction)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertARV

public ARV insertARV(int rep)
              throws HL7Exception

Inserts a specific repetition of ARV (Access Restriction)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeARV

public ARV removeARV(int rep)
              throws HL7Exception

Removes a specific repetition of ARV (Access Restriction)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)