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

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.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 - NTE (SI) optional
• NTE-2: Source of Comment (ID) optional
• NTE-3: Comment (FT) optional repeating
• NTE-4: Comment Type (CE) optional

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
FT[]	getComment() Returns all repetitions of Comment (NTE-3).
FT	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).
CE	getCommentType() Returns NTE-4: "Comment Type" - creates it if necessary
SI	getNte1_SetIDNTE() Returns NTE-1: "Set ID - NTE" - creates it if necessary
ID	getNte2_SourceOfComment() Returns NTE-2: "Source of Comment" - creates it if necessary
FT	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).
CE	getNte4_CommentType() Returns NTE-4: "Comment Type" - creates it if necessary
SI	getSetIDNTE() Returns NTE-1: "Set ID - NTE" - creates it if necessary
ID	getSourceOfComment() Returns NTE-2: "Source of Comment" - creates it if necessary
FT	insertComment(int rep) Inserts a repetition of NTE-3: "Comment" at a specific index
FT	insertNte3_Comment(int rep) Inserts a repetition of NTE-3: "Comment" at a specific index
FT	removeComment(int rep) Removes a repetition of NTE-3: "Comment" at a specific index
FT	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, 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

NTE

public NTE(Group parent,
           ModelClassFactory factory)

Creates a new NTE segment

Method Detail

getSetIDNTE

public SI getSetIDNTE()

Returns NTE-1: "Set ID - NTE" - creates it if necessary

getNte1_SetIDNTE

public SI getNte1_SetIDNTE()

Returns NTE-1: "Set ID - NTE" - 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 FT[] getComment()

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 FT 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 FT 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 FT 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 FT 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 FT 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 FT 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)

getCommentType

public CE getCommentType()

Returns NTE-4: "Comment Type" - creates it if necessary

getNte4_CommentType

public CE getNte4_CommentType()

Returns NTE-4: "Comment Type" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment