ca.uhn.hl7v2.model.v281.group

Class DEO_O45_DONATION_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.DEO_O45_DONATION_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class DEO_O45_DONATION_ORDER
extends AbstractGroup

Represents a DEO_O45_DONATION_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: OBR (Observation Request)
• 2: NTE (Notes and Comments) optional repeating
• 3: DEO_O45_DONATION_OBSERVATION (a Group object) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DEO_O45_DONATION_OBSERVATION	getDONATION_OBSERVATION() Returns the first repetition of DONATION_OBSERVATION (a Group object) - creates it if necessary
DEO_O45_DONATION_OBSERVATION	getDONATION_OBSERVATION(int rep) Returns a specific repetition of DONATION_OBSERVATION (a Group object) - creates it if necessary
List<DEO_O45_DONATION_OBSERVATION>	getDONATION_OBSERVATIONAll() Returns a non-modifiable List containing all current existing repetitions of DONATION_OBSERVATION.
int	getDONATION_OBSERVATIONReps() Returns the number of existing repetitions of DONATION_OBSERVATION
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
String	getVersion() Returns "2.8.1"
void	insertDONATION_OBSERVATION(DEO_O45_DONATION_OBSERVATION structure, int rep) Inserts a specific repetition of DONATION_OBSERVATION (a Group object)
DEO_O45_DONATION_OBSERVATION	insertDONATION_OBSERVATION(int rep) Inserts a specific repetition of DONATION_OBSERVATION (a Group object)
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)
DEO_O45_DONATION_OBSERVATION	removeDONATION_OBSERVATION(int rep) Removes a specific repetition of DONATION_OBSERVATION (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)

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 Detail

DEO_O45_DONATION_ORDER

public DEO_O45_DONATION_ORDER(Group parent,
                              ModelClassFactory factory)

Creates a new DEO_O45_DONATION_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

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)

getDONATION_OBSERVATION

public DEO_O45_DONATION_OBSERVATION getDONATION_OBSERVATION()

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

getDONATION_OBSERVATION

public DEO_O45_DONATION_OBSERVATION getDONATION_OBSERVATION(int rep)

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

getDONATION_OBSERVATIONReps

public int getDONATION_OBSERVATIONReps()

Returns the number of existing repetitions of DONATION_OBSERVATION

getDONATION_OBSERVATIONAll

public List<DEO_O45_DONATION_OBSERVATION> getDONATION_OBSERVATIONAll()
                                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertDONATION_OBSERVATION

public void insertDONATION_OBSERVATION(DEO_O45_DONATION_OBSERVATION structure,
                                       int rep)
                                throws HL7Exception

Inserts a specific repetition of DONATION_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertDONATION_OBSERVATION

public DEO_O45_DONATION_OBSERVATION insertDONATION_OBSERVATION(int rep)
                                                        throws HL7Exception

Inserts a specific repetition of DONATION_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeDONATION_OBSERVATION

public DEO_O45_DONATION_OBSERVATION removeDONATION_OBSERVATION(int rep)
                                                        throws HL7Exception

Removes a specific repetition of DONATION_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)