ca.uhn.hl7v2.model.v25.group

Class ORF_R04_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v25.group.ORF_R04_ORDER

All Implemented Interfaces:

Group, Structure, Serializable

public class ORF_R04_ORDER
extends AbstractGroup

Represents a ORF_R04_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) optional
• 2: OBR (Observation Request)
• 3: NTE (Notes and Comments) optional repeating
• 4: ORF_R04_TIMING_QTY (a Group object) optional repeating
• 5: CTD (Contact Data) optional
• 6: ORF_R04_OBSERVATION (a Group object) 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 and Description
ORF_R04_ORDER(Group parent, ModelClassFactory factory) Creates a new ORF_R04_ORDER group

Method Summary

Methods

Modifier and Type	Method and 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
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
ORF_R04_OBSERVATION	getOBSERVATION() Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
ORF_R04_OBSERVATION	getOBSERVATION(int rep) Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
List<ORF_R04_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
ORF_R04_TIMING_QTY	getTIMING_QTY() Returns the first repetition of TIMING_QTY (a Group object) - creates it if necessary
ORF_R04_TIMING_QTY	getTIMING_QTY(int rep) Returns a specific repetition of TIMING_QTY (a Group object) - creates it if necessary
List<ORF_R04_TIMING_QTY>	getTIMING_QTYAll() Returns a non-modifiable List containing all current existing repetitions of TIMING_QTY.
int	getTIMING_QTYReps() Returns the number of existing repetitions of TIMING_QTY
String	getVersion() Returns "2.5"
void	insertCTI(CTI structure, int rep) Inserts a specific repetition of CTI (Clinical Trial Identification)
CTI	insertCTI(int rep) Inserts a specific repetition of CTI (Clinical Trial Identification)
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)
ORF_R04_OBSERVATION	insertOBSERVATION(int rep) Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(ORF_R04_OBSERVATION structure, int rep) Inserts a specific repetition of OBSERVATION (a Group object)
ORF_R04_TIMING_QTY	insertTIMING_QTY(int rep) Inserts a specific repetition of TIMING_QTY (a Group object)
void	insertTIMING_QTY(ORF_R04_TIMING_QTY structure, int rep) Inserts a specific repetition of TIMING_QTY (a Group object)
CTI	removeCTI(int rep) Removes a specific repetition of CTI (Clinical Trial Identification)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
ORF_R04_OBSERVATION	removeOBSERVATION(int rep) Removes a specific repetition of OBSERVATION (a Group object)
ORF_R04_TIMING_QTY	removeTIMING_QTY(int rep) Removes a specific repetition of TIMING_QTY (a Group object)

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

ORF_R04_ORDER

public ORF_R04_ORDER(Group parent,
             ModelClassFactory factory)

Creates a new ORF_R04_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.5"

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)

getTIMING_QTY

public ORF_R04_TIMING_QTY getTIMING_QTY()

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

getTIMING_QTY

public ORF_R04_TIMING_QTY getTIMING_QTY(int rep)

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

getTIMING_QTYReps

public int getTIMING_QTYReps()

Returns the number of existing repetitions of TIMING_QTY

getTIMING_QTYAll

public List<ORF_R04_TIMING_QTY> getTIMING_QTYAll()
                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertTIMING_QTY

public void insertTIMING_QTY(ORF_R04_TIMING_QTY structure,
                    int rep)
                      throws HL7Exception

Inserts a specific repetition of TIMING_QTY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertTIMING_QTY

public ORF_R04_TIMING_QTY insertTIMING_QTY(int rep)
                                    throws HL7Exception

Inserts a specific repetition of TIMING_QTY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeTIMING_QTY

public ORF_R04_TIMING_QTY removeTIMING_QTY(int rep)
                                    throws HL7Exception

Removes a specific repetition of TIMING_QTY (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getCTD

public CTD getCTD()

Returns CTD (Contact Data) - creates it if necessary

getOBSERVATION

public ORF_R04_OBSERVATION getOBSERVATION()

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

getOBSERVATION

public ORF_R04_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<ORF_R04_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(ORF_R04_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 ORF_R04_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 ORF_R04_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception

Removes a specific repetition of OBSERVATION (a Group object)

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)