com.merge.HL7.v260.fields
Class HL7FieldCF

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

public class HL7FieldCF
extends HL7Field

This data type transmits codes and the formatted text associated with the code. This data type can be used to transmit for the first time the formatted text for the canned text portion of a report, for example, a standard radiological description for a normal chest X ray. The receiving system can store this information and in subsequent messages only the identifier need be sent. Another potential use of this data type is transmitting master file records that contain formatted text. This data type has six components as follows:

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

HL7FieldCF()
Creates an empty HL7 CF type field object.

Method Summary

java.lang.String	getAlternateFormattedText() Gets the Alternate Formatted Text component of this field.
java.lang.String	getAlternateIdentifier() Gets the Alternate Identifier 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	getFormattedText() Gets the Formatted Text component of 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	getTableNo(int index) Gets the table identifier of a component in this field.
boolean	isAlternateFormattedTextEmpty() Tells whether the Alternate Formatted Text component has been specified.
boolean	isAlternateFormattedTextNull() Tells whether the Alternate Formatted Text 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	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isFormattedTextEmpty() Tells whether the Formatted Text component has been specified.
boolean	isFormattedTextNull() Tells whether the Formatted Text component has a has Null value as defined by HL7.
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.
void	setAlternateFormattedText(java.lang.String val) Sets the Alternate Formatted Text from a string.
void	setAlternateIdentifier(java.lang.String val) Sets the Alternate Identifier from a string.
void	setFormattedText(java.lang.String val) Sets the Formatted Text 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.

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

HL7FieldCF

public HL7FieldCF()

Creates an empty HL7 CF 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.

getFormattedText

public java.lang.String getFormattedText()

Gets the Formatted Text component of this field.

Returns:

the Formatted Text value

setFormattedText

public void setFormattedText(java.lang.String val)

Sets the Formatted Text from a string.

Parameters:

val - The value to set for Formatted Text

isFormattedTextEmpty

public boolean isFormattedTextEmpty()

Tells whether the Formatted Text component has been specified.

Returns:

true if the component is empty.

isFormattedTextNull

public boolean isFormattedTextNull()

Tells whether the Formatted 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.

getAlternateFormattedText

public java.lang.String getAlternateFormattedText()

Gets the Alternate Formatted Text component of this field.

Returns:

the Alternate Formatted Text value

setAlternateFormattedText

public void setAlternateFormattedText(java.lang.String val)

Sets the Alternate Formatted Text from a string.

Parameters:

val - The value to set for Alternate Formatted Text

isAlternateFormattedTextEmpty

public boolean isAlternateFormattedTextEmpty()

Tells whether the Alternate Formatted Text component has been specified.

Returns:

true if the component is empty.

isAlternateFormattedTextNull

public boolean isAlternateFormattedTextNull()

Tells whether the Alternate Formatted 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.