Package com.ibm.fhir.model.resource

Class SubstanceSourceMaterial.Builder

    • Method Detail

      • id

        public SubstanceSourceMaterial.Builder id​(java.lang.String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public SubstanceSourceMaterial.Builder meta​(Meta meta)
        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public SubstanceSourceMaterial.Builder implicitRules​(Uri implicitRules)
        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • text

        public SubstanceSourceMaterial.Builder text​(Narrative text)
        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public SubstanceSourceMaterial.Builder contained​(Resource... contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public SubstanceSourceMaterial.Builder contained​(java.util.Collection<Resource> contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public SubstanceSourceMaterial.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public SubstanceSourceMaterial.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public SubstanceSourceMaterial.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public SubstanceSourceMaterial.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • sourceMaterialClass

        public SubstanceSourceMaterial.Builder sourceMaterialClass​(CodeableConcept sourceMaterialClass)
        General high level classification of the source material specific to the origin of the material.
        Parameters:
        sourceMaterialClass - General high level classification of the source material specific to the origin of the material
        Returns:
        A reference to this Builder instance

      • sourceMaterialType

        public SubstanceSourceMaterial.Builder sourceMaterialType​(CodeableConcept sourceMaterialType)
        The type of the source material shall be specified based on a controlled vocabulary. For vaccines, this subclause refers to the class of infectious agent.
        Parameters:
        sourceMaterialType - The type of the source material shall be specified based on a controlled vocabulary. For vaccines, this subclause refers to the class of infectious agent
        Returns:
        A reference to this Builder instance

      • sourceMaterialState

        public SubstanceSourceMaterial.Builder sourceMaterialState​(CodeableConcept sourceMaterialState)
        The state of the source material when extracted.
        Parameters:
        sourceMaterialState - The state of the source material when extracted
        Returns:
        A reference to this Builder instance

      • organismId

        public SubstanceSourceMaterial.Builder organismId​(Identifier organismId)
        The unique identifier associated with the source material parent organism shall be specified.
        Parameters:
        organismId - The unique identifier associated with the source material parent organism shall be specified
        Returns:
        A reference to this Builder instance

      • organismName

        public SubstanceSourceMaterial.Builder organismName​(String organismName)
        The organism accepted Scientific name shall be provided based on the organism taxonomy.
        Parameters:
        organismName - The organism accepted Scientific name shall be provided based on the organism taxonomy
        Returns:
        A reference to this Builder instance

      • parentSubstanceId

        public SubstanceSourceMaterial.Builder parentSubstanceId​(Identifier... parentSubstanceId)
        The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        parentSubstanceId - The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant)
        Returns:
        A reference to this Builder instance

      • parentSubstanceId

        public SubstanceSourceMaterial.Builder parentSubstanceId​(java.util.Collection<Identifier> parentSubstanceId)
        The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        parentSubstanceId - The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • parentSubstanceName

        public SubstanceSourceMaterial.Builder parentSubstanceName​(java.lang.String... parentSubstanceName)
        Convenience method for setting parentSubstanceName.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        parentSubstanceName - The parent substance of the Herbal Drug, or Herbal preparation
        Returns:
        A reference to this Builder instance
        See Also:
        #parentSubstanceName(com.ibm.fhir.model.type.String)

      • parentSubstanceName

        public SubstanceSourceMaterial.Builder parentSubstanceName​(String... parentSubstanceName)
        The parent substance of the Herbal Drug, or Herbal preparation.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        parentSubstanceName - The parent substance of the Herbal Drug, or Herbal preparation
        Returns:
        A reference to this Builder instance

      • parentSubstanceName

        public SubstanceSourceMaterial.Builder parentSubstanceName​(java.util.Collection<String> parentSubstanceName)
        The parent substance of the Herbal Drug, or Herbal preparation.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        parentSubstanceName - The parent substance of the Herbal Drug, or Herbal preparation
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • countryOfOrigin

        public SubstanceSourceMaterial.Builder countryOfOrigin​(CodeableConcept... countryOfOrigin)
        The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For “Plasma-derived substances” the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        countryOfOrigin - The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For “Plasma-derived substances” the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate
        Returns:
        A reference to this Builder instance

      • countryOfOrigin

        public SubstanceSourceMaterial.Builder countryOfOrigin​(java.util.Collection<CodeableConcept> countryOfOrigin)
        The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For “Plasma-derived substances” the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        countryOfOrigin - The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For “Plasma-derived substances” the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • geographicalLocation

        public SubstanceSourceMaterial.Builder geographicalLocation​(java.lang.String... geographicalLocation)
        Convenience method for setting geographicalLocation.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        geographicalLocation - The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
        Returns:
        A reference to this Builder instance
        See Also:
        #geographicalLocation(com.ibm.fhir.model.type.String)

      • geographicalLocation

        public SubstanceSourceMaterial.Builder geographicalLocation​(String... geographicalLocation)
        The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        geographicalLocation - The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
        Returns:
        A reference to this Builder instance

      • geographicalLocation

        public SubstanceSourceMaterial.Builder geographicalLocation​(java.util.Collection<String> geographicalLocation)
        The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        geographicalLocation - The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • developmentStage

        public SubstanceSourceMaterial.Builder developmentStage​(CodeableConcept developmentStage)
        Stage of life for animals, plants, insects and microorganisms. This information shall be provided only when the substance is significantly different in these stages (e.g. foetal bovine serum).
        Parameters:
        developmentStage - Stage of life for animals, plants, insects and microorganisms. This information shall be provided only when the substance is significantly different in these stages (e.g. foetal bovine serum)
        Returns:
        A reference to this Builder instance

      • fractionDescription

        public SubstanceSourceMaterial.Builder fractionDescription​(SubstanceSourceMaterial.FractionDescription... fractionDescription)
        Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        fractionDescription - Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels
        Returns:
        A reference to this Builder instance

      • fractionDescription

        public SubstanceSourceMaterial.Builder fractionDescription​(java.util.Collection<SubstanceSourceMaterial.FractionDescription> fractionDescription)
        Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        fractionDescription - Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • organism

        public SubstanceSourceMaterial.Builder organism​(SubstanceSourceMaterial.Organism organism)
        This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf.
        Parameters:
        organism - This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf
        Returns:
        A reference to this Builder instance

      • partDescription

        public SubstanceSourceMaterial.Builder partDescription​(java.util.Collection<SubstanceSourceMaterial.PartDescription> partDescription)
        To do.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        partDescription - To do
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null