Package org.hl7.fhir.r4.model

Class Coding

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.Type

org.hl7.fhir.r4.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, ICoding

public class Coding
extends Type
implements org.hl7.fhir.instance.model.api.IBaseCoding, org.hl7.fhir.instance.model.api.ICompositeType, ICoding

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 - e.g. off a pick list of available items (codes or displays).
protected StringType	version	The version of the code system which was used when choosing this code.

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

extension, id

Constructor Summary

Constructors

Constructor	Description
Coding()	Constructor
Coding(String theSystem, String theCode, String theDisplay)	Convenience constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Coding	copy()
void	copyValues(Coding dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getCode()
CodeType	getCodeElement()
String	getDisplay()
StringType	getDisplayElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getSystem()
UriType	getSystemElement()
String[]	getTypesForProperty(int hash, String name)
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	is(String system, String code)
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Coding	setCode(String value)
Coding	setCodeElement(CodeType value)
Coding	setDisplay(String value)
Coding	setDisplayElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	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)
boolean	supportsDisplay()
boolean	supportsVersion()
protected Coding	typedCopy()

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

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

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN, setXhtml

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 Details

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 - e.g. off a pick list of available items (codes or displays).

Constructor Details

Coding

public Coding()

Constructor

Coding

public Coding(String theSystem,
 String theCode,
 String theDisplay)

Convenience constructor

Parameters:

theSystem - The code system

theCode - The code

theDisplay - The human readable display

Method Details

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()

Specified by:

hasSystem in interface ICoding

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

Specified by:

getSystem in interface ICoding

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()

Specified by:

hasVersion in interface ICoding

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()

Specified by:

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

Specified by:

getVersion in interface ICoding

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)

Specified by:

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

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()

Specified by:

hasCode in interface ICoding

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

Specified by:

getCode in interface ICoding

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()

Specified by:

hasDisplay in interface ICoding

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

Specified by:

getDisplay in interface ICoding

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 - e.g. 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 - e.g. 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()

Specified by:

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

Returns:

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

setUserSelected

public Coding setUserSelected(boolean value)

Specified by:

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

Parameters:

value - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Element

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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

copyValues

public void copyValues(Coding dst)

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

supportsVersion

public boolean supportsVersion()

Specified by:

supportsVersion in interface ICoding

supportsDisplay

public boolean supportsDisplay()

Specified by:

supportsDisplay in interface ICoding

is

public boolean is(String system,
 String code)