Package org.linuxforhealth.fhir.model.resource

Class SubstanceDefinition.Name.Builder

    • Method Detail

      • id

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

      • name

        public SubstanceDefinition.Name.Builder name​(String name)
        The actual name.

        This element is required.

        Parameters:
        name - The actual name
        Returns:
        A reference to this Builder instance

      • type

        public SubstanceDefinition.Name.Builder type​(CodeableConcept type)
        Name type, for example 'systematic', 'scientific, 'brand'.
        Parameters:
        type - Name type e.g. 'systematic', 'scientific, 'brand'
        Returns:
        A reference to this Builder instance

      • status

        public SubstanceDefinition.Name.Builder status​(CodeableConcept status)
        The status of the name, for example 'current', 'proposed'.
        Parameters:
        status - The status of the name e.g. 'current', 'proposed'
        Returns:
        A reference to this Builder instance

      • preferred

        public SubstanceDefinition.Name.Builder preferred​(Boolean preferred)
        If this is the preferred name for this substance.
        Parameters:
        preferred - If this is the preferred name for this substance
        Returns:
        A reference to this Builder instance

      • language

        public SubstanceDefinition.Name.Builder language​(CodeableConcept... language)
        Human language that the name is written in.

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

        Parameters:
        language - Human language that the name is written in
        Returns:
        A reference to this Builder instance

      • language

        public SubstanceDefinition.Name.Builder language​(java.util.Collection<CodeableConcept> language)
        Human language that the name is written in.

        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:
        language - Human language that the name is written in
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • domain

        public SubstanceDefinition.Name.Builder domain​(CodeableConcept... domain)
        The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.

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

        Parameters:
        domain - The use context of this name e.g. as an active ingredient or as a food colour additive
        Returns:
        A reference to this Builder instance

      • domain

        public SubstanceDefinition.Name.Builder domain​(java.util.Collection<CodeableConcept> domain)
        The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.

        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:
        domain - The use context of this name e.g. as an active ingredient or as a food colour additive
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • jurisdiction

        public SubstanceDefinition.Name.Builder jurisdiction​(CodeableConcept... jurisdiction)
        The jurisdiction where this name applies.

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

        Parameters:
        jurisdiction - The jurisdiction where this name applies
        Returns:
        A reference to this Builder instance

      • jurisdiction

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

      • synonym

        public SubstanceDefinition.Name.Builder synonym​(SubstanceDefinition.Name... synonym)
        A synonym of this particular name, by which the substance is also known.

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

        Parameters:
        synonym - A synonym of this particular name, by which the substance is also known
        Returns:
        A reference to this Builder instance

      • synonym

        public SubstanceDefinition.Name.Builder synonym​(java.util.Collection<SubstanceDefinition.Name> synonym)
        A synonym of this particular name, by which the substance is also 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:
        synonym - A synonym of this particular name, by which the substance is also known
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • translation

        public SubstanceDefinition.Name.Builder translation​(SubstanceDefinition.Name... translation)
        A translation for this name into another human language.

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

        Parameters:
        translation - A translation for this name into another human language
        Returns:
        A reference to this Builder instance

      • translation

        public SubstanceDefinition.Name.Builder translation​(java.util.Collection<SubstanceDefinition.Name> translation)
        A translation for this name into another human language.

        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:
        translation - A translation for this name into another human language
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • official

        public SubstanceDefinition.Name.Builder official​(SubstanceDefinition.Name.Official... official)
        Details of the official nature of this name.

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

        Parameters:
        official - Details of the official nature of this name
        Returns:
        A reference to this Builder instance

      • official

        public SubstanceDefinition.Name.Builder official​(java.util.Collection<SubstanceDefinition.Name.Official> official)
        Details of the official nature of this name.

        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:
        official - Details of the official nature of this name
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • source

        public SubstanceDefinition.Name.Builder source​(Reference... source)
        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:
        source - Supporting literature
        Returns:
        A reference to this Builder instance

      • source

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