java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.Element
  - - org.hl7.fhir.r4.model.BackboneElement
    - - org.hl7.fhir.r4.model.SubstanceSpecification.SubstanceSpecificationRelationshipComponent

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:

SubstanceSpecification
```
public static class SubstanceSpecification.SubstanceSpecificationRelationshipComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected Type`	`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 Ratio`	`amountRatioLowLimit`	For use when the numeric.
`protected CodeableConcept`	`amountType`	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 CodeableConcept`	`relationship`	For example "salt to parent", "active moiety", "starting material".
`protected List<Reference>`	`source`	Supporting literature.
`protected List<DocumentReference>`	`sourceTarget`	The actual objects that are the target of the reference (Supporting literature.)
`protected Type`	`substance`	A pointer to another substance, as a resource or just a representational code.

Fields inherited from class org.hl7.fhir.r4.model.BackboneElement
modifierExtension

Fields inherited from class org.hl7.fhir.r4.model.Element
extension, id

Constructor Summary

Constructors
Constructor Description

SubstanceSpecificationRelationshipComponent()
Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Base`	`addChild(String name)`
`Reference`	`addSource()`
`SubstanceSpecification.SubstanceSpecificationRelationshipComponent`	`addSource(Reference t)`
`DocumentReference`	`addSourceTarget()`	Deprecated. Use Reference#setResource(IBaseResource) instead
`SubstanceSpecification.SubstanceSpecificationRelationshipComponent`	`copy()`
`void`	`copyValues(SubstanceSpecification.SubstanceSpecificationRelationshipComponent dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`Type`	`getAmount()`
`Quantity`	`getAmountQuantity()`
`Range`	`getAmountRange()`
`Ratio`	`getAmountRatio()`
`Ratio`	`getAmountRatioLowLimit()`
`StringType`	`getAmountStringType()`
`CodeableConcept`	`getAmountType()`
`boolean`	`getIsDefining()`
`BooleanType`	`getIsDefiningElement()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`CodeableConcept`	`getRelationship()`
`List<Reference>`	`getSource()`
`Reference`	`getSourceFirstRep()`
`List<DocumentReference>`	`getSourceTarget()`	Deprecated. Use Reference#setResource(IBaseResource) instead
`Type`	`getSubstance()`
`CodeableConcept`	`getSubstanceCodeableConcept()`
`Reference`	`getSubstanceReference()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAmount()`
`boolean`	`hasAmountQuantity()`
`boolean`	`hasAmountRange()`
`boolean`	`hasAmountRatio()`
`boolean`	`hasAmountRatioLowLimit()`
`boolean`	`hasAmountStringType()`
`boolean`	`hasAmountType()`
`boolean`	`hasIsDefining()`
`boolean`	`hasIsDefiningElement()`
`boolean`	`hasRelationship()`
`boolean`	`hasSource()`
`boolean`	`hasSubstance()`
`boolean`	`hasSubstanceCodeableConcept()`
`boolean`	`hasSubstanceReference()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`SubstanceSpecification.SubstanceSpecificationRelationshipComponent`	`setAmount(Type value)`
`SubstanceSpecification.SubstanceSpecificationRelationshipComponent`	`setAmountRatioLowLimit(Ratio value)`
`SubstanceSpecification.SubstanceSpecificationRelationshipComponent`	`setAmountType(CodeableConcept value)`
`SubstanceSpecification.SubstanceSpecificationRelationshipComponent`	`setIsDefining(boolean value)`
`SubstanceSpecification.SubstanceSpecificationRelationshipComponent`	`setIsDefiningElement(BooleanType value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`SubstanceSpecification.SubstanceSpecificationRelationshipComponent`	`setRelationship(CodeableConcept value)`
`SubstanceSpecification.SubstanceSpecificationRelationshipComponent`	`setSource(List<Reference> theSource)`
`SubstanceSpecification.SubstanceSpecificationRelationshipComponent`	`setSubstance(Type value)`

Methods inherited from class org.hl7.fhir.r4.model.BackboneElement
addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, 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, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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

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 Detail
  - substance
```
protected Type substance
```
    A pointer to another substance, as a resource or just a representational code.
  - relationship
```
protected CodeableConcept relationship
```
    For example "salt to parent", "active moiety", "starting material".
  - 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 Type 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.
  - amountRatioLowLimit
```
protected Ratio amountRatioLowLimit
```
    For use when the numeric.
  - amountType
```
protected CodeableConcept amountType
```
    An operator for the amount, for example "average", "approximately", "less than".
  - source
```
protected List<Reference> source
```
    Supporting literature.
  - sourceTarget
```
protected List<DocumentReference> sourceTarget
```
    The actual objects that are the target of the reference (Supporting literature.)
- Constructor Detail
  - SubstanceSpecificationRelationshipComponent
```
public SubstanceSpecificationRelationshipComponent()
```
    Constructor
- Method Detail
  - getSubstance
```
public Type getSubstance()
```
    Returns:
    
    substance (A pointer to another substance, as a resource or just a representational code.)
  - getSubstanceReference
```
public Reference getSubstanceReference()
                                throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    substance (A pointer to another substance, as a resource or just a representational code.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasSubstanceReference
```
public boolean hasSubstanceReference()
```
  - getSubstanceCodeableConcept
```
public CodeableConcept getSubstanceCodeableConcept()
                                            throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    substance (A pointer to another substance, as a resource or just a representational code.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasSubstanceCodeableConcept
```
public boolean hasSubstanceCodeableConcept()
```
  - hasSubstance
```
public boolean hasSubstance()
```
  - setSubstance
```
public SubstanceSpecification.SubstanceSpecificationRelationshipComponent setSubstance(Type value)
```
    Parameters:
    
    value - substance (A pointer to another substance, as a resource or just a representational code.)
  - getRelationship
```
public CodeableConcept getRelationship()
```
    Returns:
    
    relationship (For example "salt to parent", "active moiety", "starting material".)
  - hasRelationship
```
public boolean hasRelationship()
```
  - setRelationship
```
public SubstanceSpecification.SubstanceSpecificationRelationshipComponent setRelationship(CodeableConcept value)
```
    Parameters:
    
    value - relationship (For example "salt to parent", "active moiety", "starting material".)
  - 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 SubstanceSpecification.SubstanceSpecificationRelationshipComponent 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 SubstanceSpecification.SubstanceSpecificationRelationshipComponent 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 Type 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()
```
  - getAmountRange
```
public Range getAmountRange()
                     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
  - hasAmountRange
```
public boolean hasAmountRange()
```
  - 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 SubstanceSpecification.SubstanceSpecificationRelationshipComponent setAmount(Type 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.)
  - getAmountRatioLowLimit
```
public Ratio getAmountRatioLowLimit()
```
    Returns:
    
    amountRatioLowLimit (For use when the numeric.)
  - hasAmountRatioLowLimit
```
public boolean hasAmountRatioLowLimit()
```
  - setAmountRatioLowLimit
```
public SubstanceSpecification.SubstanceSpecificationRelationshipComponent setAmountRatioLowLimit(Ratio value)
```
    Parameters:
    
    value - amountRatioLowLimit (For use when the numeric.)
  - getAmountType
```
public CodeableConcept getAmountType()
```
    Returns:
    
    amountType (An operator for the amount, for example "average", "approximately", "less than".)
  - hasAmountType
```
public boolean hasAmountType()
```
  - setAmountType
```
public SubstanceSpecification.SubstanceSpecificationRelationshipComponent setAmountType(CodeableConcept value)
```
    Parameters:
    
    value - amountType (An operator for the amount, for example "average", "approximately", "less than".)
  - getSource
```
public List<Reference> getSource()
```
    Returns:
    
    source (Supporting literature.)
  - setSource
```
public SubstanceSpecification.SubstanceSpecificationRelationshipComponent setSource(List<Reference> theSource)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasSource
```
public boolean hasSource()
```
  - addSource
```
public Reference addSource()
```
  - addSource
```
public SubstanceSpecification.SubstanceSpecificationRelationshipComponent addSource(Reference t)
```
  - getSourceFirstRep
```
public Reference getSourceFirstRep()
```
    Returns:
    
    The first repetition of repeating field source, creating it if it does not already exist
  - getSourceTarget
```
@Deprecated
public List<DocumentReference> getSourceTarget()
```
    Deprecated.
    Use Reference#setResource(IBaseResource) instead
  - addSourceTarget
```
@Deprecated
public DocumentReference addSourceTarget()
```
    Deprecated.
    Use Reference#setResource(IBaseResource) instead
  - 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
  - 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 SubstanceSpecification.SubstanceSpecificationRelationshipComponent copy()
```
    Specified by:
    
    copy in class BackboneElement
  - copyValues
```
public void copyValues(SubstanceSpecification.SubstanceSpecificationRelationshipComponent 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

Class SubstanceSpecification.SubstanceSpecificationRelationshipComponent

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

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

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

Field Detail

substance

relationship

isDefining

amount

amountRatioLowLimit

amountType

source

sourceTarget

Constructor Detail

SubstanceSpecificationRelationshipComponent

Method Detail

getSubstance

getSubstanceReference

hasSubstanceReference

getSubstanceCodeableConcept

hasSubstanceCodeableConcept

hasSubstance

setSubstance

getRelationship

hasRelationship

setRelationship

getIsDefiningElement

hasIsDefiningElement

hasIsDefining

setIsDefiningElement

getIsDefining

setIsDefining

getAmount

getAmountQuantity

hasAmountQuantity

getAmountRange

hasAmountRange

getAmountRatio

hasAmountRatio

getAmountStringType

hasAmountStringType

hasAmount

setAmount

getAmountRatioLowLimit

hasAmountRatioLowLimit

setAmountRatioLowLimit

getAmountType

hasAmountType

setAmountType

getSource

setSource

hasSource

addSource

addSource

getSourceFirstRep

getSourceTarget

addSourceTarget

listChildren

getNamedProperty

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

copy

copyValues

equalsDeep

equalsShallow

isEmpty