com.merge.HL7.v260.fields
Class HL7FieldCWE

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v260.fields.HL7FieldCWE

public class HL7FieldCWE
extends HL7Field

Specifies a coded element and its associated detail. The CWE data type is used when 1) more than one table may be applicable or 2) the specified HL7 or externally defined table may be extended with local values or 3) when text is in place, the code may be omitted.

Nested Class Summary

Nested classes/interfaces inherited from class com.merge.HL7.HL7Field

HL7Field.FieldFormatter

Field Summary

Fields inherited from class com.merge.HL7.HL7Field

EMPTY_VALUE, NULL_VALUE

Constructor Summary

HL7FieldCWE()
Creates an empty HL7 CWE type field object.

Method Summary

java.lang.String	getAlternateCodingSystemVersionID() Gets the Alternate Coding System Version ID component of this field.
java.lang.String	getAlternateIdentifier() Gets the Alternate Identifier component of this field.
java.lang.String	getAlternateText() Gets the Alternate Text component of this field.
java.lang.String	getCodingSystemVersionID() Gets the Coding System Version ID component of this field.
java.lang.String	getComponentDescription(int index) Gets the description of a component in this field.
int	getComponentLength(int index) Gets the maximum number of characters for a component in this field.
java.lang.String	getComponentType(int index) Gets the HL7 data type of a component in this field.
java.lang.String	getIdentifier() Gets the Identifier component of this field.
int	getMaxSize() Gets the number of components defined for this field.
java.lang.String	getNameofAlternateCodingSystem() Gets the Name of Alternate Coding System component of this field.
java.lang.String	getNameofCodingSystem() Gets the Name of Coding System component of this field.
java.lang.String	getOriginalText() Gets the Original Text component of this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
java.lang.String	getText() Gets the Text component of this field.
boolean	isAlternateCodingSystemVersionIDEmpty() Tells whether the Alternate Coding System Version ID component has been specified.
boolean	isAlternateCodingSystemVersionIDNull() Tells whether the Alternate Coding System Version ID component has a has Null value as defined by HL7.
boolean	isAlternateIdentifierEmpty() Tells whether the Alternate Identifier component has been specified.
boolean	isAlternateIdentifierNull() Tells whether the Alternate Identifier component has a has Null value as defined by HL7.
boolean	isAlternateTextEmpty() Tells whether the Alternate Text component has been specified.
boolean	isAlternateTextNull() Tells whether the Alternate Text component has a has Null value as defined by HL7.
boolean	isCodingSystemVersionIDEmpty() Tells whether the Coding System Version ID component has been specified.
boolean	isCodingSystemVersionIDNull() Tells whether the Coding System Version ID component has a has Null value as defined by HL7.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isIdentifierEmpty() Tells whether the Identifier component has been specified.
boolean	isIdentifierNull() Tells whether the Identifier component has a has Null value as defined by HL7.
boolean	isNameofAlternateCodingSystemEmpty() Tells whether the Name of Alternate Coding System component has been specified.
boolean	isNameofAlternateCodingSystemNull() Tells whether the Name of Alternate Coding System component has a has Null value as defined by HL7.
boolean	isNameofCodingSystemEmpty() Tells whether the Name of Coding System component has been specified.
boolean	isNameofCodingSystemNull() Tells whether the Name of Coding System component has a has Null value as defined by HL7.
boolean	isOriginalTextEmpty() Tells whether the Original Text component has been specified.
boolean	isOriginalTextNull() Tells whether the Original Text component has a has Null value as defined by HL7.
boolean	isTextEmpty() Tells whether the Text component has been specified.
boolean	isTextNull() Tells whether the Text component has a has Null value as defined by HL7.
void	setAlternateCodingSystemVersionID(java.lang.String val) Sets the Alternate Coding System Version ID from a string.
void	setAlternateIdentifier(java.lang.String val) Sets the Alternate Identifier from a string.
void	setAlternateText(java.lang.String val) Sets the Alternate Text from a string.
void	setCodingSystemVersionID(java.lang.String val) Sets the Coding System Version ID from a string.
void	setIdentifier(java.lang.String val) Sets the Identifier from a string.
void	setNameofAlternateCodingSystem(java.lang.String val) Sets the Name of Alternate Coding System from a string.
void	setNameofCodingSystem(java.lang.String val) Sets the Name of Coding System from a string.
void	setOriginalText(java.lang.String val) Sets the Original Text from a string.
void	setText(java.lang.String val) Sets the Text from a string.

Methods inherited from class com.merge.HL7.HL7Field

clone, createField, createField, getBoolValue, getComponent, getContent, getContent, getContent, getDataType, getDateValue, getDoubleValue, getFieldFormatter, getFieldName, getHL7Version, getIntValue, getMinSize, getValue, getValue, isBasicType, isEmpty, isNull, setComponent, setContent, setContent, setFieldClass, setFormatter, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, size, toAnnotatedString, toAnnotatedString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HL7FieldCWE

public HL7FieldCWE()

Creates an empty HL7 CWE type field object.

Method Detail

getMaxSize

public int getMaxSize()

Gets the number of components defined for this field.

Overrides:

getMaxSize in class HL7Field

Returns:

The maximum number of components.

getComponentType

public java.lang.String getComponentType(int index)

Gets the HL7 data type of a component in this field.

Overrides:

getComponentType in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's data type.

getComponentDescription

public java.lang.String getComponentDescription(int index)

Gets the description of a component in this field.

Overrides:

getComponentDescription in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's description.

getComponentLength

public int getComponentLength(int index)

Gets the maximum number of characters for a component in this field.

Overrides:

getComponentLength in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

The maximum length of the component as defined by HL7.

isComponentMandatory

public boolean isComponentMandatory(int index)

Tells whether a component is mandatory.

Overrides:

isComponentMandatory in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

true if the specified component is mandatory.

getTableNo

public java.lang.String getTableNo(int index)

Gets the table identifier of a component in this field.

Overrides:

getTableNo in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the table number as defined by HL7 or an empty string if a table number is not defined.

getIdentifier

public java.lang.String getIdentifier()

Gets the Identifier component of this field.

Returns:

the Identifier value

setIdentifier

public void setIdentifier(java.lang.String val)

Sets the Identifier from a string.

Parameters:

val - The value to set for Identifier

isIdentifierEmpty

public boolean isIdentifierEmpty()

Tells whether the Identifier component has been specified.

Returns:

true if the component is empty.

isIdentifierNull

public boolean isIdentifierNull()

Tells whether the Identifier component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getText

public java.lang.String getText()

Gets the Text component of this field.

Returns:

the Text value

setText

public void setText(java.lang.String val)

Sets the Text from a string.

Parameters:

val - The value to set for Text

isTextEmpty

public boolean isTextEmpty()

Tells whether the Text component has been specified.

Returns:

true if the component is empty.

isTextNull

public boolean isTextNull()

Tells whether the Text component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getNameofCodingSystem

public java.lang.String getNameofCodingSystem()

Gets the Name of Coding System component of this field.

Returns:

the Name of Coding System value

setNameofCodingSystem

public void setNameofCodingSystem(java.lang.String val)

Sets the Name of Coding System from a string.

Parameters:

val - The value to set for Name of Coding System

isNameofCodingSystemEmpty

public boolean isNameofCodingSystemEmpty()

Tells whether the Name of Coding System component has been specified.

Returns:

true if the component is empty.

isNameofCodingSystemNull

public boolean isNameofCodingSystemNull()

Tells whether the Name of Coding System component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getAlternateIdentifier

public java.lang.String getAlternateIdentifier()

Gets the Alternate Identifier component of this field.

Returns:

the Alternate Identifier value

setAlternateIdentifier

public void setAlternateIdentifier(java.lang.String val)

Sets the Alternate Identifier from a string.

Parameters:

val - The value to set for Alternate Identifier

isAlternateIdentifierEmpty

public boolean isAlternateIdentifierEmpty()

Tells whether the Alternate Identifier component has been specified.

Returns:

true if the component is empty.

isAlternateIdentifierNull

public boolean isAlternateIdentifierNull()

Tells whether the Alternate Identifier component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getAlternateText

public java.lang.String getAlternateText()

Gets the Alternate Text component of this field.

Returns:

the Alternate Text value

setAlternateText

public void setAlternateText(java.lang.String val)

Sets the Alternate Text from a string.

Parameters:

val - The value to set for Alternate Text

isAlternateTextEmpty

public boolean isAlternateTextEmpty()

Tells whether the Alternate Text component has been specified.

Returns:

true if the component is empty.

isAlternateTextNull

public boolean isAlternateTextNull()

Tells whether the Alternate Text component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getNameofAlternateCodingSystem

public java.lang.String getNameofAlternateCodingSystem()

Gets the Name of Alternate Coding System component of this field.

Returns:

the Name of Alternate Coding System value

setNameofAlternateCodingSystem

public void setNameofAlternateCodingSystem(java.lang.String val)

Sets the Name of Alternate Coding System from a string.

Parameters:

val - The value to set for Name of Alternate Coding System

isNameofAlternateCodingSystemEmpty

public boolean isNameofAlternateCodingSystemEmpty()

Tells whether the Name of Alternate Coding System component has been specified.

Returns:

true if the component is empty.

isNameofAlternateCodingSystemNull

public boolean isNameofAlternateCodingSystemNull()

Tells whether the Name of Alternate Coding System component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getCodingSystemVersionID

public java.lang.String getCodingSystemVersionID()

Gets the Coding System Version ID component of this field.

Returns:

the Coding System Version ID value

setCodingSystemVersionID

public void setCodingSystemVersionID(java.lang.String val)

Sets the Coding System Version ID from a string.

Parameters:

val - The value to set for Coding System Version ID

isCodingSystemVersionIDEmpty

public boolean isCodingSystemVersionIDEmpty()

Tells whether the Coding System Version ID component has been specified.

Returns:

true if the component is empty.

isCodingSystemVersionIDNull

public boolean isCodingSystemVersionIDNull()

Tells whether the Coding System Version ID component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getAlternateCodingSystemVersionID

public java.lang.String getAlternateCodingSystemVersionID()

Gets the Alternate Coding System Version ID component of this field.

Returns:

the Alternate Coding System Version ID value

setAlternateCodingSystemVersionID

public void setAlternateCodingSystemVersionID(java.lang.String val)

Sets the Alternate Coding System Version ID from a string.

Parameters:

val - The value to set for Alternate Coding System Version ID

isAlternateCodingSystemVersionIDEmpty

public boolean isAlternateCodingSystemVersionIDEmpty()

Tells whether the Alternate Coding System Version ID component has been specified.

Returns:

true if the component is empty.

isAlternateCodingSystemVersionIDNull

public boolean isAlternateCodingSystemVersionIDNull()

Tells whether the Alternate Coding System Version ID component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getOriginalText

public java.lang.String getOriginalText()

Gets the Original Text component of this field.

Returns:

the Original Text value

setOriginalText

public void setOriginalText(java.lang.String val)

Sets the Original Text from a string.

Parameters:

val - The value to set for Original Text

isOriginalTextEmpty

public boolean isOriginalTextEmpty()

Tells whether the Original Text component has been specified.

Returns:

true if the component is empty.

isOriginalTextNull

public boolean isOriginalTextNull()

Tells whether the Original Text component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.