Package org.linuxforhealth.fhir.model.resource

Class SubstanceDefinition

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

    Maturity level: FMM1 (Trial Use)

    • Method Detail

      • getIdentifier

        public java.util.List<Identifier> getIdentifier()
        Identifier by which this substance is known.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getVersion

        public String getVersion()
        A business level version identifier of the substance.
        Returns:
        An immutable object of type String that may be null.

      • getStatus

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

      • getClassification

        public java.util.List<CodeableConcept> getClassification()
        A high level categorization, e.g. polymer or nucleic acid, or food, chemical, biological, or a lower level such as the general types of polymer (linear or branch chain) or type of impurity (process related or contaminant).
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getDomain

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

      • getGrade

        public java.util.List<CodeableConcept> getGrade()
        The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getDescription

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

      • getInformationSource

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

      • getNote

        public java.util.List<Annotation> getNote()
        Textual comment about the substance's catalogue or registry record.
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • getManufacturer

        public java.util.List<Reference> getManufacturer()
        The entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getSupplier

        public java.util.List<Reference> getSupplier()
        An entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • 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