com.merge.HL7.v251.fields
Class HL7FieldCCD

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v251.fields.HL7FieldCCD

public class HL7FieldCCD
extends HL7Field

Specifies whether a charge action is based on an invocation event or is time-based.

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

HL7FieldCCD()
Creates an empty HL7 CCD type field object.

Method Summary

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.
HL7FieldTS	getDatetime() Gets the Date/time component of this field.
java.lang.String	getDatetimeValue() Gets the Date/time component of this field.
java.lang.String	getInvocationEvent() Gets the Invocation Event component of this field.
int	getMaxSize() Gets the number of components defined for this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isDatetimeEmpty() Tells whether the Date/time component has been specified.
boolean	isDatetimeNull() Tells whether the Date/time component has a has Null value as defined by HL7.
boolean	isInvocationEventEmpty() Tells whether the Invocation Event component has been specified.
boolean	isInvocationEventNull() Tells whether the Invocation Event component has a has Null value as defined by HL7.
void	setDatetime(HL7FieldTS val) Sets the Date/time component of this field.
void	setDatetimeValue(java.lang.String val) Sets the Date/time from a string.
void	setInvocationEvent(java.lang.String val) Sets the Invocation Event 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

HL7FieldCCD

public HL7FieldCCD()

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

getInvocationEvent

public java.lang.String getInvocationEvent()

Gets the Invocation Event component of this field.

Returns:

the Invocation Event value

setInvocationEvent

public void setInvocationEvent(java.lang.String val)

Sets the Invocation Event from a string.

Parameters:

val - The value to set for Invocation Event

isInvocationEventEmpty

public boolean isInvocationEventEmpty()

Tells whether the Invocation Event component has been specified.

Returns:

true if the component is empty.

isInvocationEventNull

public boolean isInvocationEventNull()

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

Returns:

true if the component has the HL7 Null value.

getDatetimeValue

public java.lang.String getDatetimeValue()

Gets the Date/time component of this field.

Returns:

the Date/time value

setDatetimeValue

public void setDatetimeValue(java.lang.String val)

Sets the Date/time from a string.

Parameters:

val - The value to set for Date/time

getDatetime

public HL7FieldTS getDatetime()

Gets the Date/time component of this field.

Returns:

An HL7FieldTS object representing Date/time

setDatetime

public void setDatetime(HL7FieldTS val)

Sets the Date/time component of this field.

Parameters:

val - An HL7FieldTS object containing the value to be set.

isDatetimeEmpty

public boolean isDatetimeEmpty()

Tells whether the Date/time component has been specified.

Returns:

true if the component is empty.

isDatetimeNull

public boolean isDatetimeNull()

Tells whether the Date/time component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.