Package ca.uhn.hl7v2.model.v24.message

Class OML_O21

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v24.message.OML_O21

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class OML_O21
extends AbstractMessage

Represents a OML_O21 message structure (see chapter 4). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: NTE (Notes and Comments) optional repeating
• 3: OML_O21_PATIENT (a Group object) optional
• 4: OML_O21_ORDER_GENERAL (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
OML_O21()	Creates a new OML_O21 message with DefaultModelClassFactory.
OML_O21(ModelClassFactory factory)	Creates a new OML_O21 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method	Description
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
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
OML_O21_ORDER_GENERAL	getORDER_GENERAL()	Returns the first repetition of ORDER_GENERAL (a Group object) - creates it if necessary
OML_O21_ORDER_GENERAL	getORDER_GENERAL(int rep)	Returns a specific repetition of ORDER_GENERAL (a Group object) - creates it if necessary
List<OML_O21_ORDER_GENERAL>	getORDER_GENERALAll()	Returns a non-modifiable List containing all current existing repetitions of ORDER_GENERAL.
int	getORDER_GENERALReps()	Returns the number of existing repetitions of ORDER_GENERAL
OML_O21_PATIENT	getPATIENT()	Returns PATIENT (a Group object) - 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)
OML_O21_ORDER_GENERAL	insertORDER_GENERAL(int rep)	Inserts a specific repetition of ORDER_GENERAL (a Group object)
void	insertORDER_GENERAL(OML_O21_ORDER_GENERAL structure, int rep)	Inserts a specific repetition of ORDER_GENERAL (a Group object)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and Comments)
OML_O21_ORDER_GENERAL	removeORDER_GENERAL(int rep)	Removes a specific repetition of ORDER_GENERAL (a Group object)

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

accept, copy, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, toString

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

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 java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Group

addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isChoiceElement, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getName

Methods inherited from interface ca.uhn.hl7v2.model.Visitable

isEmpty, provideLocation

Constructor Details

OML_O21

public OML_O21()

Creates a new OML_O21 message with DefaultModelClassFactory.

OML_O21

public OML_O21(ModelClassFactory factory)

Creates a new OML_O21 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.4"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - 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)

getPATIENT

public OML_O21_PATIENT getPATIENT()

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

getORDER_GENERAL

public OML_O21_ORDER_GENERAL getORDER_GENERAL()

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

getORDER_GENERAL

public OML_O21_ORDER_GENERAL getORDER_GENERAL(int rep)

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

getORDER_GENERALReps

public int getORDER_GENERALReps()

Returns the number of existing repetitions of ORDER_GENERAL

getORDER_GENERALAll

public List<OML_O21_ORDER_GENERAL> getORDER_GENERALAll()
                                                throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER_GENERAL

public void insertORDER_GENERAL(OML_O21_ORDER_GENERAL structure,
 int rep)
                         throws HL7Exception

Inserts a specific repetition of ORDER_GENERAL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertORDER_GENERAL

public OML_O21_ORDER_GENERAL insertORDER_GENERAL(int rep)
                                          throws HL7Exception

Inserts a specific repetition of ORDER_GENERAL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeORDER_GENERAL

public OML_O21_ORDER_GENERAL removeORDER_GENERAL(int rep)
                                          throws HL7Exception

Removes a specific repetition of ORDER_GENERAL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)