ca.infoway.messagebuilder.datatype
Interface CD

Type Parameters:

V - the underlying code type.

All Superinterfaces:

ANY<Code>, BareANY, NullFlavorSupport

All Known Subinterfaces:

CE, CS, CV

All Known Implementing Classes:

CDImpl, CEImpl, CSImpl, CVImpl

public interface CD
extends ANY<Code>

HL7 datatype CD. Backed by a Code.

A CD represents any kind of concept usually by giving a code defined in a code system. A CD can contain the original text or phrase that served as the basis of the coding and one or more translations into different coding systems. A CD can also contain qualifiers to describe, e.g., the concept of a "left foot" as a postcoordinated term built from the primary code "FOOT" and the qualifier "LEFT". In cases of an exceptional value, the CD need not contain a code but only the original text describing that concept.

CD is mostly used in one of its restricted or "profiled" forms, CS, CE, CV. Use of the full concept descriptor data type is not common. It requires a conscious decision and documented rationale. In all other cases, one of the CD restrictions shall be used.

All CD restrictions constrain certain properties. Properties may be constrained to the extent that only one value may be allowed for that property, in which case mentioning the property becomes redundant. Constraining a property to one value is referred to as suppressing that property. Although, conceptually a suppressed property is still semantically applicable, it is safe for an HL7 interface to assume the implicit default value without testing.

Author:

Intelliware Development

Method Summary

String	getDisplayName() Returns the display name.
String	getOriginalText() Returns the original text.
List<CD>	getTranslations() Returns the translations for this CD.
void	setDisplayName(String displayName) Sets the display name.
void	setOriginalText(String originalText) Sets the original text.

Methods inherited from interface ca.infoway.messagebuilder.datatype.ANY

getNullFlavor, getValue, isNull, nonNull, notApplicable, other, setNullFlavor, setValue, unknown

Methods inherited from interface ca.infoway.messagebuilder.datatype.BareANY

getBareValue, getDataType, setDataType

Methods inherited from interface ca.infoway.messagebuilder.datatype.nullflavor.NullFlavorSupport

hasNullFlavor

Method Detail

getDisplayName

String getDisplayName()

Returns the display name.

Returns:

the display name

setDisplayName

void setDisplayName(String displayName)

Sets the display name.

Parameters:

displayName - the display name

getTranslations

List<CD> getTranslations()

Returns the translations for this CD.

Returns:

the translations for this CD

getOriginalText

String getOriginalText()

Returns the original text.

Returns:

the original text

setOriginalText

void setOriginalText(String originalText)

Sets the original text.

Parameters:

originalText - the original text