Package org.linuxforhealth.fhir.model.resource

Class SubstanceDefinition.Structure.Builder

    • Method Detail

      • id

        public SubstanceDefinition.Structure.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 SubstanceDefinition.Structure.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 SubstanceDefinition.Structure.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 SubstanceDefinition.Structure.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 SubstanceDefinition.Structure.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

      • molecularFormula

        public SubstanceDefinition.Structure.Builder molecularFormula​(String molecularFormula)
        Molecular formula of this substance, typically using the Hill system.
        Parameters:
        molecularFormula - Molecular formula (e.g. using the Hill system)
        Returns:
        A reference to this Builder instance

      • molecularFormulaByMoiety

        public SubstanceDefinition.Structure.Builder molecularFormulaByMoiety​(String molecularFormulaByMoiety)
        Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.
        Parameters:
        molecularFormulaByMoiety - Specified per moiety according to the Hill system
        Returns:
        A reference to this Builder instance

      • technique

        public SubstanceDefinition.Structure.Builder technique​(CodeableConcept... technique)
        The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay.

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

        Parameters:
        technique - The method used to find the structure e.g. X-ray, NMR
        Returns:
        A reference to this Builder instance

      • technique

        public SubstanceDefinition.Structure.Builder technique​(java.util.Collection<CodeableConcept> technique)
        The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay.

        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:
        technique - The method used to find the structure e.g. X-ray, NMR
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • sourceDocument

        public SubstanceDefinition.Structure.Builder sourceDocument​(Reference... sourceDocument)
        The source of information about the structure.

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

        Allowed resource types for the references:

        Parameters:
        sourceDocument - Source of information for the structure
        Returns:
        A reference to this Builder instance

      • sourceDocument

        public SubstanceDefinition.Structure.Builder sourceDocument​(java.util.Collection<Reference> sourceDocument)
        The source of information about the structure.

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

        Allowed resource types for the references:

        Parameters:
        sourceDocument - Source of information for the structure
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • representation

        public SubstanceDefinition.Structure.Builder representation​(SubstanceDefinition.Structure.Representation... representation)
        A depiction of the structure or characterization of the substance.

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

        Parameters:
        representation - A depiction of the structure or characterization of the substance
        Returns:
        A reference to this Builder instance

      • representation

        public SubstanceDefinition.Structure.Builder representation​(java.util.Collection<SubstanceDefinition.Structure.Representation> representation)
        A depiction of the structure or characterization of the substance.

        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:
        representation - A depiction of the structure or characterization of the substance
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null