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

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

All Implemented Interfaces:

Group, Structure, Serializable

public class RDO_O01_RXONTERXRRXCNTEOBXNTE
extends AbstractGroup

Represents a RDO_O01_RXONTERXRRXCNTEOBXNTE 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: RDO_O01_RXCNTE (a Group object) optional
• 5: RDO_O01_OBXNTE (a Group object) optional repeating

See Also:

Serialized Form

Constructor Summary

RDO_O01_RXONTERXRRXCNTEOBXNTE(Group parent, ModelClassFactory factory)
Creates a new RDO_O01_RXONTERXRRXCNTEOBXNTE 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
RDO_O01_OBXNTE	getOBXNTE() Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
RDO_O01_OBXNTE	getOBXNTE(int rep) Returns a specific repetition of OBXNTE (a Group object) - creates it if necessary
int	getOBXNTEReps() Returns the number of existing repetitions of OBXNTE
RDO_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)
RDO_O01_OBXNTE	insertOBXNTE(int rep) Inserts a specific repetition of OBXNTE (a Group object)
void	insertOBXNTE(RDO_O01_OBXNTE structure, int rep) Inserts a specific repetition of OBXNTE (a Group object)
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)
RDO_O01_OBXNTE	removeOBXNTE(int rep) Removes a specific repetition of OBXNTE (a Group object)
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

RDO_O01_RXONTERXRRXCNTEOBXNTE

public RDO_O01_RXONTERXRRXCNTEOBXNTE(Group parent,
                                     ModelClassFactory factory)

Creates a new RDO_O01_RXONTERXRRXCNTEOBXNTE 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 RDO_O01_RXCNTE getRXCNTE()

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

getOBXNTE

public RDO_O01_OBXNTE getOBXNTE()

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

getOBXNTE

public RDO_O01_OBXNTE getOBXNTE(int rep)

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

getOBXNTEReps

public int getOBXNTEReps()

Returns the number of existing repetitions of OBXNTE

insertOBXNTE

public void insertOBXNTE(RDO_O01_OBXNTE structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBXNTE

public RDO_O01_OBXNTE insertOBXNTE(int rep)
                            throws HL7Exception

Inserts a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBXNTE

public RDO_O01_OBXNTE removeOBXNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)