Package com.ibm.fhir.model.resource

Class ValueSet.Compose.Builder

    • Method Detail

      • id

        public ValueSet.Compose.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.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

        Overrides:
        extension in class BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public ValueSet.Compose.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

        Overrides:
        extension in class BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public ValueSet.Compose.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

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

        Overrides:
        modifierExtension in class BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • lockedDate

        public ValueSet.Compose.Builder lockedDate​(Date lockedDate)
        The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.
        Parameters:
        lockedDate - Fixed date for references with no specified version (transitive)
        Returns:
        A reference to this Builder instance

      • inactive

        public ValueSet.Compose.Builder inactive​(Boolean inactive)
        Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).
        Parameters:
        inactive - Whether inactive codes are in the value set
        Returns:
        A reference to this Builder instance

      • include

        public ValueSet.Compose.Builder include​(ValueSet.Compose.Include... include)
        Include one or more codes from a code system or other value set(s).

        Adds new element(s) to the existing list

        This element is required.

        Parameters:
        include - Include one or more codes from a code system or other value set(s)
        Returns:
        A reference to this Builder instance

      • include

        public ValueSet.Compose.Builder include​(Collection<ValueSet.Compose.Include> include)
        Include one or more codes from a code system or other value set(s).

        Replaces the existing list with a new one containing elements from the Collection

        This element is required.

        Parameters:
        include - Include one or more codes from a code system or other value set(s)
        Returns:
        A reference to this Builder instance

      • exclude

        public ValueSet.Compose.Builder exclude​(ValueSet.Compose.Include... exclude)
        Exclude one or more codes from the value set based on code system filters and/or other value sets.

        Adds new element(s) to the existing list

        Parameters:
        exclude - Explicitly exclude codes from a code system or other value sets
        Returns:
        A reference to this Builder instance

      • exclude

        public ValueSet.Compose.Builder exclude​(Collection<ValueSet.Compose.Include> exclude)
        Exclude one or more codes from the value set based on code system filters and/or other value sets.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        exclude - Explicitly exclude codes from a code system or other value sets
        Returns:
        A reference to this Builder instance