Package org.linuxforhealth.fhir.model.resource

Class SubstanceDefinition.Builder

    • Method Detail

      • id

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

      • identifier

        public SubstanceDefinition.Builder identifier​(Identifier... identifier)
        Identifier by which this substance is known.

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

        Parameters:
        identifier - Identifier by which this substance is known
        Returns:
        A reference to this Builder instance

      • identifier

        public SubstanceDefinition.Builder identifier​(java.util.Collection<Identifier> identifier)
        Identifier by which this substance is known.

        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:
        identifier - Identifier by which this substance is known
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • version

        public SubstanceDefinition.Builder version​(String version)
        A business level version identifier of the substance.
        Parameters:
        version - A business level version identifier of the substance
        Returns:
        A reference to this Builder instance

      • status

        public SubstanceDefinition.Builder status​(CodeableConcept status)
        Status of substance within the catalogue e.g. active, retired.
        Parameters:
        status - Status of substance within the catalogue e.g. active, retired
        Returns:
        A reference to this Builder instance

      • classification

        public SubstanceDefinition.Builder classification​(CodeableConcept... classification)
        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).

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

        Parameters:
        classification - A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity
        Returns:
        A reference to this Builder instance

      • classification

        public SubstanceDefinition.Builder classification​(java.util.Collection<CodeableConcept> classification)
        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).

        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:
        classification - A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • domain

        public SubstanceDefinition.Builder domain​(CodeableConcept domain)
        If the substance applies to human or veterinary use.
        Parameters:
        domain - If the substance applies to human or veterinary use
        Returns:
        A reference to this Builder instance

      • grade

        public SubstanceDefinition.Builder grade​(CodeableConcept... grade)
        The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).

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

        Parameters:
        grade - The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP)
        Returns:
        A reference to this Builder instance

      • grade

        public SubstanceDefinition.Builder grade​(java.util.Collection<CodeableConcept> grade)
        The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).

        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:
        grade - The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • description

        public SubstanceDefinition.Builder description​(Markdown description)
        Textual description of the substance.
        Parameters:
        description - Textual description of the substance
        Returns:
        A reference to this Builder instance

      • informationSource

        public SubstanceDefinition.Builder informationSource​(Reference... informationSource)
        Supporting literature.

        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:
        informationSource - Supporting literature
        Returns:
        A reference to this Builder instance

      • informationSource

        public SubstanceDefinition.Builder informationSource​(java.util.Collection<Reference> informationSource)
        Supporting literature.

        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:
        informationSource - Supporting literature
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • note

        public SubstanceDefinition.Builder note​(Annotation... note)
        Textual comment about the substance's catalogue or registry record.

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

        Parameters:
        note - Textual comment about the substance's catalogue or registry record
        Returns:
        A reference to this Builder instance

      • note

        public SubstanceDefinition.Builder note​(java.util.Collection<Annotation> note)
        Textual comment about the substance's catalogue or registry record.

        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:
        note - Textual comment about the substance's catalogue or registry record
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • manufacturer

        public SubstanceDefinition.Builder manufacturer​(Reference... manufacturer)
        The entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.

        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:
        manufacturer - The entity that creates, makes, produces or fabricates the substance
        Returns:
        A reference to this Builder instance

      • manufacturer

        public SubstanceDefinition.Builder manufacturer​(java.util.Collection<Reference> manufacturer)
        The entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.

        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:
        manufacturer - The entity that creates, makes, produces or fabricates the substance
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • supplier

        public SubstanceDefinition.Builder supplier​(Reference... supplier)
        An entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.

        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:
        supplier - An entity that is the source for the substance. It may be different from the manufacturer
        Returns:
        A reference to this Builder instance

      • supplier

        public SubstanceDefinition.Builder supplier​(java.util.Collection<Reference> supplier)
        An entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.

        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:
        supplier - An entity that is the source for the substance. It may be different from the manufacturer
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • moiety

        public SubstanceDefinition.Builder moiety​(SubstanceDefinition.Moiety... moiety)
        Moiety, for structural modifications.

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

        Parameters:
        moiety - Moiety, for structural modifications
        Returns:
        A reference to this Builder instance

      • moiety

        public SubstanceDefinition.Builder moiety​(java.util.Collection<SubstanceDefinition.Moiety> moiety)
        Moiety, for structural modifications.

        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:
        moiety - Moiety, for structural modifications
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • property

        public SubstanceDefinition.Builder property​(SubstanceDefinition.Property... property)
        General specifications for this substance.

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

        Parameters:
        property - General specifications for this substance
        Returns:
        A reference to this Builder instance

      • property

        public SubstanceDefinition.Builder property​(java.util.Collection<SubstanceDefinition.Property> property)
        General specifications for this 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:
        property - General specifications for this substance
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • molecularWeight

        public SubstanceDefinition.Builder molecularWeight​(SubstanceDefinition.MolecularWeight... molecularWeight)
        The molecular weight or weight range (for proteins, polymers or nucleic acids).

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

        Parameters:
        molecularWeight - The molecular weight or weight range
        Returns:
        A reference to this Builder instance

      • molecularWeight

        public SubstanceDefinition.Builder molecularWeight​(java.util.Collection<SubstanceDefinition.MolecularWeight> molecularWeight)
        The molecular weight or weight range (for proteins, polymers or nucleic acids).

        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:
        molecularWeight - The molecular weight or weight range
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • code

        public SubstanceDefinition.Builder code​(SubstanceDefinition.Code... code)
        Codes associated with the substance.

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

        Parameters:
        code - Codes associated with the substance
        Returns:
        A reference to this Builder instance

      • code

        public SubstanceDefinition.Builder code​(java.util.Collection<SubstanceDefinition.Code> code)
        Codes associated with 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:
        code - Codes associated with the substance
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • name

        public SubstanceDefinition.Builder name​(SubstanceDefinition.Name... name)
        Names applicable to this substance.

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

        Parameters:
        name - Names applicable to this substance
        Returns:
        A reference to this Builder instance

      • name

        public SubstanceDefinition.Builder name​(java.util.Collection<SubstanceDefinition.Name> name)
        Names applicable to this 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:
        name - Names applicable to this substance
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • relationship

        public SubstanceDefinition.Builder relationship​(SubstanceDefinition.Relationship... relationship)
        A link between this substance and another, with details of the relationship.

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

        Parameters:
        relationship - A link between this substance and another
        Returns:
        A reference to this Builder instance

      • relationship

        public SubstanceDefinition.Builder relationship​(java.util.Collection<SubstanceDefinition.Relationship> relationship)
        A link between this substance and another, with details of the relationship.

        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:
        relationship - A link between this substance and another
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null