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

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

All Implemented Interfaces:

Group, Structure, Serializable

public class RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE
extends AbstractGroup

Represents a RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE 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: ORC (ORC - common order segment)
• 2: RDS_O01_RXONTERXRRXCNTE (a Group object) optional
• 3: RDS_O01_RXERXRRXC (a Group object) optional
• 4: RXD (RXD - pharmacy/treatment dispense segment)
• 5: RXR (RXR - pharmacy/treatment route segment) repeating
• 6: RXC (RXC - pharmacy/treatment component order segment) optional repeating
• 7: RDS_O01_OBXNTE (a Group object) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

RDS_O01_OBXNTE	getOBXNTE() Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
RDS_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
ORC	getORC() Returns ORC (ORC - common order segment) - creates it if necessary
RXC	getRXC() Returns the first repetition of RXC (RXC - pharmacy/treatment component order segment) - creates it if necessary
RXC	getRXC(int rep) Returns a specific repetition of RXC (RXC - pharmacy/treatment component order segment) - creates it if necessary
int	getRXCReps() Returns the number of existing repetitions of RXC
RXD	getRXD() Returns RXD (RXD - pharmacy/treatment dispense segment) - creates it if necessary
RDS_O01_RXERXRRXC	getRXERXRRXC() Returns RXERXRRXC (a Group object) - creates it if necessary
RDS_O01_RXONTERXRRXCNTE	getRXONTERXRRXCNTE() Returns RXONTERXRRXCNTE (a Group object) - 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"
RDS_O01_OBXNTE	insertOBXNTE(int rep) Inserts a specific repetition of OBXNTE (a Group object)
void	insertOBXNTE(RDS_O01_OBXNTE structure, int rep) Inserts a specific repetition of OBXNTE (a Group object)
RXC	insertRXC(int rep) Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
void	insertRXC(RXC structure, int rep) Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order 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)
RDS_O01_OBXNTE	removeOBXNTE(int rep) Removes a specific repetition of OBXNTE (a Group object)
RXC	removeRXC(int rep) Removes a specific repetition of RXC (RXC - pharmacy/treatment component order 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

RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE

public RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE(Group parent,
                                                          ModelClassFactory factory)

Creates a new RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getORC

public ORC getORC()

Returns ORC (ORC - common order segment) - creates it if necessary

getRXONTERXRRXCNTE

public RDS_O01_RXONTERXRRXCNTE getRXONTERXRRXCNTE()

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

getRXERXRRXC

public RDS_O01_RXERXRRXC getRXERXRRXC()

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

getRXD

public RXD getRXD()

Returns RXD (RXD - pharmacy/treatment dispense segment) - creates it if necessary

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)

getRXC

public RXC getRXC()

Returns the first repetition of RXC (RXC - pharmacy/treatment component order segment) - creates it if necessary

getRXC

public RXC getRXC(int rep)

Returns a specific repetition of RXC (RXC - pharmacy/treatment component order 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.

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 (RXC - pharmacy/treatment component order segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRXC

public RXC insertRXC(int rep)
              throws HL7Exception

Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRXC

public RXC removeRXC(int rep)
              throws HL7Exception

Removes a specific repetition of RXC (RXC - pharmacy/treatment component order segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getOBXNTE

public RDS_O01_OBXNTE getOBXNTE()

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

getOBXNTE

public RDS_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(RDS_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 RDS_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 RDS_O01_OBXNTE removeOBXNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)