Package org.linuxforhealth.fhir.model.resource

Class Ingredient

  • All Implemented Interfaces:
    Visitable
    @Generated("org.linuxforhealth.fhir.tools.CodeGenerator")
public class Ingredient
extends DomainResource
    An ingredient of a manufactured item or pharmaceutical product.

    Maturity level: FMM1 (Trial Use)

    • Method Detail

      • getIdentifier

        public Identifier getIdentifier()
        The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
        Returns:
        An immutable object of type Identifier that may be null.

      • getStatus

        public PublicationStatus getStatus()
        The status of this ingredient. Enables tracking the life-cycle of the content.
        Returns:
        An immutable object of type PublicationStatus that is non-null.

      • getFor

        public java.util.List<Reference> getFor()
        The product which this ingredient is a constituent part of.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getRole

        public CodeableConcept getRole()
        A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.
        Returns:
        An immutable object of type CodeableConcept that is non-null.

      • getFunction

        public java.util.List<CodeableConcept> getFunction()
        A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient. role to add more detail. Example: antioxidant, alkalizing agent.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getAllergenicIndicator

        public Boolean getAllergenicIndicator()
        If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here.
        Returns:
        An immutable object of type Boolean that may be null.

      • getManufacturer

        public java.util.List<Ingredient.Manufacturer> getManufacturer()
        The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case.
        Returns:
        An unmodifiable list containing immutable objects of type Ingredient.Manufacturer 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