ca.uhn.fhir.model.dstu2.composite

Class CodingDt

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:

ca.uhn.fhir.model.api.ICompositeDatatype, ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IDatatype, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IQueryParameterType, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, 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.ICompositeType

public class CodingDt
extends ca.uhn.fhir.model.base.composite.BaseCodingDt
implements ca.uhn.fhir.model.api.ICompositeDatatype, org.hl7.fhir.instance.model.api.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(ca.uhn.fhir.model.base.composite.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

Modifier and Type	Method and Description
<T extends ca.uhn.fhir.model.api.IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
String	getCode() Gets the value(s) for code ().
ca.uhn.fhir.model.primitive.CodeDt	getCodeElement() Gets the value(s) for code ().
String	getDisplay() Gets the value(s) for display ().
ca.uhn.fhir.model.primitive.StringDt	getDisplayElement() Gets the value(s) for display ().
String	getSystem() Gets the value(s) for system ().
ca.uhn.fhir.model.primitive.UriDt	getSystemElement() Gets the value(s) for system ().
Boolean	getUserSelected() Gets the value(s) for userSelected ().
ca.uhn.fhir.model.primitive.BooleanDt	getUserSelectedElement() Gets the value(s) for userSelected ().
String	getVersion() Gets the value(s) for version ().
ca.uhn.fhir.model.primitive.StringDt	getVersionElement() Gets the value(s) for version ().
boolean	isEmpty()
CodingDt	setCode(ca.uhn.fhir.model.primitive.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(ca.uhn.fhir.model.primitive.StringDt theValue) Sets the value(s) for display ()
CodingDt	setSystem(String theUri) Sets the value for system ()
CodingDt	setSystem(ca.uhn.fhir.model.primitive.UriDt theValue) Sets the value(s) for system ()
CodingDt	setUserSelected(boolean theBoolean) Sets the value for userSelected ()
CodingDt	setUserSelected(ca.uhn.fhir.model.primitive.BooleanDt theValue) Sets the value(s) for userSelected ()
CodingDt	setVersion(String theString) Sets the value for version ()
CodingDt	setVersion(ca.uhn.fhir.model.primitive.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, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment, 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(ca.uhn.fhir.model.base.composite.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 org.hl7.fhir.instance.model.api.IBase

getAllPopulatedChildElementsOfType

public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

getSystemElement

public ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.base.composite.BaseCodingDt

getSystem

public String getSystem()

Gets the value(s) for system (). creating it if it does not exist. This method may return null.

Definition: The identification of the code system that defines the meaning of the symbol in the code.

Specified by:

getSystem in interface org.hl7.fhir.instance.model.api.IBaseCoding

setSystem

public CodingDt setSystem(ca.uhn.fhir.model.primitive.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 org.hl7.fhir.instance.model.api.IBaseCoding

Specified by:

setSystem in class ca.uhn.fhir.model.base.composite.BaseCodingDt

getVersionElement

public ca.uhn.fhir.model.primitive.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. This method may 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(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.base.composite.BaseCodingDt

getCode

public String getCode()

Gets the value(s) for code (). creating it if it does not exist. This method may 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 org.hl7.fhir.instance.model.api.IBaseCoding

setCode

public CodingDt setCode(ca.uhn.fhir.model.primitive.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 org.hl7.fhir.instance.model.api.IBaseCoding

Specified by:

setCode in class ca.uhn.fhir.model.base.composite.BaseCodingDt

getDisplayElement

public ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.base.composite.BaseCodingDt

getDisplay

public String getDisplay()

Gets the value(s) for display (). creating it if it does not exist. This method may 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 org.hl7.fhir.instance.model.api.IBaseCoding

setDisplay

public CodingDt setDisplay(ca.uhn.fhir.model.primitive.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 org.hl7.fhir.instance.model.api.IBaseCoding

Specified by:

setDisplay in class ca.uhn.fhir.model.base.composite.BaseCodingDt

getUserSelectedElement

public ca.uhn.fhir.model.primitive.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. This method may 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(ca.uhn.fhir.model.primitive.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)