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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class VAR
extends AbstractSegment

Represents an HL7 VAR message segment (Variance). This segment has the following fields:

• VAR-1: Variance Instance ID (EI)
• VAR-2: Documented Date/Time (TS)
• VAR-3: Stated Variance Date/Time (TS) optional
• VAR-4: Variance Originator (XCN) optional repeating
• VAR-5: Variance Classification (CE) optional
• VAR-6: Variance Description (ST) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
TS	getDocumentedDateTime() Returns VAR-2: "Documented Date/Time" - creates it if necessary
TS	getStatedVarianceDateTime() Returns VAR-3: "Stated Variance Date/Time" - creates it if necessary
EI	getVar1_VarianceInstanceID() Returns VAR-1: "Variance Instance ID" - creates it if necessary
TS	getVar2_DocumentedDateTime() Returns VAR-2: "Documented Date/Time" - creates it if necessary
TS	getVar3_StatedVarianceDateTime() Returns VAR-3: "Stated Variance Date/Time" - creates it if necessary
XCN	getVar4_VarianceOriginator(int rep) Returns a specific repetition of VAR-4: "Variance Originator" - creates it if necessary
int	getVar4_VarianceOriginatorReps() Returns a count of the current number of repetitions of Variance Originator (VAR-4).
CE	getVar5_VarianceClassification() Returns VAR-5: "Variance Classification" - creates it if necessary
ST	getVar6_VarianceDescription(int rep) Returns a specific repetition of VAR-6: "Variance Description" - creates it if necessary
int	getVar6_VarianceDescriptionReps() Returns a count of the current number of repetitions of Variance Description (VAR-6).
CE	getVarianceClassification() Returns VAR-5: "Variance Classification" - creates it if necessary
ST[]	getVarianceDescription() Returns all repetitions of Variance Description (VAR-6).
ST	getVarianceDescription(int rep) Returns a specific repetition of VAR-6: "Variance Description" - creates it if necessary
int	getVarianceDescriptionReps() Returns a count of the current number of repetitions of Variance Description (VAR-6).
EI	getVarianceInstanceID() Returns VAR-1: "Variance Instance ID" - creates it if necessary
XCN[]	getVarianceOriginator() Returns all repetitions of Variance Originator (VAR-4).
XCN	getVarianceOriginator(int rep) Returns a specific repetition of VAR-4: "Variance Originator" - creates it if necessary
int	getVarianceOriginatorReps() Returns a count of the current number of repetitions of Variance Originator (VAR-4).
XCN	insertVar4_VarianceOriginator(int rep) Inserts a repetition of VAR-4: "Variance Originator" at a specific index
ST	insertVar6_VarianceDescription(int rep) Inserts a repetition of VAR-6: "Variance Description" at a specific index
ST	insertVarianceDescription(int rep) Inserts a repetition of VAR-6: "Variance Description" at a specific index
XCN	insertVarianceOriginator(int rep) Inserts a repetition of VAR-4: "Variance Originator" at a specific index
XCN	removeVar4_VarianceOriginator(int rep) Removes a repetition of VAR-4: "Variance Originator" at a specific index
ST	removeVar6_VarianceDescription(int rep) Removes a repetition of VAR-6: "Variance Description" at a specific index
ST	removeVarianceDescription(int rep) Removes a repetition of VAR-6: "Variance Description" at a specific index
XCN	removeVarianceOriginator(int rep) Removes a repetition of VAR-4: "Variance Originator" 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

VAR

public VAR(Group parent,
           ModelClassFactory factory)

Creates a new VAR segment

Method Detail

getVarianceInstanceID

public EI getVarianceInstanceID()

Returns VAR-1: "Variance Instance ID" - creates it if necessary

getVar1_VarianceInstanceID

public EI getVar1_VarianceInstanceID()

Returns VAR-1: "Variance Instance ID" - creates it if necessary

getDocumentedDateTime

public TS getDocumentedDateTime()

Returns VAR-2: "Documented Date/Time" - creates it if necessary

getVar2_DocumentedDateTime

public TS getVar2_DocumentedDateTime()

Returns VAR-2: "Documented Date/Time" - creates it if necessary

getStatedVarianceDateTime

public TS getStatedVarianceDateTime()

Returns VAR-3: "Stated Variance Date/Time" - creates it if necessary

getVar3_StatedVarianceDateTime

public TS getVar3_StatedVarianceDateTime()

Returns VAR-3: "Stated Variance Date/Time" - creates it if necessary

getVarianceOriginator

public XCN[] getVarianceOriginator()

Returns all repetitions of Variance Originator (VAR-4).

getVarianceOriginatorReps

public int getVarianceOriginatorReps()

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

getVarianceOriginator

public XCN getVarianceOriginator(int rep)

Returns a specific repetition of VAR-4: "Variance Originator" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getVar4_VarianceOriginator

public XCN getVar4_VarianceOriginator(int rep)

Returns a specific repetition of VAR-4: "Variance Originator" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getVar4_VarianceOriginatorReps

public int getVar4_VarianceOriginatorReps()

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

insertVarianceOriginator

public XCN insertVarianceOriginator(int rep)
                             throws HL7Exception

Inserts a repetition of VAR-4: "Variance Originator" 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)

insertVar4_VarianceOriginator

public XCN insertVar4_VarianceOriginator(int rep)
                                  throws HL7Exception

Inserts a repetition of VAR-4: "Variance Originator" 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)

removeVarianceOriginator

public XCN removeVarianceOriginator(int rep)
                             throws HL7Exception

Removes a repetition of VAR-4: "Variance Originator" 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)

removeVar4_VarianceOriginator

public XCN removeVar4_VarianceOriginator(int rep)
                                  throws HL7Exception

Removes a repetition of VAR-4: "Variance Originator" 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)

getVarianceClassification

public CE getVarianceClassification()

Returns VAR-5: "Variance Classification" - creates it if necessary

getVar5_VarianceClassification

public CE getVar5_VarianceClassification()

Returns VAR-5: "Variance Classification" - creates it if necessary

getVarianceDescription

public ST[] getVarianceDescription()

Returns all repetitions of Variance Description (VAR-6).

getVarianceDescriptionReps

public int getVarianceDescriptionReps()

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

getVarianceDescription

public ST getVarianceDescription(int rep)

Returns a specific repetition of VAR-6: "Variance Description" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getVar6_VarianceDescription

public ST getVar6_VarianceDescription(int rep)

Returns a specific repetition of VAR-6: "Variance Description" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getVar6_VarianceDescriptionReps

public int getVar6_VarianceDescriptionReps()

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

insertVarianceDescription

public ST insertVarianceDescription(int rep)
                             throws HL7Exception

Inserts a repetition of VAR-6: "Variance Description" 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)

insertVar6_VarianceDescription

public ST insertVar6_VarianceDescription(int rep)
                                  throws HL7Exception

Inserts a repetition of VAR-6: "Variance Description" 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)

removeVarianceDescription

public ST removeVarianceDescription(int rep)
                             throws HL7Exception

Removes a repetition of VAR-6: "Variance Description" 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)

removeVar6_VarianceDescription

public ST removeVar6_VarianceDescription(int rep)
                                  throws HL7Exception

Removes a repetition of VAR-6: "Variance Description" 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