Package com.ibm.fhir.model.resource

Class ValueSet.Compose.Include.Builder

    • Method Detail

      • id

        public ValueSet.Compose.Include.Builder id​(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 ValueSet.Compose.Include.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 ValueSet.Compose.Include.Builder extension​(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:
        NullPointerException - If the passed collection is null

      • modifierExtension

        public ValueSet.Compose.Include.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 ValueSet.Compose.Include.Builder modifierExtension​(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:
        NullPointerException - If the passed collection is null

      • system

        public ValueSet.Compose.Include.Builder system​(Uri system)
        An absolute URI which is the code system from which the selected codes come from.
        Parameters:
        system - The system the codes come from
        Returns:
        A reference to this Builder instance

      • version

        public ValueSet.Compose.Include.Builder version​(String version)
        The version of the code system that the codes are selected from, or the special version '*' for all versions.
        Parameters:
        version - Specific version of the code system referred to
        Returns:
        A reference to this Builder instance

      • concept

        public ValueSet.Compose.Include.Builder concept​(ValueSet.Compose.Include.Concept... concept)
        Specifies a concept to be included or excluded.

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

        Parameters:
        concept - A concept defined in the system
        Returns:
        A reference to this Builder instance

      • filter

        public ValueSet.Compose.Include.Builder filter​(ValueSet.Compose.Include.Filter... filter)
        Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true.

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

        Parameters:
        filter - Select codes/concepts by their properties (including relationships)
        Returns:
        A reference to this Builder instance

      • filter

        public ValueSet.Compose.Include.Builder filter​(Collection<ValueSet.Compose.Include.Filter> filter)
        Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true.

        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:
        filter - Select codes/concepts by their properties (including relationships)
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • valueSet

        public ValueSet.Compose.Include.Builder valueSet​(Canonical... valueSet)
        Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets.

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

        Parameters:
        valueSet - Select the contents included in this value set
        Returns:
        A reference to this Builder instance

      • valueSet

        public ValueSet.Compose.Include.Builder valueSet​(Collection<Canonical> valueSet)
        Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets.

        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:
        valueSet - Select the contents included in this value set
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null