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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class ODS
extends AbstractSegment

Represents an HL7 ODS message segment (Dietary Orders, Supplements, and Preferences). This segment has the following fields:

• ODS-1: Type (ID)
• ODS-2: Service Period (CE) optional repeating
• ODS-3: Diet, Supplement, or Preference Code (CE) repeating
• ODS-4: Text Instruction (ST) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
CE[]	getDietSupplementOrPreferenceCode() Returns all repetitions of Diet, Supplement, or Preference Code (ODS-3).
CE	getDietSupplementOrPreferenceCode(int rep) Returns a specific repetition of ODS-3: "Diet, Supplement, or Preference Code" - creates it if necessary
int	getDietSupplementOrPreferenceCodeReps() Returns a count of the current number of repetitions of Diet, Supplement, or Preference Code (ODS-3).
ID	getOds1_Type() Returns ODS-1: "Type" - creates it if necessary
CE	getOds2_ServicePeriod(int rep) Returns a specific repetition of ODS-2: "Service Period" - creates it if necessary
int	getOds2_ServicePeriodReps() Returns a count of the current number of repetitions of Service Period (ODS-2).
CE	getOds3_DietSupplementOrPreferenceCode(int rep) Returns a specific repetition of ODS-3: "Diet, Supplement, or Preference Code" - creates it if necessary
int	getOds3_DietSupplementOrPreferenceCodeReps() Returns a count of the current number of repetitions of Diet, Supplement, or Preference Code (ODS-3).
ST	getOds4_TextInstruction(int rep) Returns a specific repetition of ODS-4: "Text Instruction" - creates it if necessary
int	getOds4_TextInstructionReps() Returns a count of the current number of repetitions of Text Instruction (ODS-4).
CE[]	getServicePeriod() Returns all repetitions of Service Period (ODS-2).
CE	getServicePeriod(int rep) Returns a specific repetition of ODS-2: "Service Period" - creates it if necessary
int	getServicePeriodReps() Returns a count of the current number of repetitions of Service Period (ODS-2).
ST[]	getTextInstruction() Returns all repetitions of Text Instruction (ODS-4).
ST	getTextInstruction(int rep) Returns a specific repetition of ODS-4: "Text Instruction" - creates it if necessary
int	getTextInstructionReps() Returns a count of the current number of repetitions of Text Instruction (ODS-4).
ID	getType() Returns ODS-1: "Type" - creates it if necessary
CE	insertDietSupplementOrPreferenceCode(int rep) Inserts a repetition of ODS-3: "Diet, Supplement, or Preference Code" at a specific index
CE	insertOds2_ServicePeriod(int rep) Inserts a repetition of ODS-2: "Service Period" at a specific index
CE	insertOds3_DietSupplementOrPreferenceCode(int rep) Inserts a repetition of ODS-3: "Diet, Supplement, or Preference Code" at a specific index
ST	insertOds4_TextInstruction(int rep) Inserts a repetition of ODS-4: "Text Instruction" at a specific index
CE	insertServicePeriod(int rep) Inserts a repetition of ODS-2: "Service Period" at a specific index
ST	insertTextInstruction(int rep) Inserts a repetition of ODS-4: "Text Instruction" at a specific index
CE	removeDietSupplementOrPreferenceCode(int rep) Removes a repetition of ODS-3: "Diet, Supplement, or Preference Code" at a specific index
CE	removeOds2_ServicePeriod(int rep) Removes a repetition of ODS-2: "Service Period" at a specific index
CE	removeOds3_DietSupplementOrPreferenceCode(int rep) Removes a repetition of ODS-3: "Diet, Supplement, or Preference Code" at a specific index
ST	removeOds4_TextInstruction(int rep) Removes a repetition of ODS-4: "Text Instruction" at a specific index
CE	removeServicePeriod(int rep) Removes a repetition of ODS-2: "Service Period" at a specific index
ST	removeTextInstruction(int rep) Removes a repetition of ODS-4: "Text Instruction" 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

ODS

public ODS(Group parent,
           ModelClassFactory factory)

Creates a new ODS segment

Method Detail

getType

public ID getType()

Returns ODS-1: "Type" - creates it if necessary

getOds1_Type

public ID getOds1_Type()

Returns ODS-1: "Type" - creates it if necessary

getServicePeriod

public CE[] getServicePeriod()

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

getServicePeriodReps

public int getServicePeriodReps()

Returns a count of the current number of repetitions of Service Period (ODS-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 ODS-2: "Service Period" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOds2_ServicePeriod

public CE getOds2_ServicePeriod(int rep)

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

Parameters:

rep - The repetition index (0-indexed)

getOds2_ServicePeriodReps

public int getOds2_ServicePeriodReps()

Returns a count of the current number of repetitions of Service Period (ODS-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 ODS-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)

insertOds2_ServicePeriod

public CE insertOds2_ServicePeriod(int rep)
                            throws HL7Exception

Inserts a repetition of ODS-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 ODS-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)

removeOds2_ServicePeriod

public CE removeOds2_ServicePeriod(int rep)
                            throws HL7Exception

Removes a repetition of ODS-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)

getDietSupplementOrPreferenceCode

public CE[] getDietSupplementOrPreferenceCode()

Returns all repetitions of Diet, Supplement, or Preference Code (ODS-3).

getDietSupplementOrPreferenceCodeReps

public int getDietSupplementOrPreferenceCodeReps()

Returns a count of the current number of repetitions of Diet, Supplement, or Preference Code (ODS-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getDietSupplementOrPreferenceCode

public CE getDietSupplementOrPreferenceCode(int rep)

Returns a specific repetition of ODS-3: "Diet, Supplement, or Preference Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOds3_DietSupplementOrPreferenceCode

public CE getOds3_DietSupplementOrPreferenceCode(int rep)

Returns a specific repetition of ODS-3: "Diet, Supplement, or Preference Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOds3_DietSupplementOrPreferenceCodeReps

public int getOds3_DietSupplementOrPreferenceCodeReps()

Returns a count of the current number of repetitions of Diet, Supplement, or Preference Code (ODS-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertDietSupplementOrPreferenceCode

public CE insertDietSupplementOrPreferenceCode(int rep)
                                        throws HL7Exception

Inserts a repetition of ODS-3: "Diet, Supplement, or Preference Code" 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)

insertOds3_DietSupplementOrPreferenceCode

public CE insertOds3_DietSupplementOrPreferenceCode(int rep)
                                             throws HL7Exception

Inserts a repetition of ODS-3: "Diet, Supplement, or Preference Code" 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)

removeDietSupplementOrPreferenceCode

public CE removeDietSupplementOrPreferenceCode(int rep)
                                        throws HL7Exception

Removes a repetition of ODS-3: "Diet, Supplement, or Preference Code" 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)

removeOds3_DietSupplementOrPreferenceCode

public CE removeOds3_DietSupplementOrPreferenceCode(int rep)
                                             throws HL7Exception

Removes a repetition of ODS-3: "Diet, Supplement, or Preference Code" 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 all repetitions of Text Instruction (ODS-4).

getTextInstructionReps

public int getTextInstructionReps()

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

getTextInstruction

public ST getTextInstruction(int rep)

Returns a specific repetition of ODS-4: "Text Instruction" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOds4_TextInstruction

public ST getOds4_TextInstruction(int rep)

Returns a specific repetition of ODS-4: "Text Instruction" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getOds4_TextInstructionReps

public int getOds4_TextInstructionReps()

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

insertTextInstruction

public ST insertTextInstruction(int rep)
                         throws HL7Exception

Inserts a repetition of ODS-4: "Text Instruction" 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)

insertOds4_TextInstruction

public ST insertOds4_TextInstruction(int rep)
                              throws HL7Exception

Inserts a repetition of ODS-4: "Text Instruction" 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)

removeTextInstruction

public ST removeTextInstruction(int rep)
                         throws HL7Exception

Removes a repetition of ODS-4: "Text Instruction" 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)

removeOds4_TextInstruction

public ST removeOds4_TextInstruction(int rep)
                              throws HL7Exception

Removes a repetition of ODS-4: "Text Instruction" 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)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment