Package org.linuxforhealth.fhir.model.resource

Class Ingredient.Substance.Strength.Builder

    • Method Detail

      • id

        public Ingredient.Substance.Strength.Builder id​(java.lang.String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class BackboneElement.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public Ingredient.Substance.Strength.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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 BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public Ingredient.Substance.Strength.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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 BackboneElement.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 Ingredient.Substance.Strength.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public Ingredient.Substance.Strength.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • presentation

        public Ingredient.Substance.Strength.Builder presentation​(Element presentation)
        The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').

        This is a choice element with the following allowed types:

        Parameters:
        presentation - The quantity of substance in the unit of presentation
        Returns:
        A reference to this Builder instance

      • textPresentation

        public Ingredient.Substance.Strength.Builder textPresentation​(String textPresentation)
        A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.
        Parameters:
        textPresentation - Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio)
        Returns:
        A reference to this Builder instance

      • concentration

        public Ingredient.Substance.Strength.Builder concentration​(Element concentration)
        The strength per unitary volume (or mass).

        This is a choice element with the following allowed types:

        Parameters:
        concentration - The strength per unitary volume (or mass)
        Returns:
        A reference to this Builder instance

      • textConcentration

        public Ingredient.Substance.Strength.Builder textConcentration​(String textConcentration)
        A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.
        Parameters:
        textConcentration - Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio)
        Returns:
        A reference to this Builder instance

      • measurementPoint

        public Ingredient.Substance.Strength.Builder measurementPoint​(String measurementPoint)
        For when strength is measured at a particular point or distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization.
        Parameters:
        measurementPoint - When strength is measured at a particular point or distance
        Returns:
        A reference to this Builder instance

      • country

        public Ingredient.Substance.Strength.Builder country​(CodeableConcept... country)
        The country or countries for which the strength range applies.

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

        Parameters:
        country - Where the strength range applies
        Returns:
        A reference to this Builder instance

      • country

        public Ingredient.Substance.Strength.Builder country​(java.util.Collection<CodeableConcept> country)
        The country or countries for which the strength range applies.

        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:
        country - Where the strength range applies
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • referenceStrength

        public Ingredient.Substance.Strength.Builder referenceStrength​(Ingredient.Substance.Strength.ReferenceStrength... referenceStrength)
        Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed.

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

        Parameters:
        referenceStrength - Strength expressed in terms of a reference substance
        Returns:
        A reference to this Builder instance

      • referenceStrength

        public Ingredient.Substance.Strength.Builder referenceStrength​(java.util.Collection<Ingredient.Substance.Strength.ReferenceStrength> referenceStrength)
        Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed.

        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:
        referenceStrength - Strength expressed in terms of a reference substance
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null