org.eclipse.ohf.ihe.common.cdar2
Interface CD

All Superinterfaces:
ANY, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
BXITCD, CE, CO, CS1, CV, EIVLEvent, HXITCE, PQR, SXCMCD
All Known Implementing Classes:
BXITCDImpl, CDImpl, CEImpl, COImpl, CS1Impl, CVImpl, EIVLEventImpl, HXITCEImpl, PQRImpl, SXCMCDImpl

public interface CD
extends ANY

A representation of the model object 'CD'. A concept descriptor represents any kind of concept usually by giving a code defined in a code system. A concept descriptor 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 concept descriptor 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 exceptional cases, the concept descriptor need not contain a code but only the original text describing that concept.

The following features are supported:

See Also:
CDAR2Package.getCD()

Method Summary
 java.lang.String getCode()
          Returns the value of the 'Code' attribute.
 java.lang.String getCodeSystem()
          Returns the value of the 'Code System' attribute.
 java.lang.String getCodeSystemName()
          Returns the value of the 'Code System Name' attribute.
 java.lang.String getCodeSystemVersion()
          Returns the value of the 'Code System Version' attribute.
 java.lang.String getDisplayName()
          Returns the value of the 'Display Name' attribute.
 ED getOriginalText()
          Returns the value of the 'Original Text' containment reference.
 org.eclipse.emf.common.util.EList getQualifier()
          Returns the value of the 'Qualifier' containment reference list.
 org.eclipse.emf.common.util.EList getTranslation()
          Returns the value of the 'Translation' containment reference list.
 void setCode(java.lang.String value)
          Sets the value of the 'Code' attribute.
 void setCodeSystem(java.lang.String value)
          Sets the value of the 'Code System' attribute.
 void setCodeSystemName(java.lang.String value)
          Sets the value of the 'Code System Name' attribute.
 void setCodeSystemVersion(java.lang.String value)
          Sets the value of the 'Code System Version' attribute.
 void setDisplayName(java.lang.String value)
          Sets the value of the 'Display Name' attribute.
 void setOriginalText(ED value)
          Sets the value of the 'Original Text' containment reference.
 
Methods inherited from interface org.eclipse.ohf.ihe.common.cdar2.ANY
getNullFlavor, setNullFlavor
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getOriginalText

ED getOriginalText()
Returns the value of the 'Original Text' containment reference. The text or phrase used as the basis for the coding.

Returns:
the value of the 'Original Text' containment reference.
See Also:
setOriginalText(ED), CDAR2Package.getCD_OriginalText()

setOriginalText

void setOriginalText(ED value)
Sets the value of the 'Original Text' containment reference.

Parameters:
value - the new value of the 'Original Text' containment reference.
See Also:
getOriginalText()

getQualifier

org.eclipse.emf.common.util.EList getQualifier()
Returns the value of the 'Qualifier' containment reference list. The list contents are of type CR. Specifies additional codes that increase the specificity of the primary code.

Returns:
the value of the 'Qualifier' containment reference list.
See Also:
CDAR2Package.getCD_Qualifier()

getTranslation

org.eclipse.emf.common.util.EList getTranslation()
Returns the value of the 'Translation' containment reference list. The list contents are of type CD. A set of other concept descriptors that translate this concept descriptor into other code systems.

Returns:
the value of the 'Translation' containment reference list.
See Also:
CDAR2Package.getCD_Translation()

getCode

java.lang.String getCode()
Returns the value of the 'Code' attribute. The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Returns:
the value of the 'Code' attribute.
See Also:
setCode(String), CDAR2Package.getCD_Code()

setCode

void setCode(java.lang.String value)
Sets the value of the 'Code' attribute.

Parameters:
value - the new value of the 'Code' attribute.
See Also:
getCode()

getCodeSystem

java.lang.String getCodeSystem()
Returns the value of the 'Code System' attribute. Specifies the code system that defines the code.

Returns:
the value of the 'Code System' attribute.
See Also:
setCodeSystem(String), CDAR2Package.getCD_CodeSystem()

setCodeSystem

void setCodeSystem(java.lang.String value)
Sets the value of the 'Code System' attribute.

Parameters:
value - the new value of the 'Code System' attribute.
See Also:
getCodeSystem()

getCodeSystemName

java.lang.String getCodeSystemName()
Returns the value of the 'Code System Name' attribute. A common name of the coding system.

Returns:
the value of the 'Code System Name' attribute.
See Also:
setCodeSystemName(String), CDAR2Package.getCD_CodeSystemName()

setCodeSystemName

void setCodeSystemName(java.lang.String value)
Sets the value of the 'Code System Name' attribute.

Parameters:
value - the new value of the 'Code System Name' attribute.
See Also:
getCodeSystemName()

getCodeSystemVersion

java.lang.String getCodeSystemVersion()
Returns the value of the 'Code System Version' attribute. If applicable, a version descriptor defined specifically for the given code system.

Returns:
the value of the 'Code System Version' attribute.
See Also:
setCodeSystemVersion(String), CDAR2Package.getCD_CodeSystemVersion()

setCodeSystemVersion

void setCodeSystemVersion(java.lang.String value)
Sets the value of the 'Code System Version' attribute.

Parameters:
value - the new value of the 'Code System Version' attribute.
See Also:
getCodeSystemVersion()

getDisplayName

java.lang.String getDisplayName()
Returns the value of the 'Display Name' attribute. A name or title for the code, under which the sending system shows the code value to its users.

Returns:
the value of the 'Display Name' attribute.
See Also:
setDisplayName(String), CDAR2Package.getCD_DisplayName()

setDisplayName

void setDisplayName(java.lang.String value)
Sets the value of the 'Display Name' attribute.

Parameters:
value - the new value of the 'Display Name' attribute.
See Also:
getDisplayName()