Package com.ibm.fhir.model.resource

Class EvidenceVariable.Characteristic.Builder

    • Method Detail

      • id

        public EvidenceVariable.Characteristic.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 EvidenceVariable.Characteristic.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 EvidenceVariable.Characteristic.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 EvidenceVariable.Characteristic.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 EvidenceVariable.Characteristic.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

      • description

        public EvidenceVariable.Characteristic.Builder description​(String description)
        A short, natural language description of the characteristic that could be used to communicate the criteria to an end- user.
        Parameters:
        description - Natural language description of the characteristic
        Returns:
        A reference to this Builder instance

      • usageContext

        public EvidenceVariable.Characteristic.Builder usageContext​(UsageContext... usageContext)
        Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.

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

        Parameters:
        usageContext - What code/value pairs define members?
        Returns:
        A reference to this Builder instance

      • usageContext

        public EvidenceVariable.Characteristic.Builder usageContext​(java.util.Collection<UsageContext> usageContext)
        Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.

        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:
        usageContext - What code/value pairs define members?
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • exclude

        public EvidenceVariable.Characteristic.Builder exclude​(Boolean exclude)
        When true, members with this characteristic are excluded from the element.
        Parameters:
        exclude - Whether the characteristic includes or excludes members
        Returns:
        A reference to this Builder instance

      • participantEffective

        public EvidenceVariable.Characteristic.Builder participantEffective​(Element participantEffective)
        Indicates what effective period the study covers.

        This is a choice element with the following allowed types:

        Parameters:
        participantEffective - What time period do participants cover
        Returns:
        A reference to this Builder instance

      • timeFromStart

        public EvidenceVariable.Characteristic.Builder timeFromStart​(Duration timeFromStart)
        Indicates duration from the participant's study entry.
        Parameters:
        timeFromStart - Observation time from study start
        Returns:
        A reference to this Builder instance

      • groupMeasure

        public EvidenceVariable.Characteristic.Builder groupMeasure​(GroupMeasure groupMeasure)
        Indicates how elements are aggregated within the study effective period.
        Parameters:
        groupMeasure - mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
        Returns:
        A reference to this Builder instance