ca.uhn.fhir.model.base.composite

Class BaseCodingDt

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.base.composite.BaseCodingDt

All Implemented Interfaces:

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

Direct Known Subclasses:

InternalCodingDt

public abstract class BaseCodingDt
extends BaseIdentifiableElement
implements ICompositeDatatype, IQueryParameterType

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseCodingDt()

Method Summary

Modifier and Type	Method and Description
abstract CodeDt	getCodeElement() Gets the value(s) for code (Symbol in syntax defined by the system).
abstract StringDt	getDisplayElement() Gets the value(s) for display (Representation defined by the system).
Boolean	getMissing() Deprecated. get/setMissing is not supported in StringDt. Use TokenParam instead if you need this functionality
String	getQueryParameterQualifier() This method will return any qualifier that should be appended to the parameter name (e.g ":exact").
abstract UriDt	getSystemElement() Gets the value(s) for system (Identity of the terminology system).
String	getValueAsQueryToken(FhirContext theContext) Returns a representation of this parameter's value as it will be represented "over the wire".
boolean	matchesSystemAndCode(BaseCodingDt theCoding) Returns true if this Coding has the same Code and system (as compared by simple equals comparison).
boolean	matchesToken(BaseCodingDt theSearchParam) returns true if this Coding matches a search for the coding specified by theSearchParam, according to the following: [parameter]=[namespace]|[code] matches a code/value in the given system namespace [parameter]=[code] matches a code/value irrespective of it's system namespace [parameter]=|[code] matches a code/value that has no system namespace
abstract BaseCodingDt	setCode(String theCode) Sets the value for code (Symbol in syntax defined by the system)
abstract BaseCodingDt	setDisplay(String theString)
IQueryParameterType	setMissing(Boolean theMissing) Deprecated. get/setMissing is not supported in StringDt. Use TokenParam instead if you need this functionality
abstract BaseCodingDt	setSystem(String theUri) Sets the value for system (Identity of the terminology system)
void	setValueAsQueryToken(FhirContext theContext, String theParamName, String theQualifier, String theParameter) This method is generally only called by HAPI itself, and should not need to be called from user code.

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

Methods inherited from interface ca.uhn.fhir.model.api.ICompositeElement

getAllPopulatedChildElementsOfType

Constructor Detail

BaseCodingDt

public BaseCodingDt()

Method Detail

getCodeElement

public abstract 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)

getQueryParameterQualifier

public String getQueryParameterQualifier()

Description copied from interface: IQueryParameterType

This method will return any qualifier that should be appended to the parameter name (e.g ":exact"). Returns null if none are present.

Specified by:

getQueryParameterQualifier in interface IQueryParameterType

getSystemElement

public abstract 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.

getDisplayElement

public abstract StringDt getDisplayElement()

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 abstract BaseCodingDt setDisplay(String theString)

getValueAsQueryToken

public String getValueAsQueryToken(FhirContext theContext)

Returns a representation of this parameter's value as it will be represented "over the wire". In other words, how it will be presented in a URL (although not URL escaped)

See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format

Specified by:

getValueAsQueryToken in interface IQueryParameterType

Parameters:

theContext - TODO

Returns:

Returns a representation of this parameter's value as it will be represented "over the wire". In other words, how it will be presented in a URL (although not URL escaped)

setValueAsQueryToken

public void setValueAsQueryToken(FhirContext theContext,
                                 String theParamName,
                                 String theQualifier,
                                 String theParameter)

This method is generally only called by HAPI itself, and should not need to be called from user code.

See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format

Specified by:

setValueAsQueryToken in interface IQueryParameterType

Parameters:

theContext - TODO

theParamName - TODO

theQualifier - The parameter name qualifier that accompanied this value. For example, if the complete query was http://foo?name:exact=John, qualifier would be ":exact"

theParameter - The actual parameter value. For example, if the complete query was http://foo?name:exact=John, the value would be "John"

matchesSystemAndCode

public boolean matchesSystemAndCode(BaseCodingDt theCoding)

Returns true if this Coding has the same Code and system (as compared by simple equals comparison). Does not compare other Codes (e.g. getUseElement()) or any extensions.

matchesToken

public boolean matchesToken(BaseCodingDt theSearchParam)

returns true if this Coding matches a search for the coding specified by theSearchParam, according to the following:

• [parameter]=[namespace]|[code] matches a code/value in the given system namespace
• [parameter]=[code] matches a code/value irrespective of it's system namespace
• [parameter]=|[code] matches a code/value that has no system namespace

Parameters:

theSearchParam - - coding to test this against

Returns:

true if the coding matches, false otherwise

setCode

public abstract BaseCodingDt 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)

setSystem

public abstract BaseCodingDt 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.

getMissing

@Deprecated
public Boolean getMissing()

Deprecated. get/setMissing is not supported in StringDt. Use TokenParam instead if you need this functionality

Not supported!

Specified by:

getMissing in interface IQueryParameterType

setMissing

@Deprecated
public IQueryParameterType setMissing(Boolean theMissing)

Deprecated. get/setMissing is not supported in StringDt. Use TokenParam instead if you need this functionality

Not supported!

Specified by:

setMissing in interface IQueryParameterType

Returns:

Returns a reference to this for easier method chaining