Package org.hl7.fhir.r5.model

Class SubstanceDefinition.SubstanceDefinitionRelationshipComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionRelationshipComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

SubstanceDefinition

public static class SubstanceDefinition.SubstanceDefinitionRelationshipComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

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

Modifier and Type	Field	Description
protected DataType	amount	A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.
protected CodeableConcept	comparator	An operator for the amount, for example "average", "approximately", "less than".
protected BooleanType	isDefining	For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.
protected Ratio	ratioHighLimitAmount	For use when the numeric has an uncertain range.
protected List<Reference>	source	Supporting literature.
protected DataType	substanceDefinition	A pointer to another substance, as a resource or just a representational code.
protected CodeableConcept	type	For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of".

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
SubstanceDefinitionRelationshipComponent()	Constructor
SubstanceDefinitionRelationshipComponent(CodeableConcept type)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Reference	addSource()
SubstanceDefinition.SubstanceDefinitionRelationshipComponent	addSource(Reference t)
SubstanceDefinition.SubstanceDefinitionRelationshipComponent	copy()
void	copyValues(SubstanceDefinition.SubstanceDefinitionRelationshipComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
DataType	getAmount()
Quantity	getAmountQuantity()
Ratio	getAmountRatio()
StringType	getAmountStringType()
CodeableConcept	getComparator()
boolean	getIsDefining()
BooleanType	getIsDefiningElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
Ratio	getRatioHighLimitAmount()
List<Reference>	getSource()
Reference	getSourceFirstRep()
DataType	getSubstanceDefinition()
CodeableConcept	getSubstanceDefinitionCodeableConcept()
Reference	getSubstanceDefinitionReference()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAmount()
boolean	hasAmountQuantity()
boolean	hasAmountRatio()
boolean	hasAmountStringType()
boolean	hasComparator()
boolean	hasIsDefining()
boolean	hasIsDefiningElement()
boolean	hasRatioHighLimitAmount()
boolean	hasSource()
boolean	hasSubstanceDefinition()
boolean	hasSubstanceDefinitionCodeableConcept()
boolean	hasSubstanceDefinitionReference()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
SubstanceDefinition.SubstanceDefinitionRelationshipComponent	setAmount(DataType value)
SubstanceDefinition.SubstanceDefinitionRelationshipComponent	setComparator(CodeableConcept value)
SubstanceDefinition.SubstanceDefinitionRelationshipComponent	setIsDefining(boolean value)
SubstanceDefinition.SubstanceDefinitionRelationshipComponent	setIsDefiningElement(BooleanType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
SubstanceDefinition.SubstanceDefinitionRelationshipComponent	setRatioHighLimitAmount(Ratio value)
SubstanceDefinition.SubstanceDefinitionRelationshipComponent	setSource(List<Reference> theSource)
SubstanceDefinition.SubstanceDefinitionRelationshipComponent	setSubstanceDefinition(DataType value)
SubstanceDefinition.SubstanceDefinitionRelationshipComponent	setType(CodeableConcept value)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionValue, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

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

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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

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

addExtension, getExtension, hasExtension

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

substanceDefinition

protected DataType substanceDefinition

A pointer to another substance, as a resource or just a representational code.

type

protected CodeableConcept type

For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of".

isDefining

protected BooleanType isDefining

For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.

amount

protected DataType amount

A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.

ratioHighLimitAmount

protected Ratio ratioHighLimitAmount

For use when the numeric has an uncertain range.

comparator

protected CodeableConcept comparator

An operator for the amount, for example "average", "approximately", "less than".

source

protected List<Reference> source

Supporting literature.

Constructor Details

SubstanceDefinitionRelationshipComponent

public SubstanceDefinitionRelationshipComponent()

Constructor

SubstanceDefinitionRelationshipComponent

public SubstanceDefinitionRelationshipComponent(CodeableConcept type)

Constructor

Method Details

getSubstanceDefinition

public DataType getSubstanceDefinition()

Returns:

substanceDefinition (A pointer to another substance, as a resource or just a representational code.)

getSubstanceDefinitionReference

public Reference getSubstanceDefinitionReference()
                                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

substanceDefinition (A pointer to another substance, as a resource or just a representational code.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasSubstanceDefinitionReference

public boolean hasSubstanceDefinitionReference()

getSubstanceDefinitionCodeableConcept

public CodeableConcept getSubstanceDefinitionCodeableConcept()
                                                      throws org.hl7.fhir.exceptions.FHIRException

Returns:

substanceDefinition (A pointer to another substance, as a resource or just a representational code.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasSubstanceDefinitionCodeableConcept

public boolean hasSubstanceDefinitionCodeableConcept()

hasSubstanceDefinition

public boolean hasSubstanceDefinition()

setSubstanceDefinition

public SubstanceDefinition.SubstanceDefinitionRelationshipComponent setSubstanceDefinition(DataType value)

Parameters:

value - substanceDefinition (A pointer to another substance, as a resource or just a representational code.)

getType

public CodeableConcept getType()

Returns:

type (For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of".)

hasType

public boolean hasType()

setType

public SubstanceDefinition.SubstanceDefinitionRelationshipComponent setType(CodeableConcept value)

Parameters:

value - type (For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of".)

getIsDefiningElement

public BooleanType getIsDefiningElement()

Returns:

isDefining (For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.). This is the underlying object with id, value and extensions. The accessor "getIsDefining" gives direct access to the value

hasIsDefiningElement

public boolean hasIsDefiningElement()

hasIsDefining

public boolean hasIsDefining()

setIsDefiningElement

public SubstanceDefinition.SubstanceDefinitionRelationshipComponent setIsDefiningElement(BooleanType value)

Parameters:

value - isDefining (For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.). This is the underlying object with id, value and extensions. The accessor "getIsDefining" gives direct access to the value

getIsDefining

public boolean getIsDefining()

Returns:

For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.

setIsDefining

public SubstanceDefinition.SubstanceDefinitionRelationshipComponent setIsDefining(boolean value)

Parameters:

value - For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.

getAmount

public DataType getAmount()

Returns:

amount (A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.)

getAmountQuantity

public Quantity getAmountQuantity()
                           throws org.hl7.fhir.exceptions.FHIRException

Returns:

amount (A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasAmountQuantity

public boolean hasAmountQuantity()

getAmountRatio

public Ratio getAmountRatio()
                     throws org.hl7.fhir.exceptions.FHIRException

Returns:

amount (A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasAmountRatio

public boolean hasAmountRatio()

getAmountStringType

public StringType getAmountStringType()
                               throws org.hl7.fhir.exceptions.FHIRException

Returns:

amount (A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasAmountStringType

public boolean hasAmountStringType()

hasAmount

public boolean hasAmount()

setAmount

public SubstanceDefinition.SubstanceDefinitionRelationshipComponent setAmount(DataType value)

Parameters:

value - amount (A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.)

getRatioHighLimitAmount

public Ratio getRatioHighLimitAmount()

Returns:

ratioHighLimitAmount (For use when the numeric has an uncertain range.)

hasRatioHighLimitAmount

public boolean hasRatioHighLimitAmount()

setRatioHighLimitAmount

public SubstanceDefinition.SubstanceDefinitionRelationshipComponent setRatioHighLimitAmount(Ratio value)

Parameters:

value - ratioHighLimitAmount (For use when the numeric has an uncertain range.)

getComparator

public CodeableConcept getComparator()

Returns:

comparator (An operator for the amount, for example "average", "approximately", "less than".)

hasComparator

public boolean hasComparator()

setComparator

public SubstanceDefinition.SubstanceDefinitionRelationshipComponent setComparator(CodeableConcept value)

Parameters:

value - comparator (An operator for the amount, for example "average", "approximately", "less than".)

getSource

public List<Reference> getSource()

Returns:

source (Supporting literature.)

setSource

public SubstanceDefinition.SubstanceDefinitionRelationshipComponent setSource(List<Reference> theSource)

Returns:

Returns a reference to this for easy method chaining

hasSource

public boolean hasSource()

addSource

public Reference addSource()

addSource

public SubstanceDefinition.SubstanceDefinitionRelationshipComponent addSource(Reference t)

getSourceFirstRep

public Reference getSourceFirstRep()

Returns:

The first repetition of repeating field source, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

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

Overrides:

getNamedProperty in class BackboneElement

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 BackboneElement

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 BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public SubstanceDefinition.SubstanceDefinitionRelationshipComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(SubstanceDefinition.SubstanceDefinitionRelationshipComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class BackboneElement

Returns:

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