Package ca.uhn.fhir.rest.param

Class InternalCodingDt

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.rest.param.InternalCodingDt

All Implemented Interfaces:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, IQueryParameterType, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseDatatype, ICompositeType

public class InternalCodingDt
extends BaseCodingDt
implements ICompositeDatatype

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
InternalCodingDt()	Constructor
InternalCodingDt(String theSystem, String theCode)	Creates a new Coding with the given system and code

Method Summary

Modifier and Type	Method	Description
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)	Deprecated.
CodeDt	getCodeElement()	Gets the value(s) for code (Symbol in syntax defined by the system).
StringDt	getDisplay()	Gets the value(s) for display (Representation defined by the system).
StringDt	getDisplayElement()	Gets the value(s) for display (Representation defined by the system).
Boolean	getMissing()	Deprecated.
BooleanDt	getPrimary()	Gets the value(s) for primary (If this code was chosen directly by the user).
UriDt	getSystemElement()	Gets the value(s) for system (Identity of the terminology system).
BaseResourceReferenceDt	getValueSet()	Gets the value(s) for valueSet (Set this coding was chosen from).
StringDt	getVersion()	Gets the value(s) for version (Version of the system - if relevant).
boolean	isEmpty()
InternalCodingDt	setCode(CodeDt theValue)	Sets the value(s) for code (Symbol in syntax defined by the system)
InternalCodingDt	setCode(String theCode)	Sets the value for code (Symbol in syntax defined by the system)
InternalCodingDt	setDisplay(StringDt theValue)	Sets the value(s) for display (Representation defined by the system)
InternalCodingDt	setDisplay(String theString)	Sets the value for display (Representation defined by the system)
IQueryParameterType	setMissing(Boolean theMissing)	Deprecated.
InternalCodingDt	setPrimary(boolean theBoolean)	Sets the value for primary (If this code was chosen directly by the user)
InternalCodingDt	setPrimary(BooleanDt theValue)	Sets the value(s) for primary (If this code was chosen directly by the user)
InternalCodingDt	setSystem(UriDt theValue)	Sets the value(s) for system (Identity of the terminology system)
InternalCodingDt	setSystem(String theUri)	Sets the value for system (Identity of the terminology system)
InternalCodingDt	setVersion(StringDt theValue)	Sets the value(s) for version (Version of the system - if relevant)
InternalCodingDt	setVersion(String theString)	Sets the value for version (Version of the system - if relevant)

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

getQueryParameterQualifier, getValueAsQueryToken, matchesSystemAndCode, matchesToken, 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, getUserData, hasFormatComment, isBaseEmpty, setUserData

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

fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Constructor Detail

InternalCodingDt

public InternalCodingDt()

Constructor

InternalCodingDt

public InternalCodingDt(String theSystem,
                        String theCode)

Creates a new Coding with the given system and code

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

getAllPopulatedChildElementsOfType

@Deprecated
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Deprecated.

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getSystemElement

public UriDt getSystemElement()

Gets the value(s) for system (Identity of the terminology 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

setSystem

public InternalCodingDt setSystem(UriDt theValue)

Sets the value(s) for system (Identity of the terminology system)

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

setSystem

public InternalCodingDt setSystem(String theUri)

Sets the value for system (Identity of the terminology system)

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

Specified by:

setSystem in class BaseCodingDt

getVersion

public StringDt getVersion()

Gets the value(s) for version (Version of the system - if relevant). 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 InternalCodingDt setVersion(StringDt theValue)

Sets the value(s) for version (Version of the system - if relevant)

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 InternalCodingDt setVersion(String theString)

Sets the value for version (Version of the system - if relevant)

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 (Symbol in syntax defined by the system). 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

setCode

public InternalCodingDt setCode(CodeDt theValue)

Sets the value(s) for code (Symbol in syntax defined by the system)

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 InternalCodingDt setCode(String theCode)

Sets the value for code (Symbol in syntax defined by the system)

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 class BaseCodingDt

getDisplay

public StringDt getDisplay()

Gets the value(s) for display (Representation defined by the system). 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.

setDisplay

public InternalCodingDt setDisplay(StringDt theValue)

Sets the value(s) for display (Representation defined by the system)

Definition: A representation of the meaning of the code in the system, following the rules of the system.

setDisplay

public InternalCodingDt setDisplay(String theString)

Sets the value for display (Representation defined by the system)

Definition: A representation of the meaning of the code in the system, following the rules of the system.

Specified by:

setDisplay in class BaseCodingDt

getPrimary

public BooleanDt getPrimary()

Gets the value(s) for primary (If this code was chosen directly by the user). creating it if it does not exist. Will not return null.

Definition: Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)

setPrimary

public InternalCodingDt setPrimary(BooleanDt theValue)

Sets the value(s) for primary (If this code was chosen directly by the user)

Definition: Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)

setPrimary

public InternalCodingDt setPrimary(boolean theBoolean)

Sets the value for primary (If this code was chosen directly by the user)

Definition: Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)

getValueSet

public BaseResourceReferenceDt getValueSet()

Gets the value(s) for valueSet (Set this coding was chosen from). creating it if it does not exist. Will not return null.

Definition: The set of possible coded values this coding was chosen from or constrained by

getDisplayElement

public StringDt getDisplayElement()

Description copied from class: BaseCodingDt

Gets the value(s) for display (Representation defined by the system). 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

getMissing

@Deprecated
public Boolean getMissing()

Deprecated.

Description copied from class: BaseCodingDt

Not supported!

Specified by:

getMissing in interface IQueryParameterType

Overrides:

getMissing in class BaseCodingDt

setMissing

@Deprecated
public IQueryParameterType setMissing(Boolean theMissing)

Deprecated.

Description copied from class: BaseCodingDt

Not supported!

Specified by:

setMissing in interface IQueryParameterType

Overrides:

setMissing in class BaseCodingDt

Returns:

Returns a reference to this for easier method chaining