Package ca.uhn.hl7v2.model.v251.message

Class OUL_R21

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v251.message.OUL_R21

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class OUL_R21
extends AbstractMessage

Represents a OUL_R21 message structure (see chapter 7.3.2). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: NTE (Notes and Comments) optional
• 4: OUL_R21_PATIENT (a Group object) optional
• 5: OUL_R21_VISIT (a Group object) optional
• 6: OUL_R21_ORDER_OBSERVATION (a Group object) repeating
• 7: DSC (Continuation Pointer) optional

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DSC	getDSC()	Returns DSC (Continuation Pointer) - creates it if necessary
MSH	getMSH()	Returns MSH (Message Header) - creates it if necessary
NTE	getNTE()	Returns NTE (Notes and Comments) - creates it if necessary
OUL_R21_ORDER_OBSERVATION	getORDER_OBSERVATION()	Returns the first repetition of ORDER_OBSERVATION (a Group object) - creates it if necessary
OUL_R21_ORDER_OBSERVATION	getORDER_OBSERVATION(int rep)	Returns a specific repetition of ORDER_OBSERVATION (a Group object) - creates it if necessary
List<OUL_R21_ORDER_OBSERVATION>	getORDER_OBSERVATIONAll()	Returns a non-modifiable List containing all current existing repetitions of ORDER_OBSERVATION.
int	getORDER_OBSERVATIONReps()	Returns the number of existing repetitions of ORDER_OBSERVATION
OUL_R21_PATIENT	getPATIENT()	Returns PATIENT (a Group object) - creates it if necessary
SFT	getSFT()	Returns the first repetition of SFT (Software Segment) - creates it if necessary
SFT	getSFT(int rep)	Returns a specific repetition of SFT (Software Segment) - creates it if necessary
List<SFT>	getSFTAll()	Returns a non-modifiable List containing all current existing repetitions of SFT.
int	getSFTReps()	Returns the number of existing repetitions of SFT
String	getVersion()	Returns "2.5.1"
OUL_R21_VISIT	getVISIT()	Returns VISIT (a Group object) - creates it if necessary
OUL_R21_ORDER_OBSERVATION	insertORDER_OBSERVATION(int rep)	Inserts a specific repetition of ORDER_OBSERVATION (a Group object)
void	insertORDER_OBSERVATION(OUL_R21_ORDER_OBSERVATION structure, int rep)	Inserts a specific repetition of ORDER_OBSERVATION (a Group object)
SFT	insertSFT(int rep)	Inserts a specific repetition of SFT (Software Segment)
void	insertSFT(SFT structure, int rep)	Inserts a specific repetition of SFT (Software Segment)
OUL_R21_ORDER_OBSERVATION	removeORDER_OBSERVATION(int rep)	Removes a specific repetition of ORDER_OBSERVATION (a Group object)
SFT	removeSFT(int rep)	Removes a specific repetition of SFT (Software Segment)

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

OUL_R21

public OUL_R21()

Creates a new OUL_R21 message with DefaultModelClassFactory.

OUL_R21

public OUL_R21(ModelClassFactory factory)

Creates a new OUL_R21 message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getSFT

public SFT getSFT()

Returns the first repetition of SFT (Software Segment) - creates it if necessary

getSFT

public SFT getSFT(int rep)

Returns a specific repetition of SFT (Software Segment) - 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.

getSFTReps

public int getSFTReps()

Returns the number of existing repetitions of SFT

getSFTAll

public List<SFT> getSFTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSFT

public void insertSFT(SFT structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertSFT

public SFT insertSFT(int rep)
              throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeSFT

public SFT removeSFT(int rep)
              throws HL7Exception

Removes a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getNTE

public NTE getNTE()

Returns NTE (Notes and Comments) - creates it if necessary

getPATIENT

public OUL_R21_PATIENT getPATIENT()

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

getVISIT

public OUL_R21_VISIT getVISIT()

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

getORDER_OBSERVATION

public OUL_R21_ORDER_OBSERVATION getORDER_OBSERVATION()

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

getORDER_OBSERVATION

public OUL_R21_ORDER_OBSERVATION getORDER_OBSERVATION(int rep)

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

getORDER_OBSERVATIONReps

public int getORDER_OBSERVATIONReps()

Returns the number of existing repetitions of ORDER_OBSERVATION

getORDER_OBSERVATIONAll

public List<OUL_R21_ORDER_OBSERVATION> getORDER_OBSERVATIONAll()
                                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER_OBSERVATION

public void insertORDER_OBSERVATION(OUL_R21_ORDER_OBSERVATION structure,
 int rep)
                             throws HL7Exception

Inserts a specific repetition of ORDER_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertORDER_OBSERVATION

public OUL_R21_ORDER_OBSERVATION insertORDER_OBSERVATION(int rep)
                                                  throws HL7Exception

Inserts a specific repetition of ORDER_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeORDER_OBSERVATION

public OUL_R21_ORDER_OBSERVATION removeORDER_OBSERVATION(int rep)
                                                  throws HL7Exception

Removes a specific repetition of ORDER_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation Pointer) - creates it if necessary