Package ca.uhn.hl7v2.model.v24.group

Class RDS_O13_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.RDS_O13_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RDS_O13_ORDER
extends AbstractGroup

Represents a RDS_O13_ORDER 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 (Common Order)
• 2: RDS_O13_ORDER_DETAIL (a Group object) optional
• 3: RDS_O13_ENCODING (a Group object) optional
• 4: RXD (Pharmacy/Treatment Dispense)
• 5: RXR (Pharmacy/Treatment Route) repeating
• 6: RXC (Pharmacy/Treatment Component Order) optional repeating
• 7: RDS_O13_OBSERVATION (a Group object) optional repeating
• 8: FT1 (Financial Transaction) optional repeating

See Also:

• Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor	Description
RDS_O13_ORDER(Group parent, ModelClassFactory factory)	Creates a new RDS_O13_ORDER group

Method Summary

Modifier and Type	Method	Description
RDS_O13_ENCODING	getENCODING()	Returns ENCODING (a Group object) - creates it if necessary
FT1	getFT1()	Returns the first repetition of FT1 (Financial Transaction) - creates it if necessary
FT1	getFT1(int rep)	Returns a specific repetition of FT1 (Financial Transaction) - creates it if necessary
List<FT1>	getFT1All()	Returns a non-modifiable List containing all current existing repetitions of FT1.
int	getFT1Reps()	Returns the number of existing repetitions of FT1
RDS_O13_OBSERVATION	getOBSERVATION()	Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
RDS_O13_OBSERVATION	getOBSERVATION(int rep)	Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
List<RDS_O13_OBSERVATION>	getOBSERVATIONAll()	Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
int	getOBSERVATIONReps()	Returns the number of existing repetitions of OBSERVATION
ORC	getORC()	Returns ORC (Common Order) - creates it if necessary
RDS_O13_ORDER_DETAIL	getORDER_DETAIL()	Returns ORDER_DETAIL (a Group object) - creates it if necessary
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
List<RXC>	getRXCAll()	Returns a non-modifiable List containing all current existing repetitions of RXC.
int	getRXCReps()	Returns the number of existing repetitions of RXC
RXD	getRXD()	Returns RXD (Pharmacy/Treatment Dispense) - 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
List<RXR>	getRXRAll()	Returns a non-modifiable List containing all current existing repetitions of RXR.
int	getRXRReps()	Returns the number of existing repetitions of RXR
String	getVersion()	Returns "2.4"
FT1	insertFT1(int rep)	Inserts a specific repetition of FT1 (Financial Transaction)
void	insertFT1(FT1 structure, int rep)	Inserts a specific repetition of FT1 (Financial Transaction)
RDS_O13_OBSERVATION	insertOBSERVATION(int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(RDS_O13_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)
FT1	removeFT1(int rep)	Removes a specific repetition of FT1 (Financial Transaction)
RDS_O13_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

accept, add, add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insert, insertRepetition, insertRepetition, isChoiceElement, isEmpty, isGroup, isRepeating, isRequired, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Details

RDS_O13_ORDER

public RDS_O13_ORDER(Group parent,
 ModelClassFactory factory)

Creates a new RDS_O13_ORDER group

Method Details

getVersion

public String getVersion()

Returns "2.4"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getORDER_DETAIL

public RDS_O13_ORDER_DETAIL getORDER_DETAIL()

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

getENCODING

public RDS_O13_ENCODING getENCODING()

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

getRXD

public RXD getRXD()

Returns RXD (Pharmacy/Treatment Dispense) - 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

getRXRAll

public List<RXR> getRXRAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of RXR.

Note that unlike getRXR(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

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

getRXCAll

public List<RXC> getRXCAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of RXC.

Note that unlike getRXC(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

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 RDS_O13_OBSERVATION getOBSERVATION()

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

getOBSERVATION

public RDS_O13_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

getOBSERVATIONAll

public List<RDS_O13_OBSERVATION> getOBSERVATIONAll()
                                            throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.

Note that unlike getOBSERVATION(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertOBSERVATION

public void insertOBSERVATION(RDS_O13_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 RDS_O13_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 RDS_O13_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getFT1

public FT1 getFT1()

Returns the first repetition of FT1 (Financial Transaction) - creates it if necessary

getFT1

public FT1 getFT1(int rep)

Returns a specific repetition of FT1 (Financial Transaction) - 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.

getFT1Reps

public int getFT1Reps()

Returns the number of existing repetitions of FT1

getFT1All

public List<FT1> getFT1All()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of FT1.

Note that unlike getFT1(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertFT1

public void insertFT1(FT1 structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of FT1 (Financial Transaction)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertFT1

public FT1 insertFT1(int rep)
              throws HL7Exception

Inserts a specific repetition of FT1 (Financial Transaction)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeFT1

public FT1 removeFT1(int rep)
              throws HL7Exception

Removes a specific repetition of FT1 (Financial Transaction)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)