Package com.ibm.fhir.model.resource

Class SubstanceSpecification

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class SubstanceSpecification
extends DomainResource
    The detailed description of a substance, typically at a level beyond what is used for prescribing.

    Maturity level: FMM0 (Trial Use)

    • Method Detail

      • getIdentifier

        public Identifier getIdentifier()
        Identifier by which this substance is known.
        Returns:
        An immutable object of type Identifier that may be null.

      • getType

        public CodeableConcept getType()
        High level categorization, e.g. polymer or nucleic acid.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getStatus

        public CodeableConcept getStatus()
        Status of substance within the catalogue e.g. approved.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getDomain

        public CodeableConcept getDomain()
        If the substance applies to only human or veterinary use.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getDescription

        public String getDescription()
        Textual description of the substance.
        Returns:
        An immutable object of type String that may be null.

      • getSource

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

      • getComment

        public String getComment()
        Textual comment about this record of a substance.
        Returns:
        An immutable object of type String that may be null.

      • getReferenceInformation

        public Reference getReferenceInformation()
        General information detailing this substance.
        Returns:
        An immutable object of type Reference that may be null.

      • getMolecularWeight

        public java.util.List<SubstanceSpecification.Structure.Isotope.MolecularWeight> getMolecularWeight()
        The molecular weight or weight range (for proteins, polymers or nucleic acids).
        Returns:
        An unmodifiable list containing immutable objects of type MolecularWeight that may be empty.

      • getNucleicAcid

        public Reference getNucleicAcid()
        Data items specific to nucleic acids.
        Returns:
        An immutable object of type Reference that may be null.

      • getPolymer

        public Reference getPolymer()
        Data items specific to polymers.
        Returns:
        An immutable object of type Reference that may be null.

      • getProtein

        public Reference getProtein()
        Data items specific to proteins.
        Returns:
        An immutable object of type Reference that may be null.

      • getSourceMaterial

        public Reference getSourceMaterial()
        Material or taxonomic/anatomical source for the substance.
        Returns:
        An immutable object of type Reference that may be null.

      • accept

        public void accept​(java.lang.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

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object