ca.uhn.hl7v2.model.v24.segment
Class ODT

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.ODT

All Implemented Interfaces:

Segment, Structure, Serializable

public class ODT
extends AbstractSegment

Represents an HL7 ODT message segment (Diet Tray Instructions). This segment has the following fields:

• ODT-1: Tray Type (CE)
• ODT-2: Service Period (CE) optional repeating
• ODT-3: Text Instruction (ST) optional

See Also:

Serialized Form

Constructor Summary

ODT(Group parent, ModelClassFactory factory)
Creates a new ODT segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
CE	getOdt1_TrayType() Returns ODT-1: "Tray Type" - creates it if necessary
CE	getOdt2_ServicePeriod(int rep) Returns a specific repetition of ODT-2: "Service Period" - creates it if necessary
int	getOdt2_ServicePeriodReps() Returns a count of the current number of repetitions of Service Period (ODT-2).
ST	getOdt3_TextInstruction() Returns ODT-3: "Text Instruction" - creates it if necessary
CE[]	getServicePeriod() Returns all repetitions of Service Period (ODT-2).
CE	getServicePeriod(int rep) Returns a specific repetition of ODT-2: "Service Period" - creates it if necessary
int	getServicePeriodReps() Returns a count of the current number of repetitions of Service Period (ODT-2).
ST	getTextInstruction() Returns ODT-3: "Text Instruction" - creates it if necessary
CE	getTrayType() Returns ODT-1: "Tray Type" - creates it if necessary
CE	insertOdt2_ServicePeriod(int rep) Inserts a repetition of ODT-2: "Service Period" at a specific index
CE	insertServicePeriod(int rep) Inserts a repetition of ODT-2: "Service Period" at a specific index
CE	removeOdt2_ServicePeriod(int rep) Removes a repetition of ODT-2: "Service Period" at a specific index
CE	removeServicePeriod(int rep) Removes a repetition of ODT-2: "Service Period" at a specific index

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

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

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

Constructor Detail

ODT

public ODT(Group parent,
           ModelClassFactory factory)

Creates a new ODT segment

Method Detail

getTrayType

public CE getTrayType()

Returns ODT-1: "Tray Type" - creates it if necessary

getOdt1_TrayType

public CE getOdt1_TrayType()

Returns ODT-1: "Tray Type" - creates it if necessary

getServicePeriod

public CE[] getServicePeriod()

Returns all repetitions of Service Period (ODT-2).

getServicePeriodReps

public int getServicePeriodReps()

Returns a count of the current number of repetitions of Service Period (ODT-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getServicePeriod

public CE getServicePeriod(int rep)

Returns a specific repetition of ODT-2: "Service Period" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOdt2_ServicePeriod

public CE getOdt2_ServicePeriod(int rep)

Returns a specific repetition of ODT-2: "Service Period" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOdt2_ServicePeriodReps

public int getOdt2_ServicePeriodReps()

Returns a count of the current number of repetitions of Service Period (ODT-2). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertServicePeriod

public CE insertServicePeriod(int rep)
                       throws HL7Exception

Inserts a repetition of ODT-2: "Service Period" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertOdt2_ServicePeriod

public CE insertOdt2_ServicePeriod(int rep)
                            throws HL7Exception

Inserts a repetition of ODT-2: "Service Period" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeServicePeriod

public CE removeServicePeriod(int rep)
                       throws HL7Exception

Removes a repetition of ODT-2: "Service Period" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeOdt2_ServicePeriod

public CE removeOdt2_ServicePeriod(int rep)
                            throws HL7Exception

Removes a repetition of ODT-2: "Service Period" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

getTextInstruction

public ST getTextInstruction()

Returns ODT-3: "Text Instruction" - creates it if necessary

getOdt3_TextInstruction

public ST getOdt3_TextInstruction()

Returns ODT-3: "Text Instruction" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment