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

Class ORU_R01_ORDER_OBSERVATION

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.ORU_R01_ORDER_OBSERVATION

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORU_R01_ORDER_OBSERVATION
extends AbstractGroup

Represents a ORU_R01_ORDER_OBSERVATION 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) optional
• 2: OBR (Observation Request)
• 3: NTE (Notes and Comments) optional repeating
• 4: CTD (Contact Data) optional
• 5: ORU_R01_OBSERVATION (a Group object) repeating
• 6: FT1 (Financial Transaction) optional repeating
• 7: CTI (Clinical Trial Identification) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CTD	getCTD()	Returns CTD (Contact Data) - creates it if necessary
CTI	getCTI()	Returns the first repetition of CTI (Clinical Trial Identification) - creates it if necessary
CTI	getCTI(int rep)	Returns a specific repetition of CTI (Clinical Trial Identification) - creates it if necessary
List<CTI>	getCTIAll()	Returns a non-modifiable List containing all current existing repetitions of CTI.
int	getCTIReps()	Returns the number of existing repetitions of CTI
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
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
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
ORU_R01_OBSERVATION	getOBSERVATION()	Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
ORU_R01_OBSERVATION	getOBSERVATION(int rep)	Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
List<ORU_R01_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
String	getVersion()	Returns "2.4"
CTI	insertCTI(int rep)	Inserts a specific repetition of CTI (Clinical Trial Identification)
void	insertCTI(CTI structure, int rep)	Inserts a specific repetition of CTI (Clinical Trial Identification)
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)
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)
ORU_R01_OBSERVATION	insertOBSERVATION(int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(ORU_R01_OBSERVATION structure, int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
CTI	removeCTI(int rep)	Removes a specific repetition of CTI (Clinical Trial Identification)
FT1	removeFT1(int rep)	Removes a specific repetition of FT1 (Financial Transaction)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and Comments)
ORU_R01_OBSERVATION	removeOBSERVATION(int rep)	Removes a specific repetition of OBSERVATION (a Group object)

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

ORU_R01_ORDER_OBSERVATION

public ORU_R01_ORDER_OBSERVATION(Group parent,
 ModelClassFactory factory)

Creates a new ORU_R01_ORDER_OBSERVATION group

Method Details

getVersion

public String getVersion()

Returns "2.4"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getOBR

public OBR getOBR()

Returns OBR (Observation Request) - 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)

getCTD

public CTD getCTD()

Returns CTD (Contact Data) - creates it if necessary

getOBSERVATION

public ORU_R01_OBSERVATION getOBSERVATION()

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

getOBSERVATION

public ORU_R01_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<ORU_R01_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(ORU_R01_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 ORU_R01_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 ORU_R01_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)

getCTI

public CTI getCTI()

Returns the first repetition of CTI (Clinical Trial Identification) - creates it if necessary

getCTI

public CTI getCTI(int rep)

Returns a specific repetition of CTI (Clinical Trial Identification) - 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.

getCTIReps

public int getCTIReps()

Returns the number of existing repetitions of CTI

getCTIAll

public List<CTI> getCTIAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertCTI

public void insertCTI(CTI structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of CTI (Clinical Trial Identification)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertCTI

public CTI insertCTI(int rep)
              throws HL7Exception

Inserts a specific repetition of CTI (Clinical Trial Identification)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeCTI

public CTI removeCTI(int rep)
              throws HL7Exception

Removes a specific repetition of CTI (Clinical Trial Identification)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)