CodingDt (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseIdentifiableElement
  - - ca.uhn.fhir.model.base.composite.BaseCodingDt
    - - ca.uhn.fhir.model.dstu2.composite.CodingDt

All Implemented Interfaces:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, IQueryParameterType, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseCoding, IBaseDatatype, ICompositeType
```
public class CodingDt
extends BaseCodingDt
implements ICompositeDatatype, IBaseCoding
```
HAPI/FHIR CodingDt Datatype ()
Definition: A reference to a code defined by a terminology system

Requirements: References to codes are very common in healthcare models

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`CodingDt()` Constructor
`CodingDt(BaseCodingDt theCoding)` Copy constructor: Creates a new Coding with the system and code copied out of the given coding
`CodingDt(String theSystem, String theCode)` Creates a new Coding with the given system and code

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`String`	`getCode()` Gets the value(s) for code ().
`CodeDt`	`getCodeElement()` Gets the value(s) for code ().
`String`	`getDisplay()` Gets the value(s) for display ().
`StringDt`	`getDisplayElement()` Gets the value(s) for display ().
`String`	`getSystem()` Gets the value(s) for system ().
`UriDt`	`getSystemElement()` Gets the value(s) for system ().
`Boolean`	`getUserSelected()` Gets the value(s) for userSelected ().
`BooleanDt`	`getUserSelectedElement()` Gets the value(s) for userSelected ().
`String`	`getVersion()` Gets the value(s) for version ().
`StringDt`	`getVersionElement()` Gets the value(s) for version ().
`boolean`	`isEmpty()`
`CodingDt`	`setCode(CodeDt theValue)` Sets the value(s) for code ()
`CodingDt`	`setCode(String theCode)` Sets the value for code ()
`CodingDt`	`setDisplay(String theString)` Sets the value for display ()
`CodingDt`	`setDisplay(StringDt theValue)` Sets the value(s) for display ()
`CodingDt`	`setSystem(String theUri)` Sets the value for system ()
`CodingDt`	`setSystem(UriDt theValue)` Sets the value(s) for system ()
`CodingDt`	`setUserSelected(boolean theBoolean)` Sets the value for userSelected ()
`CodingDt`	`setUserSelected(BooleanDt theValue)` Sets the value(s) for userSelected ()
`CodingDt`	`setVersion(String theString)` Sets the value for version ()
`CodingDt`	`setVersion(StringDt theValue)` Sets the value(s) for version ()

Methods inherited from class ca.uhn.fhir.model.base.composite.BaseCodingDt
getMissing, getQueryParameterQualifier, getValueAsQueryToken, matchesSystemAndCode, matchesToken, setMissing, setValueAsQueryToken

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

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

- Constructor Detail
  - CodingDt
```
public CodingDt()
```
    Constructor
  - CodingDt
```
public CodingDt(String theSystem,
                String theCode)
```
    Creates a new Coding with the given system and code
  - CodingDt
```
public CodingDt(BaseCodingDt theCoding)
```
    Copy constructor: Creates a new Coding with the system and code copied out of the given coding
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getSystemElement
```
public UriDt getSystemElement()
```
    Gets the value(s) for system (). creating it if it does not exist. Will not return null.
    Definition: The identification of the code system that defines the meaning of the symbol in the code.
    
    Specified by:
    
    getSystemElement in class BaseCodingDt
  - getSystem
```
public String getSystem()
```
    Gets the value(s) for system (). creating it if it does not exist. Will not return null.
    Definition: The identification of the code system that defines the meaning of the symbol in the code.
    
    Specified by:
    
    getSystem in interface IBaseCoding
  - setSystem
```
public CodingDt setSystem(UriDt theValue)
```
    Sets the value(s) for system ()
    Definition: The identification of the code system that defines the meaning of the symbol in the code.
  - setSystem
```
public CodingDt setSystem(String theUri)
```
    Sets the value for system ()
    Definition: The identification of the code system that defines the meaning of the symbol in the code.
    
    Specified by:
    
    setSystem in interface IBaseCoding
    
    Specified by:
    
    setSystem in class BaseCodingDt
  - getVersionElement
```
public StringDt getVersionElement()
```
    Gets the value(s) for version (). creating it if it does not exist. Will not return null.
    Definition: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged
  - getVersion
```
public String getVersion()
```
    Gets the value(s) for version (). creating it if it does not exist. Will not return null.
    Definition: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged
  - setVersion
```
public CodingDt setVersion(StringDt theValue)
```
    Sets the value(s) for version ()
    Definition: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged
  - setVersion
```
public CodingDt setVersion(String theString)
```
    Sets the value for version ()
    Definition: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged
  - getCodeElement
```
public CodeDt getCodeElement()
```
    Gets the value(s) for code (). creating it if it does not exist. Will not return null.
    Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)
    
    Specified by:
    
    getCodeElement in class BaseCodingDt
  - getCode
```
public String getCode()
```
    Gets the value(s) for code (). creating it if it does not exist. Will not return null.
    Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)
    
    Specified by:
    
    getCode in interface IBaseCoding
  - setCode
```
public CodingDt setCode(CodeDt theValue)
```
    Sets the value(s) for code ()
    Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)
  - setCode
```
public CodingDt setCode(String theCode)
```
    Sets the value for code ()
    Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)
    
    Specified by:
    
    setCode in interface IBaseCoding
    
    Specified by:
    
    setCode in class BaseCodingDt
  - getDisplayElement
```
public StringDt getDisplayElement()
```
    Gets the value(s) for display (). creating it if it does not exist. Will not return null.
    Definition: A representation of the meaning of the code in the system, following the rules of the system
    
    Specified by:
    
    getDisplayElement in class BaseCodingDt
  - getDisplay
```
public String getDisplay()
```
    Gets the value(s) for display (). creating it if it does not exist. Will not return null.
    Definition: A representation of the meaning of the code in the system, following the rules of the system
    
    Specified by:
    
    getDisplay in interface IBaseCoding
  - setDisplay
```
public CodingDt setDisplay(StringDt theValue)
```
    Sets the value(s) for display ()
    Definition: A representation of the meaning of the code in the system, following the rules of the system
  - setDisplay
```
public CodingDt setDisplay(String theString)
```
    Sets the value for display ()
    Definition: A representation of the meaning of the code in the system, following the rules of the system
    
    Specified by:
    
    setDisplay in interface IBaseCoding
    
    Specified by:
    
    setDisplay in class BaseCodingDt
  - getUserSelectedElement
```
public BooleanDt getUserSelectedElement()
```
    Gets the value(s) for userSelected (). creating it if it does not exist. Will not return null.
    Definition: Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays)
  - getUserSelected
```
public Boolean getUserSelected()
```
    Gets the value(s) for userSelected (). creating it if it does not exist. Will not return null.
    Definition: Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays)
  - setUserSelected
```
public CodingDt setUserSelected(BooleanDt theValue)
```
    Sets the value(s) for userSelected ()
    Definition: Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays)
  - setUserSelected
```
public CodingDt setUserSelected(boolean theBoolean)
```
    Sets the value for userSelected ()
    Definition: Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays)

Class CodingDt

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.base.composite.BaseCodingDt

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Constructor Detail

CodingDt

CodingDt

CodingDt

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getSystemElement

getSystem

setSystem

setSystem

getVersionElement

getVersion

setVersion

setVersion

getCodeElement

getCode

setCode

setCode

getDisplayElement

getDisplay

setDisplay

setDisplay

getUserSelectedElement

getUserSelected

setUserSelected

setUserSelected