Package ca.uhn.hl7v2.model.v23.group

Class ORN_O02_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.ORN_O02_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORN_O02_ORDER
extends AbstractGroup

Represents a ORN_O02_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 segment)
• 2: RQD (Requisition detail)
• 3: RQ1 (Requisition detail-1 segment) optional
• 4: NTE (Notes and comments segment) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
NTE	getNTE()	Returns the first repetition of NTE (Notes and comments segment) - creates it if necessary
NTE	getNTE(int rep)	Returns a specific repetition of NTE (Notes and comments segment) - creates it if necessary
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
ORC	getORC()	Returns ORC (Common order segment) - creates it if necessary
RQ1	getRQ1()	Returns RQ1 (Requisition detail-1 segment) - creates it if necessary
RQD	getRQD()	Returns RQD (Requisition detail) - creates it if necessary
String	getVersion()	Returns "2.3"
NTE	insertNTE(int rep)	Inserts a specific repetition of NTE (Notes and comments segment)
void	insertNTE(NTE structure, int rep)	Inserts a specific repetition of NTE (Notes and comments segment)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and comments segment)

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

ORN_O02_ORDER

public ORN_O02_ORDER(Group parent,
 ModelClassFactory factory)

Creates a new ORN_O02_ORDER group

Method Details

getVersion

public String getVersion()

Returns "2.3"

getORC

public ORC getORC()

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

getRQD

public RQD getRQD()

Returns RQD (Requisition detail) - creates it if necessary

getRQ1

public RQ1 getRQ1()

Returns RQ1 (Requisition detail-1 segment) - creates it if necessary

getNTE

public NTE getNTE()

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

getNTE

public NTE getNTE(int rep)

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

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 segment)

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 segment)

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 segment)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)