ca.uhn.hl7v2.model.v24.group
Class OMG_O19_ORDER

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v24.group.OMG_O19_ORDER

All Implemented Interfaces:

Group, Structure, Serializable

public class OMG_O19_ORDER
extends AbstractGroup

Represents a OMG_O19_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: OBR (Observation Request)
• 3: NTE (Notes and Comments) optional repeating
• 4: CTD (Contact Data) optional
• 5: DG1 (Diagnosis) optional repeating
• 6: OMG_O19_OBSERVATION (a Group object) optional repeating
• 7: OMG_O19_PRIOR_RESULT (a Group object) optional repeating
• 8: FT1 (Financial Transaction) optional repeating
• 9: CTI (Clinical Trial Identification) optional repeating
• 10: BLG (Billing) optional

See Also:

Serialized Form

Constructor Summary

OMG_O19_ORDER(Group parent, ModelClassFactory factory)
Creates a new OMG_O19_ORDER group

Method Summary

BLG	getBLG() Returns BLG (Billing) - creates it if necessary
CTD	getCTD() Returns CTD (Contact Data) - creates it if necessary
CTI	getCTI() Returns the first repetition of CTI (Clinical Trial Identification) - creates it if necessary
CTI	getCTI(int rep) Returns a specific repetition of CTI (Clinical Trial Identification) - creates it if necessary
int	getCTIReps() Returns the number of existing repetitions of CTI
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
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
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
int	getNTEReps() Returns the number of existing repetitions of NTE
OBR	getOBR() Returns OBR (Observation Request) - creates it if necessary
OMG_O19_OBSERVATION	getOBSERVATION() Returns the first repetition of OBSERVATION (a Group object) - creates it if necessary
OMG_O19_OBSERVATION	getOBSERVATION(int rep) Returns a specific repetition of OBSERVATION (a Group object) - creates it if necessary
int	getOBSERVATIONReps() Returns the number of existing repetitions of OBSERVATION
ORC	getORC() Returns ORC (Common Order) - creates it if necessary
OMG_O19_PRIOR_RESULT	getPRIOR_RESULT() Returns the first repetition of PRIOR_RESULT (a Group object) - creates it if necessary
OMG_O19_PRIOR_RESULT	getPRIOR_RESULT(int rep) Returns a specific repetition of PRIOR_RESULT (a Group object) - creates it if necessary
int	getPRIOR_RESULTReps() Returns the number of existing repetitions of PRIOR_RESULT
String	getVersion() Returns "2.4"
void	insertCTI(CTI structure, int rep) Inserts a specific repetition of CTI (Clinical Trial Identification)
CTI	insertCTI(int rep) Inserts a specific repetition of CTI (Clinical Trial Identification)
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)
OMG_O19_OBSERVATION	insertOBSERVATION(int rep) Inserts a specific repetition of OBSERVATION (a Group object)
void	insertOBSERVATION(OMG_O19_OBSERVATION structure, int rep) Inserts a specific repetition of OBSERVATION (a Group object)
OMG_O19_PRIOR_RESULT	insertPRIOR_RESULT(int rep) Inserts a specific repetition of PRIOR_RESULT (a Group object)
void	insertPRIOR_RESULT(OMG_O19_PRIOR_RESULT structure, int rep) Inserts a specific repetition of PRIOR_RESULT (a Group object)
CTI	removeCTI(int rep) Removes a specific repetition of CTI (Clinical Trial Identification)
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)
OMG_O19_OBSERVATION	removeOBSERVATION(int rep) Removes a specific repetition of OBSERVATION (a Group object)
OMG_O19_PRIOR_RESULT	removePRIOR_RESULT(int rep) Removes a specific repetition of PRIOR_RESULT (a Group object)

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getClass, getMessage, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OMG_O19_ORDER

public OMG_O19_ORDER(Group parent,
                     ModelClassFactory factory)

Creates a new OMG_O19_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

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

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

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

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

getOBSERVATION

public OMG_O19_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

insertOBSERVATION

public void insertOBSERVATION(OMG_O19_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 OMG_O19_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 OMG_O19_OBSERVATION removeOBSERVATION(int rep)
                                      throws HL7Exception

Removes a specific repetition of OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPRIOR_RESULT

public OMG_O19_PRIOR_RESULT getPRIOR_RESULT()

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

getPRIOR_RESULT

public OMG_O19_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

insertPRIOR_RESULT

public void insertPRIOR_RESULT(OMG_O19_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 OMG_O19_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 OMG_O19_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)

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

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)

getCTI

public CTI getCTI()

Returns the first repetition of CTI (Clinical Trial Identification) - creates it if necessary

getCTI

public CTI getCTI(int rep)

Returns a specific repetition of CTI (Clinical Trial Identification) - 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.

getCTIReps

public int getCTIReps()

Returns the number of existing repetitions of CTI

insertCTI

public void insertCTI(CTI structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of CTI (Clinical Trial Identification)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCTI

public CTI insertCTI(int rep)
              throws HL7Exception

Inserts a specific repetition of CTI (Clinical Trial Identification)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCTI

public CTI removeCTI(int rep)
              throws HL7Exception

Removes a specific repetition of CTI (Clinical Trial Identification)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getBLG

public BLG getBLG()

Returns BLG (Billing) - creates it if necessary