ca.uhn.hl7v2.model.v25.group

Class OMB_O27_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v25.group.OMB_O27_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class OMB_O27_ORDER
extends AbstractGroup

Represents a OMB_O27_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: OMB_O27_TIMING (a Group object) optional repeating
• 3: BPO (Blood product order)
• 4: SPM (Specimen) optional
• 5: NTE (Notes and Comments) optional repeating
• 6: DG1 (Diagnosis) optional repeating
• 7: OMB_O27_OBSERVATION (a Group object) optional repeating
• 8: FT1 (Financial Transaction) optional repeating
• 9: BLG (Billing) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
OMB_O27_ORDER(Group parent, ModelClassFactory factory) Creates a new OMB_O27_ORDER group

Method Summary

Methods

Modifier and Type	Method and Description
BLG	getBLG() Returns BLG (Billing) - creates it if necessary
BPO	getBPO() Returns BPO (Blood product order) - 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
FT1	getFT1() Returns the first repetition of FT1 (Financial Transaction) - creates it if necessary
FT1	getFT1(int rep) Returns a specific repetition of FT1 (Financial Transaction) - creates it if necessary
List<FT1>	getFT1All() Returns a non-modifiable List containing all current existing repetitions of FT1.
int	getFT1Reps() Returns the number of existing repetitions of FT1
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
OMB_O27_OBSERVATION	getOBSERVATION() Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
OMB_O27_OBSERVATION	getOBSERVATION(int rep) Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
List<OMB_O27_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
SPM	getSPM() Returns SPM (Specimen) - creates it if necessary
OMB_O27_TIMING	getTIMING() Returns the first repetition of TIMING (a Group object) - creates it if necessary
OMB_O27_TIMING	getTIMING(int rep) Returns a specific repetition of TIMING (a Group object) - creates it if necessary
List<OMB_O27_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"
void	insertDG1(DG1 structure, int rep) Inserts a specific repetition of DG1 (Diagnosis)
DG1	insertDG1(int rep) Inserts a specific repetition of DG1 (Diagnosis)
void	insertFT1(FT1 structure, int rep) Inserts a specific repetition of FT1 (Financial Transaction)
FT1	insertFT1(int rep) Inserts a specific repetition of FT1 (Financial Transaction)
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)
OMB_O27_OBSERVATION	insertOBSERVATION(int rep) Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(OMB_O27_OBSERVATION structure, int rep) Inserts a specific repetition of OBSERVATION (a Group object)
OMB_O27_TIMING	insertTIMING(int rep) Inserts a specific repetition of TIMING (a Group object)
void	insertTIMING(OMB_O27_TIMING structure, int rep) Inserts a specific repetition of TIMING (a Group object)
DG1	removeDG1(int rep) Removes a specific repetition of DG1 (Diagnosis)
FT1	removeFT1(int rep) Removes a specific repetition of FT1 (Financial Transaction)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
OMB_O27_OBSERVATION	removeOBSERVATION(int rep) Removes a specific repetition of OBSERVATION (a Group object)
OMB_O27_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 Detail

OMB_O27_ORDER

public OMB_O27_ORDER(Group parent,
             ModelClassFactory factory)

Creates a new OMB_O27_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.5"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getTIMING

public OMB_O27_TIMING getTIMING()

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

getTIMING

public OMB_O27_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<OMB_O27_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(OMB_O27_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 OMB_O27_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 OMB_O27_TIMING removeTIMING(int rep)
                            throws HL7Exception

Removes a specific repetition of TIMING (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getBPO

public BPO getBPO()

Returns BPO (Blood product order) - creates it if necessary

getSPM

public SPM getSPM()

Returns SPM (Specimen) - 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)

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 OMB_O27_OBSERVATION getOBSERVATION()

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

getOBSERVATION

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

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getFT1

public FT1 getFT1()

Returns the first repetition of FT1 (Financial Transaction) - creates it if necessary

getFT1

public FT1 getFT1(int rep)

Returns a specific repetition of FT1 (Financial Transaction) - 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.

getFT1Reps

public int getFT1Reps()

Returns the number of existing repetitions of FT1

getFT1All

public List<FT1> getFT1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertFT1

public void insertFT1(FT1 structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of FT1 (Financial Transaction)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertFT1

public FT1 insertFT1(int rep)
              throws HL7Exception

Inserts a specific repetition of FT1 (Financial Transaction)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeFT1

public FT1 removeFT1(int rep)
              throws HL7Exception

Removes a specific repetition of FT1 (Financial Transaction)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getBLG

public BLG getBLG()

Returns BLG (Billing) - creates it if necessary