org.hl7.rim

Interface LanguageCommunication

public interface LanguageCommunication extends RimObject

Interface for RIM class LanguageCommunication.

The language communication capabilities for an Entity.

Examples: A patient who originally came from Mexico may have fluent language capabilities to speak, read and write in Spanish, but only rudimentary capabilities in English. A person from Russia may have the capability to communicate equally well in spoken language in Russian, Armenian or Ukrainian, but prefers to speak in Armenian.

Discussion: While it may seem on the surface that this class would be restricted in usage to only the LivingSubject subtypes, Devices also have the ability to communicate, such as automated telephony devices that transmit patient information to live operators on a triage line or provide automated laboratory results to clinicians.

Rationale: Each Entity with the ability to communicate verbally has differing language and proficiency level. This class specifies the languages with which the entity can communicate, the mode of communication (speak, read, write), the proficiency of that communication, and the Entity's preference.

Method Summary
EntitygetEntity()
Gets association 'entity' to RIM class Entity with cardinality (1..1).
CEgetLanguageCode()
Gets attribute languageCode of type CE and cardinality 0..1.
CEgetModeCode()
Gets attribute modeCode of type CE and cardinality 0..1.
BLgetPreferenceInd()
Gets attribute preferenceInd of type BL and cardinality 0..1.
CEgetProficiencyLevelCode()
Gets attribute proficiencyLevelCode of type CE and cardinality 0..1.
voidsetEntity(Entity value)
Sets association 'entity' to RIM class Entity with cardinality (1..1).
voidsetLanguageCode(CE value)
Sets attribute languageCode of type CE and cardinality 0..1.
voidsetModeCode(CE value)
Sets attribute modeCode of type CE and cardinality 0..1.
voidsetPreferenceInd(BL value)
Sets attribute preferenceInd of type BL and cardinality 0..1.
voidsetProficiencyLevelCode(CE value)
Sets attribute proficiencyLevelCode of type CE and cardinality 0..1.

Method Detail

getEntity

public Entity getEntity()
Gets association 'entity' to RIM class Entity with cardinality (1..1).

Returns: the reference to the linked class

getLanguageCode

public CE getLanguageCode()
Gets attribute languageCode of type CE and cardinality 0..1.

A value representing a language for which the Entity has some level of proficiency for written or spoken communication.

Examples: Spanish, Italian, German, English, American Sign, etc.

Discussion: Communication via spoken or written language is not solely restricted to LivingSubjects. Devices that communicate with persons using human language also must specify in which languages they are capable. Automated voice response systems respond to human language and communicate with other devices or persons using human language.

Rationale: Many individuals and devices have the capability to communicate at varying levels in multiple languages. This code specifies a language capability that the entity wishes to make known.

Returns: the attribute value

getModeCode

public CE getModeCode()
Gets attribute modeCode of type CE and cardinality 0..1.

A value representing the method of expression of the language

Examples: expressed spoken, expressed written, expressed signed, received spoken, received written, received signed

Returns: the attribute value

getPreferenceInd

public BL getPreferenceInd()
Gets attribute preferenceInd of type BL and cardinality 0..1.

An indicator specifying whether or not the language is preferred by the entity for the associated mode.

Returns: the attribute value

getProficiencyLevelCode

public CE getProficiencyLevelCode()
Gets attribute proficiencyLevelCode of type CE and cardinality 0..1.

A value representing the level of proficiency in a language.

Examples: excellent, good, fair, poor

Returns: the attribute value

setEntity

public void setEntity(Entity value)
Sets association 'entity' to RIM class Entity with cardinality (1..1).

Parameters: value the new association value

setLanguageCode

public void setLanguageCode(CE value)
Sets attribute languageCode of type CE and cardinality 0..1.

A value representing a language for which the Entity has some level of proficiency for written or spoken communication.

Examples: Spanish, Italian, German, English, American Sign, etc.

Discussion: Communication via spoken or written language is not solely restricted to LivingSubjects. Devices that communicate with persons using human language also must specify in which languages they are capable. Automated voice response systems respond to human language and communicate with other devices or persons using human language.

Rationale: Many individuals and devices have the capability to communicate at varying levels in multiple languages. This code specifies a language capability that the entity wishes to make known.

Parameters: value the new attribute value

setModeCode

public void setModeCode(CE value)
Sets attribute modeCode of type CE and cardinality 0..1.

A value representing the method of expression of the language

Examples: expressed spoken, expressed written, expressed signed, received spoken, received written, received signed

Parameters: value the new attribute value

setPreferenceInd

public void setPreferenceInd(BL value)
Sets attribute preferenceInd of type BL and cardinality 0..1.

An indicator specifying whether or not the language is preferred by the entity for the associated mode.

Parameters: value the new attribute value

setProficiencyLevelCode

public void setProficiencyLevelCode(CE value)
Sets attribute proficiencyLevelCode of type CE and cardinality 0..1.

A value representing the level of proficiency in a language.

Examples: excellent, good, fair, poor

Parameters: value the new attribute value