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

Class RSP_Z86_COMMON_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.RSP_Z86_COMMON_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RSP_Z86_COMMON_ORDER
extends AbstractGroup

Represents a RSP_Z86_COMMON_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: RSP_Z86_TIMING (a Group object) optional repeating
• 3: RSP_Z86_ORDER_DETAIL (a Group object) optional
• 4: RSP_Z86_ENCODED_ORDER (a Group object) optional
• 5: RSP_Z86_DISPENSE (a Group object) optional
• 6: RSP_Z86_GIVE (a Group object) optional
• 7: RSP_Z86_ADMINISTRATION (a Group object) optional
• 8: RSP_Z86_OBSERVATION (a Group object) repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RSP_Z86_ADMINISTRATION	getADMINISTRATION()	Returns ADMINISTRATION (a Group object) - creates it if necessary
RSP_Z86_DISPENSE	getDISPENSE()	Returns DISPENSE (a Group object) - creates it if necessary
RSP_Z86_ENCODED_ORDER	getENCODED_ORDER()	Returns ENCODED_ORDER (a Group object) - creates it if necessary
RSP_Z86_GIVE	getGIVE()	Returns GIVE (a Group object) - creates it if necessary
RSP_Z86_OBSERVATION	getOBSERVATION()	Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
RSP_Z86_OBSERVATION	getOBSERVATION(int rep)	Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
List<RSP_Z86_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
RSP_Z86_ORDER_DETAIL	getORDER_DETAIL()	Returns ORDER_DETAIL (a Group object) - creates it if necessary
RSP_Z86_TIMING	getTIMING()	Returns the first repetition of TIMING (a Group object) - creates it if necessary
RSP_Z86_TIMING	getTIMING(int rep)	Returns a specific repetition of TIMING (a Group object) - creates it if necessary
List<RSP_Z86_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"
RSP_Z86_OBSERVATION	insertOBSERVATION(int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(RSP_Z86_OBSERVATION structure, int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
RSP_Z86_TIMING	insertTIMING(int rep)	Inserts a specific repetition of TIMING (a Group object)
void	insertTIMING(RSP_Z86_TIMING structure, int rep)	Inserts a specific repetition of TIMING (a Group object)
RSP_Z86_OBSERVATION	removeOBSERVATION(int rep)	Removes a specific repetition of OBSERVATION (a Group object)
RSP_Z86_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

RSP_Z86_COMMON_ORDER

public RSP_Z86_COMMON_ORDER(Group parent,
 ModelClassFactory factory)

Creates a new RSP_Z86_COMMON_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 RSP_Z86_TIMING getTIMING()

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

getTIMING

public RSP_Z86_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<RSP_Z86_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(RSP_Z86_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 RSP_Z86_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 RSP_Z86_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 RSP_Z86_ORDER_DETAIL getORDER_DETAIL()

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

getENCODED_ORDER

public RSP_Z86_ENCODED_ORDER getENCODED_ORDER()

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

getDISPENSE

public RSP_Z86_DISPENSE getDISPENSE()

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

getGIVE

public RSP_Z86_GIVE getGIVE()

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

getADMINISTRATION

public RSP_Z86_ADMINISTRATION getADMINISTRATION()

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

getOBSERVATION

public RSP_Z86_OBSERVATION getOBSERVATION()

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

getOBSERVATION

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

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)