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

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

All Implemented Interfaces:

Group, Structure, Serializable

public class OML_O21_ORDER
extends AbstractGroup

Represents a OML_O21_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: OML_O21_OBSERVATION_REQUEST (a Group object) optional
• 3: FT1 (Financial Transaction) optional repeating
• 4: CTI (Clinical Trial Identification) optional repeating
• 5: BLG (Billing) optional

See Also:

Serialized Form

Constructor Summary

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

Method Summary

BLG	getBLG() Returns BLG (Billing) - 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
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
OML_O21_OBSERVATION_REQUEST	getOBSERVATION_REQUEST() Returns OBSERVATION_REQUEST (a Group object) - creates it if necessary
ORC	getORC() Returns ORC (Common Order) - creates it if necessary
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	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)
CTI	removeCTI(int rep) Removes a specific repetition of CTI (Clinical Trial Identification)
FT1	removeFT1(int rep) Removes a specific repetition of FT1 (Financial Transaction)

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

OML_O21_ORDER

public OML_O21_ORDER(Group parent,
                     ModelClassFactory factory)

Creates a new OML_O21_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getORC

public ORC getORC()

Returns ORC (Common Order) - creates it if necessary

getOBSERVATION_REQUEST

public OML_O21_OBSERVATION_REQUEST getOBSERVATION_REQUEST()

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

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