Package ca.uhn.hl7v2.model.v251.group

Class OML_O21_OBSERVATION_REQUEST

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.OML_O21_OBSERVATION_REQUEST

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OML_O21_OBSERVATION_REQUEST
extends AbstractGroup

Represents a OML_O21_OBSERVATION_REQUEST 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: TCD (Test Code Detail) optional
• 3: NTE (Notes and Comments) optional repeating
• 4: CTD (Contact Data) optional
• 5: DG1 (Diagnosis) optional repeating
• 6: OML_O21_OBSERVATION (a Group object) optional repeating
• 7: OML_O21_SPECIMEN (a Group object) optional repeating
• 8: OML_O21_PRIOR_RESULT (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	Description
OML_O21_OBSERVATION_REQUEST(Group parent, ModelClassFactory factory)	Creates a new OML_O21_OBSERVATION_REQUEST group

Method Summary

Modifier and Type	Method	Description
CTD	getCTD()	Returns CTD (Contact Data) - creates it if necessary
DG1	getDG1()	Returns the first repetition of DG1 (Diagnosis) - creates it if necessary
DG1	getDG1(int rep)	Returns a specific repetition of DG1 (Diagnosis) - creates it if necessary
List<DG1>	getDG1All()	Returns a non-modifiable List containing all current existing repetitions of DG1.
int	getDG1Reps()	Returns the number of existing repetitions of DG1
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
OML_O21_OBSERVATION	getOBSERVATION()	Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
OML_O21_OBSERVATION	getOBSERVATION(int rep)	Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
List<OML_O21_OBSERVATION>	getOBSERVATIONAll()	Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
int	getOBSERVATIONReps()	Returns the number of existing repetitions of OBSERVATION
OML_O21_PRIOR_RESULT	getPRIOR_RESULT()	Returns the first repetition of PRIOR_RESULT (a Group object) - creates it if necessary
OML_O21_PRIOR_RESULT	getPRIOR_RESULT(int rep)	Returns a specific repetition of PRIOR_RESULT (a Group object) - creates it if necessary
List<OML_O21_PRIOR_RESULT>	getPRIOR_RESULTAll()	Returns a non-modifiable List containing all current existing repetitions of PRIOR_RESULT.
int	getPRIOR_RESULTReps()	Returns the number of existing repetitions of PRIOR_RESULT
OML_O21_SPECIMEN	getSPECIMEN()	Returns the first repetition of SPECIMEN (a Group object) - creates it if necessary
OML_O21_SPECIMEN	getSPECIMEN(int rep)	Returns a specific repetition of SPECIMEN (a Group object) - creates it if necessary
List<OML_O21_SPECIMEN>	getSPECIMENAll()	Returns a non-modifiable List containing all current existing repetitions of SPECIMEN.
int	getSPECIMENReps()	Returns the number of existing repetitions of SPECIMEN
TCD	getTCD()	Returns TCD (Test Code Detail) - creates it if necessary
String	getVersion()	Returns "2.5.1"
DG1	insertDG1(int rep)	Inserts a specific repetition of DG1 (Diagnosis)
void	insertDG1(DG1 structure, int rep)	Inserts a specific repetition of DG1 (Diagnosis)
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_OBSERVATION	insertOBSERVATION(int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(OML_O21_OBSERVATION structure, int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
OML_O21_PRIOR_RESULT	insertPRIOR_RESULT(int rep)	Inserts a specific repetition of PRIOR_RESULT (a Group object)
void	insertPRIOR_RESULT(OML_O21_PRIOR_RESULT structure, int rep)	Inserts a specific repetition of PRIOR_RESULT (a Group object)
OML_O21_SPECIMEN	insertSPECIMEN(int rep)	Inserts a specific repetition of SPECIMEN (a Group object)
void	insertSPECIMEN(OML_O21_SPECIMEN structure, int rep)	Inserts a specific repetition of SPECIMEN (a Group object)
DG1	removeDG1(int rep)	Removes a specific repetition of DG1 (Diagnosis)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and Comments)
OML_O21_OBSERVATION	removeOBSERVATION(int rep)	Removes a specific repetition of OBSERVATION (a Group object)
OML_O21_PRIOR_RESULT	removePRIOR_RESULT(int rep)	Removes a specific repetition of PRIOR_RESULT (a Group object)
OML_O21_SPECIMEN	removeSPECIMEN(int rep)	Removes a specific repetition of SPECIMEN (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 Details

OML_O21_OBSERVATION_REQUEST

public OML_O21_OBSERVATION_REQUEST(Group parent,
 ModelClassFactory factory)

Creates a new OML_O21_OBSERVATION_REQUEST group

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

getOBR

public OBR getOBR()

Returns OBR (Observation Request) - creates it if necessary

getTCD

public TCD getTCD()

Returns TCD (Test Code Detail) - 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)

getCTD

public CTD getCTD()

Returns CTD (Contact Data) - creates it if necessary

getDG1

public DG1 getDG1()

Returns the first repetition of DG1 (Diagnosis) - creates it if necessary

getDG1

public DG1 getDG1(int rep)

Returns a specific repetition of DG1 (Diagnosis) - 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.

getDG1Reps

public int getDG1Reps()

Returns the number of existing repetitions of DG1

getDG1All

public List<DG1> getDG1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertDG1

public void insertDG1(DG1 structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDG1

public DG1 insertDG1(int rep)
              throws HL7Exception

Inserts a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeDG1

public DG1 removeDG1(int rep)
              throws HL7Exception

Removes a specific repetition of DG1 (Diagnosis)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getOBSERVATION

public OML_O21_OBSERVATION getOBSERVATION()

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

getOBSERVATION

public OML_O21_OBSERVATION getOBSERVATION(int rep)

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

getOBSERVATIONReps

public int getOBSERVATIONReps()

Returns the number of existing repetitions of OBSERVATION

getOBSERVATIONAll

public List<OML_O21_OBSERVATION> getOBSERVATIONAll()
                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertOBSERVATION

public void insertOBSERVATION(OML_O21_OBSERVATION structure,
 int rep)
                       throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertOBSERVATION

public OML_O21_OBSERVATION insertOBSERVATION(int rep)
                                      throws HL7Exception

Inserts a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeOBSERVATION

public OML_O21_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getSPECIMEN

public OML_O21_SPECIMEN getSPECIMEN()

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

getSPECIMEN

public OML_O21_SPECIMEN getSPECIMEN(int rep)

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

getSPECIMENReps

public int getSPECIMENReps()

Returns the number of existing repetitions of SPECIMEN

getSPECIMENAll

public List<OML_O21_SPECIMEN> getSPECIMENAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertSPECIMEN

public void insertSPECIMEN(OML_O21_SPECIMEN structure,
 int rep)
                    throws HL7Exception

Inserts a specific repetition of SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertSPECIMEN

public OML_O21_SPECIMEN insertSPECIMEN(int rep)
                                throws HL7Exception

Inserts a specific repetition of SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeSPECIMEN

public OML_O21_SPECIMEN removeSPECIMEN(int rep)
                                throws HL7Exception

Removes a specific repetition of SPECIMEN (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPRIOR_RESULT

public OML_O21_PRIOR_RESULT getPRIOR_RESULT()

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

getPRIOR_RESULT

public OML_O21_PRIOR_RESULT getPRIOR_RESULT(int rep)

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

getPRIOR_RESULTReps

public int getPRIOR_RESULTReps()

Returns the number of existing repetitions of PRIOR_RESULT

getPRIOR_RESULTAll

public List<OML_O21_PRIOR_RESULT> getPRIOR_RESULTAll()
                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertPRIOR_RESULT

public void insertPRIOR_RESULT(OML_O21_PRIOR_RESULT structure,
 int rep)
                        throws HL7Exception

Inserts a specific repetition of PRIOR_RESULT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPRIOR_RESULT

public OML_O21_PRIOR_RESULT insertPRIOR_RESULT(int rep)
                                        throws HL7Exception

Inserts a specific repetition of PRIOR_RESULT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePRIOR_RESULT

public OML_O21_PRIOR_RESULT removePRIOR_RESULT(int rep)
                                        throws HL7Exception

Removes a specific repetition of PRIOR_RESULT (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)