ca.uhn.hl7v2.model.v21.message

Class ORR_O02

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v21.message.ORR_O02

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class ORR_O02
extends AbstractMessage

Represents a ORR_O02 message structure (see chapter ?). This structure contains the following elements:

• 1: MSH (MESSAGE HEADER)
• 2: MSA (MESSAGE ACKNOWLEDGMENT)
• 3: NTE (NOTES AND COMMENTS) optional repeating
• 4: ORR_O02_PATIENT (a Group object) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
ORR_O02() Creates a new ORR_O02 message with DefaultModelClassFactory.
ORR_O02(ModelClassFactory factory) Creates a new ORR_O02 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method and Description
MSA	getMSA() Returns MSA (MESSAGE ACKNOWLEDGMENT) - creates it if necessary
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
ORR_O02_PATIENT	getPATIENT() Returns PATIENT (a Group object) - creates it if necessary
String	getVersion() Returns "2.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)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NOTES AND COMMENTS)

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

accept, 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 Detail

ORR_O02

public ORR_O02()

Creates a new ORR_O02 message with DefaultModelClassFactory.

ORR_O02

public ORR_O02(ModelClassFactory factory)

Creates a new ORR_O02 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (MESSAGE HEADER) - creates it if necessary

getMSA

public MSA getMSA()

Returns MSA (MESSAGE ACKNOWLEDGMENT) - 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 ORR_O02_PATIENT getPATIENT()

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