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

Class OMI_O23_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.OMI_O23_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OMI_O23_ORDER
extends AbstractGroup

Represents a OMI_O23_ORDER 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: ORC (Common Order)
• 2: OMI_O23_TIMING (a Group object) optional repeating
• 3: OBR (Observation Request)
• 4: NTE (Notes and Comments) optional repeating
• 5: CTD (Contact Data) optional
• 6: DG1 (Diagnosis) optional repeating
• 7: OMI_O23_OBSERVATION (a Group object) optional repeating
• 8: IPC (Imaging Procedure Control Segment) repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
OMI_O23_ORDER(Group parent, ModelClassFactory factory)	Creates a new OMI_O23_ORDER 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
IPC	getIPC()	Returns the first repetition of IPC (Imaging Procedure Control Segment) - creates it if necessary
IPC	getIPC(int rep)	Returns a specific repetition of IPC (Imaging Procedure Control Segment) - creates it if necessary
List<IPC>	getIPCAll()	Returns a non-modifiable List containing all current existing repetitions of IPC.
int	getIPCReps()	Returns the number of existing repetitions of IPC
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
OMI_O23_OBSERVATION	getOBSERVATION()	Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
OMI_O23_OBSERVATION	getOBSERVATION(int rep)	Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
List<OMI_O23_OBSERVATION>	getOBSERVATIONAll()	Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
int	getOBSERVATIONReps()	Returns the number of existing repetitions of OBSERVATION
ORC	getORC()	Returns ORC (Common Order) - creates it if necessary
OMI_O23_TIMING	getTIMING()	Returns the first repetition of TIMING (a Group object) - creates it if necessary
OMI_O23_TIMING	getTIMING(int rep)	Returns a specific repetition of TIMING (a Group object) - creates it if necessary
List<OMI_O23_TIMING>	getTIMINGAll()	Returns a non-modifiable List containing all current existing repetitions of TIMING.
int	getTIMINGReps()	Returns the number of existing repetitions of TIMING
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)
IPC	insertIPC(int rep)	Inserts a specific repetition of IPC (Imaging Procedure Control Segment)
void	insertIPC(IPC structure, int rep)	Inserts a specific repetition of IPC (Imaging Procedure Control Segment)
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)
OMI_O23_OBSERVATION	insertOBSERVATION(int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(OMI_O23_OBSERVATION structure, int rep)	Inserts a specific repetition of OBSERVATION (a Group object)
OMI_O23_TIMING	insertTIMING(int rep)	Inserts a specific repetition of TIMING (a Group object)
void	insertTIMING(OMI_O23_TIMING structure, int rep)	Inserts a specific repetition of TIMING (a Group object)
DG1	removeDG1(int rep)	Removes a specific repetition of DG1 (Diagnosis)
IPC	removeIPC(int rep)	Removes a specific repetition of IPC (Imaging Procedure Control Segment)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and Comments)
OMI_O23_OBSERVATION	removeOBSERVATION(int rep)	Removes a specific repetition of OBSERVATION (a Group object)
OMI_O23_TIMING	removeTIMING(int rep)	Removes a specific repetition of TIMING (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

OMI_O23_ORDER

public OMI_O23_ORDER(Group parent,
 ModelClassFactory factory)

Creates a new OMI_O23_ORDER group

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getTIMING

public OMI_O23_TIMING getTIMING()

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

getTIMING

public OMI_O23_TIMING getTIMING(int rep)

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

getTIMINGReps

public int getTIMINGReps()

Returns the number of existing repetitions of TIMING

getTIMINGAll

public List<OMI_O23_TIMING> getTIMINGAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertTIMING

public void insertTIMING(OMI_O23_TIMING structure,
 int rep)
                  throws HL7Exception

Inserts a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertTIMING

public OMI_O23_TIMING insertTIMING(int rep)
                            throws HL7Exception

Inserts a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeTIMING

public OMI_O23_TIMING removeTIMING(int rep)
                            throws HL7Exception

Removes a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getOBR

public OBR getOBR()

Returns OBR (Observation Request) - 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 OMI_O23_OBSERVATION getOBSERVATION()

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

getOBSERVATION

public OMI_O23_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<OMI_O23_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(OMI_O23_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 OMI_O23_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 OMI_O23_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getIPC

public IPC getIPC()

Returns the first repetition of IPC (Imaging Procedure Control Segment) - creates it if necessary

getIPC

public IPC getIPC(int rep)

Returns a specific repetition of IPC (Imaging Procedure Control 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.

getIPCReps

public int getIPCReps()

Returns the number of existing repetitions of IPC

getIPCAll

public List<IPC> getIPCAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertIPC

public void insertIPC(IPC structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of IPC (Imaging Procedure Control Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertIPC

public IPC insertIPC(int rep)
              throws HL7Exception

Inserts a specific repetition of IPC (Imaging Procedure Control Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeIPC

public IPC removeIPC(int rep)
              throws HL7Exception

Removes a specific repetition of IPC (Imaging Procedure Control Segment)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)