ca.uhn.hl7v2.model.v231.group
Class RGV_O01_PIDNTEAL1PV1PV2

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v231.group.RGV_O01_PIDNTEAL1PV1PV2

All Implemented Interfaces:

Group, Structure, Serializable

public class RGV_O01_PIDNTEAL1PV1PV2
extends AbstractGroup

Represents a RGV_O01_PIDNTEAL1PV1PV2 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 (PID - patient identification segment)
• 2: NTE (NTE - notes and comments segment) optional repeating
• 3: AL1 (AL1 - patient allergy information segment) optional repeating
• 4: RGV_O01_PV1PV2 (a Group object) optional

See Also:

Serialized Form

Constructor Summary

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

Method Summary

AL1	getAL1() Returns the first repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
AL1	getAL1(int rep) Returns a specific repetition of AL1 (AL1 - patient allergy information segment) - creates it if necessary
int	getAL1Reps() Returns the number of existing repetitions of AL1
NTE	getNTE() Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - creates it if necessary
int	getNTEReps() Returns the number of existing repetitions of NTE
PID	getPID() Returns PID (PID - patient identification segment) - creates it if necessary
RGV_O01_PV1PV2	getPV1PV2() Returns PV1PV2 (a Group object) - creates it if necessary
String	getVersion() Returns "2.3.1"
void	insertAL1(AL1 structure, int rep) Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
AL1	insertAL1(int rep) Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
AL1	removeAL1(int rep) Removes a specific repetition of AL1 (AL1 - patient allergy information segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)

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

RGV_O01_PIDNTEAL1PV1PV2

public RGV_O01_PIDNTEAL1PV1PV2(Group parent,
                               ModelClassFactory factory)

Creates a new RGV_O01_PIDNTEAL1PV1PV2 group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getPID

public PID getPID()

Returns PID (PID - patient identification segment) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (NTE - notes and comments segment) - 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

insertNTE

public void insertNTE(NTE structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getAL1

public AL1 getAL1()

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

getAL1

public AL1 getAL1(int rep)

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

insertAL1

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

Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertAL1

public AL1 insertAL1(int rep)
              throws HL7Exception

Inserts a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeAL1

public AL1 removeAL1(int rep)
              throws HL7Exception

Removes a specific repetition of AL1 (AL1 - patient allergy information segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPV1PV2

public RGV_O01_PV1PV2 getPV1PV2()

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