ca.uhn.hl7v2.model.v251.group

Class RCI_I05_OBSERVATION

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.RCI_I05_OBSERVATION

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RCI_I05_OBSERVATION
extends AbstractGroup

Represents a RCI_I05_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: OBR (Observation Request)
• 2: NTE (Notes and Comments) optional repeating
• 3: RCI_I05_RESULTS (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
RCI_I05_OBSERVATION(Group parent, ModelClassFactory factory) Creates a new RCI_I05_OBSERVATION group

Method Summary

Modifier and Type	Method and Description
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
RCI_I05_RESULTS	getRESULTS() Returns the first repetition of RESULTS (a Group object) - creates it if necessary
RCI_I05_RESULTS	getRESULTS(int rep) Returns a specific repetition of RESULTS (a Group object) - creates it if necessary
List<RCI_I05_RESULTS>	getRESULTSAll() Returns a non-modifiable List containing all current existing repetitions of RESULTS.
int	getRESULTSReps() Returns the number of existing repetitions of RESULTS
String	getVersion() Returns "2.5.1"
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)
RCI_I05_RESULTS	insertRESULTS(int rep) Inserts a specific repetition of RESULTS (a Group object)
void	insertRESULTS(RCI_I05_RESULTS structure, int rep) Inserts a specific repetition of RESULTS (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
RCI_I05_RESULTS	removeRESULTS(int rep) Removes a specific repetition of RESULTS (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 Detail

RCI_I05_OBSERVATION

public RCI_I05_OBSERVATION(Group parent,
                           ModelClassFactory factory)

Creates a new RCI_I05_OBSERVATION group

Method Detail

getVersion

public String getVersion()

Returns "2.5.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)

getRESULTS

public RCI_I05_RESULTS getRESULTS()

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

getRESULTS

public RCI_I05_RESULTS getRESULTS(int rep)

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

getRESULTSReps

public int getRESULTSReps()

Returns the number of existing repetitions of RESULTS

getRESULTSAll

public List<RCI_I05_RESULTS> getRESULTSAll()
                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertRESULTS

public void insertRESULTS(RCI_I05_RESULTS structure,
                          int rep)
                   throws HL7Exception

Inserts a specific repetition of RESULTS (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRESULTS

public RCI_I05_RESULTS insertRESULTS(int rep)
                              throws HL7Exception

Inserts a specific repetition of RESULTS (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRESULTS

public RCI_I05_RESULTS removeRESULTS(int rep)
                              throws HL7Exception

Removes a specific repetition of RESULTS (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)