Package com.ibm.fhir.model.resource

Class ResearchElementDefinition.Characteristic.Builder

    • Method Detail

      • id

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

      • definition

        public ResearchElementDefinition.Characteristic.Builder definition​(Element definition)
        Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).

        This element is required.

        This is a choice element with the following allowed types:

        Parameters:
        definition - What code or expression defines members?
        Returns:
        A reference to this Builder instance

      • usageContext

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

      • studyEffectiveDescription

        public ResearchElementDefinition.Characteristic.Builder studyEffectiveDescription​(String studyEffectiveDescription)
        A narrative description of the time period the study covers.
        Parameters:
        studyEffectiveDescription - What time period does the study cover
        Returns:
        A reference to this Builder instance

      • studyEffectiveTimeFromStart

        public ResearchElementDefinition.Characteristic.Builder studyEffectiveTimeFromStart​(Duration studyEffectiveTimeFromStart)
        Indicates duration from the study initiation.
        Parameters:
        studyEffectiveTimeFromStart - Observation time from study start
        Returns:
        A reference to this Builder instance

      • studyEffectiveGroupMeasure

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

      • participantEffectiveDescription

        public ResearchElementDefinition.Characteristic.Builder participantEffectiveDescription​(String participantEffectiveDescription)
        A narrative description of the time period the study covers.
        Parameters:
        participantEffectiveDescription - What time period do participants cover
        Returns:
        A reference to this Builder instance

      • participantEffectiveTimeFromStart

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

      • participantEffectiveGroupMeasure

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