ca.uhn.hl7v2.model.v21.group

Class ORM_O01_ORDER_DETAIL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v21.group.ORM_O01_ORDER_DETAIL

All Implemented Interfaces:

Group, Structure, Serializable

public class ORM_O01_ORDER_DETAIL
extends AbstractGroup

Represents a ORM_O01_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: OBR (OBSERVATION REQUEST)
• 2: ORO (ORDER OTHER)
• 3: RX1 (PHARMACY ORDER)
• 4: NTE (NOTES AND COMMENTS) optional repeating
• 5: OBX (RESULT) optional repeating
• 6: 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
ORM_O01_ORDER_DETAIL(Group parent, ModelClassFactory factory) Creates a new ORM_O01_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
OBR	getOBR() Returns OBR (OBSERVATION REQUEST) - creates it if necessary
OBX	getOBX() Returns the first repetition of OBX (RESULT) - creates it if necessary
OBX	getOBX(int rep) Returns a specific repetition of OBX (RESULT) - creates it if necessary
List<OBX>	getOBXAll() Returns a non-modifiable List containing all current existing repetitions of OBX.
int	getOBXReps() Returns the number of existing repetitions of OBX
ORO	getORO() Returns ORO (ORDER OTHER) - creates it if necessary
RX1	getRX1() Returns RX1 (PHARMACY ORDER) - creates it if necessary
String	getVersion() Returns "2.1"
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)
OBX	insertOBX(int rep) Inserts a specific repetition of OBX (RESULT)
void	insertOBX(OBX structure, int rep) Inserts a specific repetition of OBX (RESULT)
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)
OBX	removeOBX(int rep) Removes a specific repetition of OBX (RESULT)

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

ORM_O01_ORDER_DETAIL

public ORM_O01_ORDER_DETAIL(Group parent,
                    ModelClassFactory factory)

Creates a new ORM_O01_ORDER_DETAIL group

Method Detail

getVersion

public String getVersion()

Returns "2.1"

getOBR

public OBR getOBR()

Returns OBR (OBSERVATION REQUEST) - creates it if necessary

getORO

public ORO getORO()

Returns ORO (ORDER OTHER) - creates it if necessary

getRX1

public RX1 getRX1()

Returns RX1 (PHARMACY 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)

getOBX

public OBX getOBX()

Returns the first repetition of OBX (RESULT) - creates it if necessary

getOBX

public OBX getOBX(int rep)

Returns a specific repetition of OBX (RESULT) - 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.

getOBXReps

public int getOBXReps()

Returns the number of existing repetitions of OBX

getOBXAll

public List<OBX> getOBXAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertOBX

public void insertOBX(OBX structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of OBX (RESULT)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBX

public OBX insertOBX(int rep)
              throws HL7Exception

Inserts a specific repetition of OBX (RESULT)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBX

public OBX removeOBX(int rep)
              throws HL7Exception

Removes a specific repetition of OBX (RESULT)

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)