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

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

All Implemented Interfaces:

Group, Structure, Serializable

public class RDE_O01_RXONTERXRRXCNTE
extends AbstractGroup

Represents a RDE_O01_RXONTERXRRXCNTE 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: RXO (RXO - pharmacy/treatment order segment)
• 2: NTE (NTE - notes and comments segment) optional repeating
• 3: RXR (RXR - pharmacy/treatment route segment) repeating
• 4: RDE_O01_RXCNTE (a Group object) optional

See Also:

Serialized Form

Constructor Summary

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

Method Summary

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
RDE_O01_RXCNTE	getRXCNTE() Returns RXCNTE (a Group object) - creates it if necessary
RXO	getRXO() Returns RXO (RXO - pharmacy/treatment order segment) - creates it if necessary
RXR	getRXR() Returns the first repetition of RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
RXR	getRXR(int rep) Returns a specific repetition of RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
int	getRXRReps() Returns the number of existing repetitions of RXR
String	getVersion() Returns "2.3.1"
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)
RXR	insertRXR(int rep) Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
void	insertRXR(RXR structure, int rep) Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
RXR	removeRXR(int rep) Removes a specific repetition of RXR (RXR - pharmacy/treatment route 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

RDE_O01_RXONTERXRRXCNTE

public RDE_O01_RXONTERXRRXCNTE(Group parent,
                               ModelClassFactory factory)

Creates a new RDE_O01_RXONTERXRRXCNTE group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getRXO

public RXO getRXO()

Returns RXO (RXO - pharmacy/treatment order 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)

getRXR

public RXR getRXR()

Returns the first repetition of RXR (RXR - pharmacy/treatment route segment) - creates it if necessary

getRXR

public RXR getRXR(int rep)

Returns a specific repetition of RXR (RXR - pharmacy/treatment route 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.

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 (RXR - pharmacy/treatment route segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRXR

public RXR insertRXR(int rep)
              throws HL7Exception

Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRXR

public RXR removeRXR(int rep)
              throws HL7Exception

Removes a specific repetition of RXR (RXR - pharmacy/treatment route segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getRXCNTE

public RDE_O01_RXCNTE getRXCNTE()

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