Package com.ibm.fhir.model.type

Class ParameterDefinition.Builder

    • Method Detail

      • id

        public ParameterDefinition.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 Element.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public ParameterDefinition.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 Element.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public ParameterDefinition.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 Element.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • name

        public ParameterDefinition.Builder name​(Code name)
        The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
        Parameters:
        name - Name used to access the parameter value
        Returns:
        A reference to this Builder instance

      • use

        public ParameterDefinition.Builder use​(ParameterUse use)
        Whether the parameter is input or output for the module.

        This element is required.

        Parameters:
        use - in | out
        Returns:
        A reference to this Builder instance

      • min

        public ParameterDefinition.Builder min​(Integer min)
        The minimum number of times this parameter SHALL appear in the request or response.
        Parameters:
        min - Minimum cardinality
        Returns:
        A reference to this Builder instance

      • max

        public ParameterDefinition.Builder max​(String max)
        The maximum number of times this element is permitted to appear in the request or response.
        Parameters:
        max - Maximum cardinality (a number of *)
        Returns:
        A reference to this Builder instance

      • documentation

        public ParameterDefinition.Builder documentation​(String documentation)
        A brief discussion of what the parameter is for and how it is used by the module.
        Parameters:
        documentation - A brief description of the parameter
        Returns:
        A reference to this Builder instance

      • type

        public ParameterDefinition.Builder type​(FHIRAllTypes type)
        The type of the parameter.

        This element is required.

        Parameters:
        type - What type of value
        Returns:
        A reference to this Builder instance

      • profile

        public ParameterDefinition.Builder profile​(Canonical profile)
        If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
        Parameters:
        profile - What profile the value is expected to be
        Returns:
        A reference to this Builder instance