Package com.ibm.fhir.model.resource

Class OperationDefinition.Parameter.Builder

    • Method Detail

      • id

        public OperationDefinition.Parameter.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 OperationDefinition.Parameter.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 OperationDefinition.Parameter.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 OperationDefinition.Parameter.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 OperationDefinition.Parameter.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

      • name

        public OperationDefinition.Parameter.Builder name​(Code name)
        The name of used to identify the parameter.

        This element is required.

        Parameters:
        name - Name in Parameters.parameter.name or in URL
        Returns:
        A reference to this Builder instance

      • min

        public OperationDefinition.Parameter.Builder min​(Integer min)
        The minimum number of times this parameter SHALL appear in the request or response.

        This element is required.

        Parameters:
        min - Minimum Cardinality
        Returns:
        A reference to this Builder instance

      • max

        public OperationDefinition.Parameter.Builder max​(String max)
        The maximum number of times this element is permitted to appear in the request or response.

        This element is required.

        Parameters:
        max - Maximum Cardinality (a number or *)
        Returns:
        A reference to this Builder instance

      • documentation

        public OperationDefinition.Parameter.Builder documentation​(String documentation)
        Describes the meaning or use of this parameter.
        Parameters:
        documentation - Description of meaning/use
        Returns:
        A reference to this Builder instance

      • targetProfile

        public OperationDefinition.Parameter.Builder targetProfile​(Canonical... targetProfile)
        Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

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

        Parameters:
        targetProfile - If type is Reference | canonical, allowed targets
        Returns:
        A reference to this Builder instance

      • targetProfile

        public OperationDefinition.Parameter.Builder targetProfile​(Collection<Canonical> targetProfile)
        Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

        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:
        targetProfile - If type is Reference | canonical, allowed targets
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • searchType

        public OperationDefinition.Parameter.Builder searchType​(SearchParamType searchType)
        How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.
        Parameters:
        searchType - number | date | string | token | reference | composite | quantity | uri | special
        Returns:
        A reference to this Builder instance

      • referencedFrom

        public OperationDefinition.Parameter.Builder referencedFrom​(OperationDefinition.Parameter.ReferencedFrom... referencedFrom)
        Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.

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

        Parameters:
        referencedFrom - References to this parameter
        Returns:
        A reference to this Builder instance