ca.uhn.hl7v2.model.v21.segment

Class NTE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v21.segment.NTE

All Implemented Interfaces:

Segment, Structure, Serializable

public class NTE
extends AbstractSegment

Represents an HL7 NTE message segment (NOTES AND COMMENTS). This segment has the following fields:

• NTE-1: SET ID - NOTES AND COMMENTS (SI) optional
• NTE-2: SOURCE OF COMMENT (ID) optional
• NTE-3: COMMENT (TX) repeating

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
NTE(Group parent, ModelClassFactory factory) Creates a new NTE segment

Method Summary

Methods

Modifier and Type	Method and Description
protected Type	createNewTypeWithoutReflection(int field)
TX[]	getCOMMENT() Returns all repetitions of COMMENT (NTE-3).
TX	getCOMMENT(int rep) Returns a specific repetition of NTE-3: "COMMENT" - creates it if necessary
int	getCOMMENTReps() Returns a count of the current number of repetitions of COMMENT (NTE-3).
SI	getNte1_SETIDNOTESANDCOMMENTS() Returns NTE-1: "SET ID - NOTES AND COMMENTS" - creates it if necessary
ID	getNte2_SOURCEOFCOMMENT() Returns NTE-2: "SOURCE OF COMMENT" - creates it if necessary
TX[]	getNte3_COMMENT() Returns all repetitions of COMMENT (NTE-3).
TX	getNte3_COMMENT(int rep) Returns a specific repetition of NTE-3: "COMMENT" - creates it if necessary
int	getNte3_COMMENTReps() Returns a count of the current number of repetitions of COMMENT (NTE-3).
SI	getSETIDNOTESANDCOMMENTS() Returns NTE-1: "SET ID - NOTES AND COMMENTS" - creates it if necessary
ID	getSOURCEOFCOMMENT() Returns NTE-2: "SOURCE OF COMMENT" - creates it if necessary
TX	insertCOMMENT(int rep) Inserts a repetition of NTE-3: "COMMENT" at a specific index
TX	insertNte3_COMMENT(int rep) Inserts a repetition of NTE-3: "COMMENT" at a specific index
TX	removeCOMMENT(int rep) Removes a repetition of NTE-3: "COMMENT" at a specific index
TX	removeNte3_COMMENT(int rep) Removes a repetition of NTE-3: "COMMENT" at a specific index

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

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isRequired, main, numFields, parse, removeRepetition

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

getMessage, getParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Detail

NTE

public NTE(Group parent,
   ModelClassFactory factory)

Creates a new NTE segment

Method Detail

getSETIDNOTESANDCOMMENTS

public SI getSETIDNOTESANDCOMMENTS()

Returns NTE-1: "SET ID - NOTES AND COMMENTS" - creates it if necessary

getNte1_SETIDNOTESANDCOMMENTS

public SI getNte1_SETIDNOTESANDCOMMENTS()

Returns NTE-1: "SET ID - NOTES AND COMMENTS" - creates it if necessary

getSOURCEOFCOMMENT

public ID getSOURCEOFCOMMENT()

Returns NTE-2: "SOURCE OF COMMENT" - creates it if necessary

getNte2_SOURCEOFCOMMENT

public ID getNte2_SOURCEOFCOMMENT()

Returns NTE-2: "SOURCE OF COMMENT" - creates it if necessary

getCOMMENT

public TX[] getCOMMENT()

Returns all repetitions of COMMENT (NTE-3).

getNte3_COMMENT

public TX[] getNte3_COMMENT()

Returns all repetitions of COMMENT (NTE-3).

getCOMMENTReps

public int getCOMMENTReps()

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

getCOMMENT

public TX getCOMMENT(int rep)

Returns a specific repetition of NTE-3: "COMMENT" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNte3_COMMENT

public TX getNte3_COMMENT(int rep)

Returns a specific repetition of NTE-3: "COMMENT" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getNte3_COMMENTReps

public int getNte3_COMMENTReps()

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

insertCOMMENT

public TX insertCOMMENT(int rep)
                 throws HL7Exception

Inserts a repetition of NTE-3: "COMMENT" 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)

insertNte3_COMMENT

public TX insertNte3_COMMENT(int rep)
                      throws HL7Exception

Inserts a repetition of NTE-3: "COMMENT" 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)

removeCOMMENT

public TX removeCOMMENT(int rep)
                 throws HL7Exception

Removes a repetition of NTE-3: "COMMENT" 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)

removeNte3_COMMENT

public TX removeNte3_COMMENT(int rep)
                      throws HL7Exception

Removes a repetition of NTE-3: "COMMENT" 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