Package org.hl7.fhir.r5.model

Class CodeType

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.model.PrimitiveType<String>

org.hl7.fhir.r5.model.StringType

org.hl7.fhir.r5.model.CodeType

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Externalizable, Serializable, Comparable<CodeType>, org.hl7.fhir.instance.model.api.IBase, 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.IPrimitiveType<String>, ICoding

public class CodeType
extends StringType
implements Comparable<CodeType>, ICoding

Primitive type "code" in FHIR, when not bound to an enumerated list of codes

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

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

extension, id

Constructor Summary

Constructors

Constructor	Description
CodeType()
CodeType(String theCode)
CodeType(String theCode, Element source)

Method Summary

Modifier and Type	Method	Description
int	compareTo(CodeType theCode)
CodeType	copy()
protected String	encode(String theValue)	Subclasses must override to convert a "coerced" value into an encoded one.
String	fhirType()
String	getCode()
String	getDisplay()
String	getSystem()
String	getVersion()
boolean	hasCode()
boolean	hasDisplay()
boolean	hasSystem()
boolean	hasVersion()
protected String	parse(String theValue)	Subclasses must override to convert an encoded representation of this datatype into a "coerced" one
CodeType	setSystem(String system)
boolean	supportsDisplay()
boolean	supportsVersion()

Methods inherited from class org.hl7.fhir.r5.model.StringType

getValueNotNull, isTranslatable, toString

Methods inherited from class org.hl7.fhir.r5.model.PrimitiveType

asStringValue, canHavePrimitiveValue, equalsDeep, equalsShallow, forceStringValue, fpValue, fromStringValue, getProperty, getTypesForProperty, getValue, getValueAsString, hashCode, hasPrimitiveValue, hasValue, isEmpty, isPrimitive, makeProperty, matches, primitiveValue, readExternal, removeChild, setProperty, setProperty, setValue, setValueAsString, typedCopy, updateStringValue, writeExternal

Methods inherited from class org.hl7.fhir.r5.model.DataType

copyValues, getTranslation

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

addChild, addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getNamedProperty, getStandardsStatus, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, listChildren, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isResource, listChildrenByName, listChildrenByName, setCopyUserData, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, 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

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

addExtension, getExtension, hasExtension

Constructor Details

CodeType

public CodeType()

CodeType

public CodeType(String theCode)

CodeType

public CodeType(String theCode,
 Element source)

Method Details

compareTo

public int compareTo(CodeType theCode)

Specified by:

compareTo in interface Comparable<CodeType>

parse

protected String parse(String theValue)

Description copied from class: PrimitiveType

Subclasses must override to convert an encoded representation of this datatype into a "coerced" one

Overrides:

parse in class StringType

Parameters:

theValue - Will not be null

Returns:

May return null if the value does not correspond to anything

encode

protected String encode(String theValue)

Description copied from class: PrimitiveType

Subclasses must override to convert a "coerced" value into an encoded one.

Overrides:

encode in class StringType

Parameters:

theValue - Will not be null

Returns:

May return null if the value does not correspond to anything

copy

public CodeType copy()

Overrides:

copy in class StringType

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class StringType

Returns:

the FHIR type name of the instance (not the java class name)

getSystem

public String getSystem()

Specified by:

getSystem in interface ICoding

hasSystem

public boolean hasSystem()

Specified by:

hasSystem in interface ICoding

setSystem

public CodeType setSystem(String system)

getVersion

public String getVersion()

Specified by:

getVersion in interface ICoding

hasVersion

public boolean hasVersion()

Specified by:

hasVersion in interface ICoding

getDisplay

public String getDisplay()

Specified by:

getDisplay in interface ICoding

hasDisplay

public boolean hasDisplay()

Specified by:

hasDisplay in interface ICoding

getCode

public String getCode()

Specified by:

getCode in interface ICoding

hasCode

public boolean hasCode()

Specified by:

hasCode in interface ICoding

supportsVersion

public boolean supportsVersion()

Specified by:

supportsVersion in interface ICoding

supportsDisplay

public boolean supportsDisplay()

Specified by:

supportsDisplay in interface ICoding