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

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

All Implemented Interfaces:

Group, Structure, Serializable

public class RGV_O15_GIVE
extends AbstractGroup

Represents a RGV_O15_GIVE 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: RXG (Pharmacy/Treatment Give)
• 2: RXR (Pharmacy/Treatment Route) repeating
• 3: RXC (Pharmacy/Treatment Component Order) optional repeating
• 4: RGV_O15_OBSERVATION (a Group object) repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

RGV_O15_OBSERVATION	getOBSERVATION() Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
RGV_O15_OBSERVATION	getOBSERVATION(int rep) Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
int	getOBSERVATIONReps() Returns the number of existing repetitions of OBSERVATION
RXC	getRXC() Returns the first repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
RXC	getRXC(int rep) Returns a specific repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary
int	getRXCReps() Returns the number of existing repetitions of RXC
RXG	getRXG() Returns RXG (Pharmacy/Treatment Give) - creates it if necessary
RXR	getRXR() Returns the first repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
RXR	getRXR(int rep) Returns a specific repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary
int	getRXRReps() Returns the number of existing repetitions of RXR
String	getVersion() Returns "2.4"
RGV_O15_OBSERVATION	insertOBSERVATION(int rep) Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(RGV_O15_OBSERVATION structure, int rep) Inserts a specific repetition of OBSERVATION (a Group object)
RXC	insertRXC(int rep) Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
void	insertRXC(RXC structure, int rep) Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
RXR	insertRXR(int rep) Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
void	insertRXR(RXR structure, int rep) Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
RGV_O15_OBSERVATION	removeOBSERVATION(int rep) Removes a specific repetition of OBSERVATION (a Group object)
RXC	removeRXC(int rep) Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
RXR	removeRXR(int rep) Removes a specific repetition of RXR (Pharmacy/Treatment Route)

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_O15_GIVE

public RGV_O15_GIVE(Group parent,
                    ModelClassFactory factory)

Creates a new RGV_O15_GIVE group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getRXG

public RXG getRXG()

Returns RXG (Pharmacy/Treatment Give) - creates it if necessary

getRXR

public RXR getRXR()

Returns the first repetition of RXR (Pharmacy/Treatment Route) - creates it if necessary

getRXR

public RXR getRXR(int rep)

Returns a specific repetition of RXR (Pharmacy/Treatment Route) - 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.

getRXRReps

public int getRXRReps()

Returns the number of existing repetitions of RXR

insertRXR

public void insertRXR(RXR structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of RXR (Pharmacy/Treatment Route)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRXR

public RXR insertRXR(int rep)
              throws HL7Exception

Inserts a specific repetition of RXR (Pharmacy/Treatment Route)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRXR

public RXR removeRXR(int rep)
              throws HL7Exception

Removes a specific repetition of RXR (Pharmacy/Treatment Route)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getRXC

public RXC getRXC()

Returns the first repetition of RXC (Pharmacy/Treatment Component Order) - creates it if necessary

getRXC

public RXC getRXC(int rep)

Returns a specific repetition of RXC (Pharmacy/Treatment Component Order) - 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.

getRXCReps

public int getRXCReps()

Returns the number of existing repetitions of RXC

insertRXC

public void insertRXC(RXC structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRXC

public RXC insertRXC(int rep)
              throws HL7Exception

Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRXC

public RXC removeRXC(int rep)
              throws HL7Exception

Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getOBSERVATION

public RGV_O15_OBSERVATION getOBSERVATION()

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

getOBSERVATION

public RGV_O15_OBSERVATION getOBSERVATION(int rep)

Returns a specific repetition of OBSERVATION (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.

getOBSERVATIONReps

public int getOBSERVATIONReps()

Returns the number of existing repetitions of OBSERVATION

insertOBSERVATION

public void insertOBSERVATION(RGV_O15_OBSERVATION structure,
                              int rep)
                       throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBSERVATION

public RGV_O15_OBSERVATION insertOBSERVATION(int rep)
                                      throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBSERVATION

public RGV_O15_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)