Package com.ibm.fhir.model.resource

Class SubstanceSpecification.Relationship

  • All Implemented Interfaces:
    Visitable
    Enclosing class:
    SubstanceSpecification
    public static class SubstanceSpecification.Relationship
extends BackboneElement
    A link between this substance and another, with details of the relationship.

    • Method Detail

      • getSubstance

        public Element getSubstance()
        A pointer to another substance, as a resource or just a representational code.
        Returns:
        An immutable object of type Reference or CodeableConcept that may be null.

      • getRelationship

        public CodeableConcept getRelationship()
        For example "salt to parent", "active moiety", "starting material".
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getIsDefining

        public Boolean getIsDefining()
        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.
        Returns:
        An immutable object of type Boolean that may be null.

      • getAmount

        public Element getAmount()
        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.
        Returns:
        An immutable object of type Quantity, Range, Ratio or String that may be null.

      • getAmountRatioLowLimit

        public Ratio getAmountRatioLowLimit()
        For use when the numeric.
        Returns:
        An immutable object of type Ratio that may be null.

      • getAmountType

        public CodeableConcept getAmountType()
        An operator for the amount, for example "average", "approximately", "less than".
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getSource

        public List<Reference> getSource()
        Supporting literature.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object