Package ca.uhn.hl7v2.model.v251.group

Class RAS_O17_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.RAS_O17_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RAS_O17_ORDER
extends AbstractGroup

Represents a RAS_O17_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)
• 2: RAS_O17_TIMING (a Group object) optional repeating
• 3: RAS_O17_ORDER_DETAIL (a Group object) optional
• 4: RAS_O17_ENCODING (a Group object) optional
• 5: RAS_O17_ADMINISTRATION (a Group object) repeating
• 6: 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
RAS_O17_ORDER(Group parent, ModelClassFactory factory)	Creates a new RAS_O17_ORDER group

Method Summary

Modifier and Type	Method	Description
RAS_O17_ADMINISTRATION	getADMINISTRATION()	Returns the first repetition of ADMINISTRATION (a Group object) - creates it if necessary
RAS_O17_ADMINISTRATION	getADMINISTRATION(int rep)	Returns a specific repetition of ADMINISTRATION (a Group object) - creates it if necessary
List<RAS_O17_ADMINISTRATION>	getADMINISTRATIONAll()	Returns a non-modifiable List containing all current existing repetitions of ADMINISTRATION.
int	getADMINISTRATIONReps()	Returns the number of existing repetitions of ADMINISTRATION
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
RAS_O17_ENCODING	getENCODING()	Returns ENCODING (a Group object) - creates it if necessary
ORC	getORC()	Returns ORC (Common Order) - creates it if necessary
RAS_O17_ORDER_DETAIL	getORDER_DETAIL()	Returns ORDER_DETAIL (a Group object) - creates it if necessary
RAS_O17_TIMING	getTIMING()	Returns the first repetition of TIMING (a Group object) - creates it if necessary
RAS_O17_TIMING	getTIMING(int rep)	Returns a specific repetition of TIMING (a Group object) - creates it if necessary
List<RAS_O17_TIMING>	getTIMINGAll()	Returns a non-modifiable List containing all current existing repetitions of TIMING.
int	getTIMINGReps()	Returns the number of existing repetitions of TIMING
String	getVersion()	Returns "2.5.1"
RAS_O17_ADMINISTRATION	insertADMINISTRATION(int rep)	Inserts a specific repetition of ADMINISTRATION (a Group object)
void	insertADMINISTRATION(RAS_O17_ADMINISTRATION structure, int rep)	Inserts a specific repetition of ADMINISTRATION (a Group object)
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)
RAS_O17_TIMING	insertTIMING(int rep)	Inserts a specific repetition of TIMING (a Group object)
void	insertTIMING(RAS_O17_TIMING structure, int rep)	Inserts a specific repetition of TIMING (a Group object)
RAS_O17_ADMINISTRATION	removeADMINISTRATION(int rep)	Removes a specific repetition of ADMINISTRATION (a Group object)
CTI	removeCTI(int rep)	Removes a specific repetition of CTI (Clinical Trial Identification)
RAS_O17_TIMING	removeTIMING(int rep)	Removes a specific repetition of TIMING (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

RAS_O17_ORDER

public RAS_O17_ORDER(Group parent,
 ModelClassFactory factory)

Creates a new RAS_O17_ORDER group

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getTIMING

public RAS_O17_TIMING getTIMING()

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

getTIMING

public RAS_O17_TIMING getTIMING(int rep)

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

getTIMINGReps

public int getTIMINGReps()

Returns the number of existing repetitions of TIMING

getTIMINGAll

public List<RAS_O17_TIMING> getTIMINGAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertTIMING

public void insertTIMING(RAS_O17_TIMING structure,
 int rep)
                  throws HL7Exception

Inserts a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertTIMING

public RAS_O17_TIMING insertTIMING(int rep)
                            throws HL7Exception

Inserts a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeTIMING

public RAS_O17_TIMING removeTIMING(int rep)
                            throws HL7Exception

Removes a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getORDER_DETAIL

public RAS_O17_ORDER_DETAIL getORDER_DETAIL()

Returns ORDER_DETAIL (a Group object) - creates it if necessary

getENCODING

public RAS_O17_ENCODING getENCODING()

Returns ENCODING (a Group object) - creates it if necessary

getADMINISTRATION

public RAS_O17_ADMINISTRATION getADMINISTRATION()

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

getADMINISTRATION

public RAS_O17_ADMINISTRATION getADMINISTRATION(int rep)

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

getADMINISTRATIONReps

public int getADMINISTRATIONReps()

Returns the number of existing repetitions of ADMINISTRATION

getADMINISTRATIONAll

public List<RAS_O17_ADMINISTRATION> getADMINISTRATIONAll()
                                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertADMINISTRATION

public void insertADMINISTRATION(RAS_O17_ADMINISTRATION structure,
 int rep)
                          throws HL7Exception

Inserts a specific repetition of ADMINISTRATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertADMINISTRATION

public RAS_O17_ADMINISTRATION insertADMINISTRATION(int rep)
                                            throws HL7Exception

Inserts a specific repetition of ADMINISTRATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeADMINISTRATION

public RAS_O17_ADMINISTRATION removeADMINISTRATION(int rep)
                                            throws HL7Exception

Removes a specific repetition of ADMINISTRATION (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)