java.lang.Object
- org.hl7.fhir.dstu2.model.Base
- - org.hl7.fhir.dstu2.model.Element
  - - org.hl7.fhir.dstu2.model.Type
    - - org.hl7.fhir.dstu2.model.Coding

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseCoding, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType
```
public class Coding
extends Type
implements org.hl7.fhir.instance.model.api.IBaseCoding, org.hl7.fhir.instance.model.api.ICompositeType
```
A reference to a code defined by a terminology system.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected CodeType`	`code`	A symbol in syntax defined by the system.
`protected StringType`	`display`	A representation of the meaning of the code in the system, following the rules of the system.
`protected UriType`	`system`	The identification of the code system that defines the meaning of the symbol in the code.
`protected BooleanType`	`userSelected`	Indicates that this coding was chosen by a user directly - i.e.
`protected StringType`	`version`	The version of the code system which was used when choosing this code.

Fields inherited from class org.hl7.fhir.dstu2.model.Element
extension, id

Constructor Summary

Constructors
Constructor Description

Coding()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Base`	`addChild(String name)`
`Coding`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`String`	`getCode()`
`CodeType`	`getCodeElement()`
`String`	`getDisplay()`
`StringType`	`getDisplayElement()`
`String`	`getSystem()`
`UriType`	`getSystemElement()`
`boolean`	`getUserSelected()`
`BooleanType`	`getUserSelectedElement()`
`String`	`getVersion()`
`StringType`	`getVersionElement()`
`boolean`	`hasCode()`
`boolean`	`hasCodeElement()`
`boolean`	`hasDisplay()`
`boolean`	`hasDisplayElement()`
`boolean`	`hasSystem()`
`boolean`	`hasSystemElement()`
`boolean`	`hasUserSelected()`
`boolean`	`hasUserSelectedElement()`
`boolean`	`hasVersion()`
`boolean`	`hasVersionElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Coding`	`setCode(String value)`
`Coding`	`setCodeElement(CodeType value)`
`Coding`	`setDisplay(String value)`
`Coding`	`setDisplayElement(StringType value)`
`void`	`setProperty(String name, Base value)`
`Coding`	`setSystem(String value)`
`Coding`	`setSystemElement(UriType value)`
`Coding`	`setUserSelected(boolean value)`
`Coding`	`setUserSelectedElement(BooleanType value)`
`Coding`	`setVersion(String value)`
`Coding`	`setVersionElement(StringType value)`
`protected Coding`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2.model.Element
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData

- Field Detail
  - system
```
protected UriType system
```
    The identification of the code system that defines the meaning of the symbol in the code.
  - version
```
protected StringType version
```
    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.
  - code
```
protected CodeType code
```
    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).
  - display
```
protected StringType display
```
    A representation of the meaning of the code in the system, following the rules of the system.
  - userSelected
```
protected BooleanType userSelected
```
    Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
- Constructor Detail
  - Coding
```
public Coding()
```
- Method Detail
  - getSystemElement
```
public UriType getSystemElement()
```
    Returns:
    
    system (The identification of the code system that defines the meaning of the symbol in the code.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value
  - hasSystemElement
```
public boolean hasSystemElement()
```
  - hasSystem
```
public boolean hasSystem()
```
  - setSystemElement
```
public Coding setSystemElement(UriType value)
```
    Parameters:
    
    value - system (The identification of the code system that defines the meaning of the symbol in the code.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value
  - getSystem
```
public String getSystem()
```
    Specified by:
    
    getSystem in interface org.hl7.fhir.instance.model.api.IBaseCoding
    
    Returns:
    
    The identification of the code system that defines the meaning of the symbol in the code.
  - setSystem
```
public Coding setSystem(String value)
```
    Specified by:
    
    setSystem in interface org.hl7.fhir.instance.model.api.IBaseCoding
    
    Parameters:
    
    value - The identification of the code system that defines the meaning of the symbol in the code.
  - getVersionElement
```
public StringType getVersionElement()
```
    Returns:
    
    version (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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
  - hasVersionElement
```
public boolean hasVersionElement()
```
  - hasVersion
```
public boolean hasVersion()
```
  - setVersionElement
```
public Coding setVersionElement(StringType value)
```
    Parameters:
    
    value - version (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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
  - getVersion
```
public String getVersion()
```
    Returns:
    
    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 Coding setVersion(String value)
```
    Parameters:
    
    value - 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 CodeType getCodeElement()
```
    Returns:
    
    code (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).). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value
  - hasCodeElement
```
public boolean hasCodeElement()
```
  - hasCode
```
public boolean hasCode()
```
  - setCodeElement
```
public Coding setCodeElement(CodeType value)
```
    Parameters:
    
    value - code (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).). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value
  - getCode
```
public String getCode()
```
    Specified by:
    
    getCode in interface org.hl7.fhir.instance.model.api.IBaseCoding
    
    Returns:
    
    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 Coding setCode(String value)
```
    Specified by:
    
    setCode in interface org.hl7.fhir.instance.model.api.IBaseCoding
    
    Parameters:
    
    value - 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).
  - getDisplayElement
```
public StringType getDisplayElement()
```
    Returns:
    
    display (A representation of the meaning of the code in the system, following the rules of the system.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value
  - hasDisplayElement
```
public boolean hasDisplayElement()
```
  - hasDisplay
```
public boolean hasDisplay()
```
  - setDisplayElement
```
public Coding setDisplayElement(StringType value)
```
    Parameters:
    
    value - display (A representation of the meaning of the code in the system, following the rules of the system.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value
  - getDisplay
```
public String getDisplay()
```
    Specified by:
    
    getDisplay in interface org.hl7.fhir.instance.model.api.IBaseCoding
    
    Returns:
    
    A representation of the meaning of the code in the system, following the rules of the system.
  - setDisplay
```
public Coding setDisplay(String value)
```
    Specified by:
    
    setDisplay in interface org.hl7.fhir.instance.model.api.IBaseCoding
    
    Parameters:
    
    value - A representation of the meaning of the code in the system, following the rules of the system.
  - getUserSelectedElement
```
public BooleanType getUserSelectedElement()
```
    Returns:
    
    userSelected (Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).). This is the underlying object with id, value and extensions. The accessor "getUserSelected" gives direct access to the value
  - hasUserSelectedElement
```
public boolean hasUserSelectedElement()
```
  - hasUserSelected
```
public boolean hasUserSelected()
```
  - setUserSelectedElement
```
public Coding setUserSelectedElement(BooleanType value)
```
    Parameters:
    
    value - userSelected (Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).). This is the underlying object with id, value and extensions. The accessor "getUserSelected" gives direct access to the value
  - getUserSelected
```
public boolean getUserSelected()
```
    Returns:
    
    Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
  - setUserSelected
```
public Coding setUserSelected(boolean value)
```
    Parameters:
    
    value - Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class Element
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class Element
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class Element
  - copy
```
public Coding copy()
```
    Overrides:
    
    copy in class Type
  - typedCopy
```
protected Coding typedCopy()
```
    Specified by:
    
    typedCopy in class Type
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class Element
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class Element
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class Element

Class Coding

Field Summary

Fields inherited from class org.hl7.fhir.dstu2.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu2.model.Element

Methods inherited from class org.hl7.fhir.dstu2.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

Field Detail

system

version

code

display

userSelected

Constructor Detail

Coding

Method Detail

getSystemElement

hasSystemElement

hasSystem

setSystemElement

getSystem

setSystem

getVersionElement

hasVersionElement

hasVersion

setVersionElement

getVersion

setVersion

getCodeElement

hasCodeElement

hasCode

setCodeElement

getCode

setCode

getDisplayElement

hasDisplayElement

hasDisplay

setDisplayElement

getDisplay

setDisplay

getUserSelectedElement

hasUserSelectedElement

hasUserSelected

setUserSelectedElement

getUserSelected

setUserSelected

listChildren

setProperty

addChild

fhirType

copy

typedCopy

equalsDeep

equalsShallow

isEmpty