ca.uhn.hl7v2.model.v24.group

Class ORP_O10_ORDER_DETAIL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.ORP_O10_ORDER_DETAIL

All Implemented Interfaces:

Group, Structure, Serializable

public class ORP_O10_ORDER_DETAIL
extends AbstractGroup

Represents a ORP_O10_ORDER_DETAIL 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 (Pharmacy/Treatment Order)
• 2: NTE (Notes and Comments) optional repeating
• 3: RXR (Pharmacy/Treatment Route) repeating
• 4: RXC (Pharmacy/Treatment Component Order) optional repeating
• 5: NTE (Notes and Comments) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE2() Returns the first repetition of NTE2 (Notes and Comments) - creates it if necessary
NTE	getNTE2(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTE2All() Returns a non-modifiable List containing all current existing repetitions of NTE2.
int	getNTE2Reps() Returns the number of existing repetitions of NTE2
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
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
RXO	getRXO() Returns RXO (Pharmacy/Treatment Order) - 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"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
NTE	insertNTE2(int rep) Inserts a specific repetition of NTE2 (Notes and Comments)
void	insertNTE2(NTE structure, int rep) Inserts a specific repetition of NTE2 (Notes and Comments)
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)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
NTE	removeNTE2(int rep) Removes a specific repetition of NTE2 (Notes and Comments)
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, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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 Detail

ORP_O10_ORDER_DETAIL

public ORP_O10_ORDER_DETAIL(Group parent,
                    ModelClassFactory factory)

Creates a new ORP_O10_ORDER_DETAIL group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getRXO

public RXO getRXO()

Returns RXO (Pharmacy/Treatment Order) - creates it if necessary

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

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)

getNTE2

public NTE getNTE2()

Returns the first repetition of NTE2 (Notes and Comments) - creates it if necessary

getNTE2

public NTE getNTE2(int rep)

Returns a specific repetition of NTE (Notes and Comments) - 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.

getNTE2Reps

public int getNTE2Reps()

Returns the number of existing repetitions of NTE2

getNTE2All

public List<NTE> getNTE2All()
                     throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE2

public void insertNTE2(NTE structure,
              int rep)
                throws HL7Exception

Inserts a specific repetition of NTE2 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE2

public NTE insertNTE2(int rep)
               throws HL7Exception

Inserts a specific repetition of NTE2 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE2

public NTE removeNTE2(int rep)
               throws HL7Exception

Removes a specific repetition of NTE2 (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)