CodedValue (BICEPS 0.6.1-SNAPSHOT API)

java.lang.Object
- com.draeger.medical.biceps.common.model.CodedValue

Direct Known Subclasses:

CodedWithEquivalents
```
public class CodedValue
extends Object
```
In general, in an interoperability format, objects, attributes, and methods are identified by nomenclature codes. CodedValue offers the ability to represent such nomenclature codes.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`code`
`protected String`	`codingSystem`
`protected List<LocalizedText>`	`codingSystemName`
`protected List<LocalizedText>`	`descriptions`
`protected ExtensionType`	`extension`
`protected String`	`symbolicCodeName`
`protected String`	`version`

Constructor Summary

Constructors
Constructor and Description

CodedValue()

Constructors
Constructor and Description
`CodedValue()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object that)`
`String`	`getCode()` REQUIRED unique identifier of the CODE in the CODING SYSTEM.
`String`	`getCodingSystem()` OPTIONAL unique identifier of a CODING SYSTEM that pm:CodedValue/@Code originating from.
`List<LocalizedText>`	`getCodingSystemName()` Human-readable name of the CODING SYSTEM that is described by pm:CodedValue/@CodingSystem.
`List<LocalizedText>`	`getDescriptions()` Multiple OPTIONAL human-readable texts that describe the CODE in more detail.
`ExtensionType`	`getExtension()` Gets the value of the extension property.
`String`	`getSymbolicCodeName()` Gets the value of the symbolicCodeName property.
`String`	`getVersion()` CodingSystemVersion is a particular version of the CODING SYSTEM defined by pm:CodedValue/@CodingSystem.
`int`	`hashCode()`
`void`	`setCode(String value)` Sets the value of the code property.
`void`	`setCodingSystem(String value)` Sets the value of the codingSystem property.
`void`	`setCodingSystemName(List<LocalizedText> value)`
`void`	`setDescriptions(List<LocalizedText> value)`
`void`	`setExtension(ExtensionType value)` Sets the value of the extension property.
`void`	`setSymbolicCodeName(String value)` Sets the value of the symbolicCodeName property.
`void`	`setVersion(String value)` Sets the value of the version property.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - extension
```
protected ExtensionType extension
```
  - codingSystemName
```
protected List<LocalizedText> codingSystemName
```
  - descriptions
```
protected List<LocalizedText> descriptions
```
  - code
```
protected String code
```
  - codingSystem
```
protected String codingSystem
```
  - version
```
protected String version
```
  - symbolicCodeName
```
protected String symbolicCodeName
```
- Constructor Detail
  - CodedValue
```
public CodedValue()
```
- Method Detail
  - getExtension
```
public ExtensionType getExtension()
```
    Gets the value of the extension property.
    
    Returns:
    
    possible object is ExtensionType
  - setExtension
```
public void setExtension(ExtensionType value)
```
    Sets the value of the extension property.
    
    Parameters:
    
    value - allowed object is ExtensionType
  - getCodingSystemName
```
public List<LocalizedText> getCodingSystemName()
```
    Human-readable name of the CODING SYSTEM that is described by pm:CodedValue/@CodingSystem. Gets the value of the codingSystemName property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the codingSystemName property.
    For example, to add a new item, do as follows:
```
    getCodingSystemName().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list LocalizedText
  - getDescriptions
```
public List<LocalizedText> getDescriptions()
```
    Multiple OPTIONAL human-readable texts that describe the CODE in more detail. Example: "A metric exceeds a given threshold." for the CODE that matches "MDC_EVT_LIMIT_AL_HI". Gets the value of the descriptions property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the descriptions property.
    For example, to add a new item, do as follows:
```
    getDescriptions().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list LocalizedText
  - getCode
```
public String getCode()
```
    REQUIRED unique identifier of the CODE in the CODING SYSTEM. Example: as "20720" from Block 2, of IEEE 11073-10101:2004, is the id for "MDC_PRESS_AWAY", the context-free CODE (CF_Code10) is "151792" which represents the unique identifier used within IEEE 11073-10101:2004.
    
    Returns:
    
    possible object is String
  - setCode
```
public void setCode(String value)
```
    Sets the value of the code property.
    
    Parameters:
    
    value - allowed object is String
  - getCodingSystem
```
public String getCodingSystem()
```
    OPTIONAL unique identifier of a CODING SYSTEM that pm:CodedValue/@Code originating from. If no CODING SYSTEM is defined, the implied value SHALL be "urn:oid:1.2.840.10004.1.1.1.0.0.1", which refers to ISO/IEC 11073-10101. Example: "urn:oid:1.2.840.10004.1.1.1.0.0.1" for the ISO/IEC 11073-10101.
    
    Returns:
    
    possible object is String
  - setCodingSystem
```
public void setCodingSystem(String value)
```
    Sets the value of the codingSystem property.
    
    Parameters:
    
    value - allowed object is String
  - getVersion
```
public String getVersion()
```
    CodingSystemVersion is a particular version of the CODING SYSTEM defined by pm:CodedValue/@CodingSystem. CodingSystemVersion SHALL be set if multiple versions of the underlying CODING SYSTEM exist and a unique identification of the CODED VALUE is not possible by other means. Example: "20041215" for the ISO/IEC 11073-10101:2004, as it is the release date of the standard's first edition.
    
    Returns:
    
    possible object is String
  - setVersion
```
public void setVersion(String value)
```
    Sets the value of the version property.
    
    Parameters:
    
    value - allowed object is String
  - getSymbolicCodeName
```
public String getSymbolicCodeName()
```
    Gets the value of the symbolicCodeName property.
    
    Returns:
    
    possible object is String
  - setSymbolicCodeName
```
public void setSymbolicCodeName(String value)
```
    Sets the value of the symbolicCodeName property.
    
    Parameters:
    
    value - allowed object is String
  - setCodingSystemName
```
public void setCodingSystemName(List<LocalizedText> value)
```
  - setDescriptions
```
public void setDescriptions(List<LocalizedText> value)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class CodedValue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extension

codingSystemName

descriptions

code

codingSystem

version

symbolicCodeName

Constructor Detail

CodedValue

Method Detail

getExtension

setExtension

getCodingSystemName

getDescriptions

getCode

setCode

getCodingSystem

setCodingSystem

getVersion

setVersion

getSymbolicCodeName

setSymbolicCodeName

setCodingSystemName

setDescriptions

toString

equals

hashCode