Class SubstanceAmount

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.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class SubstanceAmount extends BackboneType implements org.hl7.fhir.instance.model.api.ICompositeType
Base StructureDefinition for SubstanceAmount Type: Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.
See Also:
Serialized Form
  • Field Details

    • amount

      protected DataType amount
      Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.
    • amountType

      Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements.
    • amountText

      A textual comment on a numeric value.
    • referenceRange

      Reference range of possible or expected values.
  • Constructor Details

  • Method Details

    • getAmount

      public DataType getAmount()
      Returns:
      amount (Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.)
    • getAmountQuantity

      public Quantity getAmountQuantity() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      amount (Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • hasAmountQuantity

      public boolean hasAmountQuantity()
    • getAmountRange

      public Range getAmountRange() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      amount (Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • hasAmountRange

      public boolean hasAmountRange()
    • getAmountStringType

      public StringType getAmountStringType() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      amount (Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • hasAmountStringType

      public boolean hasAmountStringType()
    • hasAmount

      public boolean hasAmount()
    • setAmount

      public SubstanceAmount setAmount(DataType value)
      Parameters:
      value - amount (Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.)
    • getAmountType

      Returns:
      amountType (Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements.)
    • hasAmountType

      public boolean hasAmountType()
    • setAmountType

      Parameters:
      value - amountType (Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements.)
    • getAmountTextElement

      Returns:
      amountText (A textual comment on a numeric value.). This is the underlying object with id, value and extensions. The accessor "getAmountText" gives direct access to the value
    • hasAmountTextElement

      public boolean hasAmountTextElement()
    • hasAmountText

      public boolean hasAmountText()
    • setAmountTextElement

      Parameters:
      value - amountText (A textual comment on a numeric value.). This is the underlying object with id, value and extensions. The accessor "getAmountText" gives direct access to the value
    • getAmountText

      Returns:
      A textual comment on a numeric value.
    • setAmountText

      Parameters:
      value - A textual comment on a numeric value.
    • getReferenceRange

      Returns:
      referenceRange (Reference range of possible or expected values.)
    • hasReferenceRange

      public boolean hasReferenceRange()
    • setReferenceRange

      Parameters:
      value - referenceRange (Reference range of possible or expected values.)
    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class BackboneType
    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class BackboneType
      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 BackboneType
      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 BackboneType
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class BackboneType
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class BackboneType
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class BackboneType
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class BackboneType
      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 BackboneType
    • copy

      Specified by:
      copy in class BackboneType
    • copyValues

      public void copyValues(SubstanceAmount dst)
    • typedCopy

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class BackboneType
    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class BackboneType
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class BackboneType