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:
-
Field Summary
Modifier and TypeFieldDescriptionprotected CodeType
A symbol in syntax defined by the system.protected StringType
A representation of the meaning of the code in the system, following the rules of the system.protected UriType
The identification of the code system that defines the meaning of the symbol in the code.protected BooleanType
Indicates that this coding was chosen by a user directly - e.g.protected StringType
The version of the code system which was used when choosing this code. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
copyValues
(Coding dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setCodeElement
(CodeType value) setDisplay
(String value) setDisplayElement
(StringType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setSystemElement
(UriType value) setUserSelected
(boolean value) setVersion
(String value) setVersionElement
(StringType value) boolean
boolean
protected Coding
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, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
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
The identification of the code system that defines the meaning of the symbol in the code. -
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
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
A representation of the meaning of the code in the system, following the rules of the system. -
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
Convenience constructor- Parameters:
theSystem
- Thecode system
theCode
- Thecode
theDisplay
- Thehuman readable display
-
-
Method Details
-
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
-
hasSystem
-
setSystemElement
- 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
-
setSystem
- Specified by:
setSystem
in interfaceorg.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
- 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
-
hasVersion
- Specified by:
hasVersion
in interfaceICoding
-
setVersionElement
- 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
- Specified by:
getVersion
in interfaceorg.hl7.fhir.instance.model.api.IBaseCoding
- Specified by:
getVersion
in interfaceICoding
- 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
- Specified by:
setVersion
in interfaceorg.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
- 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
-
hasCode
-
setCodeElement
- 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
-
setCode
- Specified by:
setCode
in interfaceorg.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
- 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
-
hasDisplay
- Specified by:
hasDisplay
in interfaceICoding
-
setDisplayElement
- 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
- Specified by:
getDisplay
in interfaceorg.hl7.fhir.instance.model.api.IBaseCoding
- Specified by:
getDisplay
in interfaceICoding
- Returns:
- A representation of the meaning of the code in the system, following the rules of the system.
-
setDisplay
- Specified by:
setDisplay
in interfaceorg.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
- 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
-
hasUserSelected
-
setUserSelectedElement
- 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
- Specified by:
getUserSelected
in interfaceorg.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
- Specified by:
setUserSelected
in interfaceorg.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
- Overrides:
listChildren
in classElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classElement
- 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 classElement
- 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 classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
-
fhirType
-
copy
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classElement
-
equalsShallow
- Overrides:
equalsShallow
in classElement
-
isEmpty
-
supportsVersion
- Specified by:
supportsVersion
in interfaceICoding
-
supportsDisplay
- Specified by:
supportsDisplay
in interfaceICoding
-
is
-