ca.uhn.hl7v2.model.v24.group
Class OUL_R21_OBSERVATION

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v24.group.OUL_R21_OBSERVATION

All Implemented Interfaces:

Group, Structure, Serializable

public class OUL_R21_OBSERVATION
extends AbstractGroup

Represents a OUL_R21_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: OBX (Observation/Result) optional
• 2: TCD (Test Code Detail) optional
• 3: SID (Substance Identifier) optional repeating
• 4: NTE (Notes and Comments) optional repeating

See Also:

Serialized Form

Constructor Summary

OUL_R21_OBSERVATION(Group parent, ModelClassFactory factory)
Creates a new OUL_R21_OBSERVATION group

Method Summary

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
int	getNTEReps() Returns the number of existing repetitions of NTE
OBX	getOBX() Returns OBX (Observation/Result) - creates it if necessary
SID	getSID() Returns the first repetition of SID (Substance Identifier) - creates it if necessary
SID	getSID(int rep) Returns a specific repetition of SID (Substance Identifier) - creates it if necessary
int	getSIDReps() Returns the number of existing repetitions of SID
TCD	getTCD() Returns TCD (Test Code Detail) - creates it if necessary
String	getVersion() Returns "2.4"
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)
SID	insertSID(int rep) Inserts a specific repetition of SID (Substance Identifier)
void	insertSID(SID structure, int rep) Inserts a specific repetition of SID (Substance Identifier)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
SID	removeSID(int rep) Removes a specific repetition of SID (Substance Identifier)

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getClass, getMessage, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OUL_R21_OBSERVATION

public OUL_R21_OBSERVATION(Group parent,
                           ModelClassFactory factory)

Creates a new OUL_R21_OBSERVATION group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getOBX

public OBX getOBX()

Returns OBX (Observation/Result) - creates it if necessary

getTCD

public TCD getTCD()

Returns TCD (Test Code Detail) - creates it if necessary

getSID

public SID getSID()

Returns the first repetition of SID (Substance Identifier) - creates it if necessary

getSID

public SID getSID(int rep)

Returns a specific repetition of SID (Substance Identifier) - 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.

getSIDReps

public int getSIDReps()

Returns the number of existing repetitions of SID

insertSID

public void insertSID(SID structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of SID (Substance Identifier)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSID

public SID insertSID(int rep)
              throws HL7Exception

Inserts a specific repetition of SID (Substance Identifier)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSID

public SID removeSID(int rep)
              throws HL7Exception

Removes a specific repetition of SID (Substance Identifier)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

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

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)