ca.uhn.hl7v2.model.v24.group
Class VXX_V02_PATIENT

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v24.group.VXX_V02_PATIENT

All Implemented Interfaces:

Group, Structure, Serializable

public class VXX_V02_PATIENT
extends AbstractGroup

Represents a VXX_V02_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: NK1 (Next of kin / associated parties) optional repeating

See Also:

Serialized Form

Constructor Summary

VXX_V02_PATIENT(Group parent, ModelClassFactory factory)
Creates a new VXX_V02_PATIENT group

Method Summary

NK1	getNK1() Returns the first repetition of NK1 (Next of kin / associated parties) - creates it if necessary
NK1	getNK1(int rep) Returns a specific repetition of NK1 (Next of kin / associated parties) - creates it if necessary
int	getNK1Reps() Returns the number of existing repetitions of NK1
PID	getPID() Returns PID (Patient identification) - creates it if necessary
String	getVersion() Returns "2.4"
NK1	insertNK1(int rep) Inserts a specific repetition of NK1 (Next of kin / associated parties)
void	insertNK1(NK1 structure, int rep) Inserts a specific repetition of NK1 (Next of kin / associated parties)
NK1	removeNK1(int rep) Removes a specific repetition of NK1 (Next of kin / associated parties)

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getClass, getMessage, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VXX_V02_PATIENT

public VXX_V02_PATIENT(Group parent,
                       ModelClassFactory factory)

Creates a new VXX_V02_PATIENT group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getPID

public PID getPID()

Returns PID (Patient identification) - creates it if necessary

getNK1

public NK1 getNK1()

Returns the first repetition of NK1 (Next of kin / associated parties) - creates it if necessary

getNK1

public NK1 getNK1(int rep)

Returns a specific repetition of NK1 (Next of kin / associated parties) - 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.

getNK1Reps

public int getNK1Reps()

Returns the number of existing repetitions of NK1

insertNK1

public void insertNK1(NK1 structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of NK1 (Next of kin / associated parties)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNK1

public NK1 insertNK1(int rep)
              throws HL7Exception

Inserts a specific repetition of NK1 (Next of kin / associated parties)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNK1

public NK1 removeNK1(int rep)
              throws HL7Exception

Removes a specific repetition of NK1 (Next of kin / associated parties)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)