Package com.ibm.fhir.model.type

Class ElementDefinition.Constraint.Builder

    • Method Detail

      • id

        public ElementDefinition.Constraint.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 ElementDefinition.Constraint.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 ElementDefinition.Constraint.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 ElementDefinition.Constraint.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.\n\nModifier 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 ElementDefinition.Constraint.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.\n\nModifier 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

      • key

        public ElementDefinition.Constraint.Builder key​(Id key)
        Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.

        This element is required.

        Parameters:
        key - Target of 'condition' reference above
        Returns:
        A reference to this Builder instance

      • requirements

        public ElementDefinition.Constraint.Builder requirements​(String requirements)
        Description of why this constraint is necessary or appropriate.
        Parameters:
        requirements - Why this constraint is necessary or appropriate
        Returns:
        A reference to this Builder instance

      • severity

        public ElementDefinition.Constraint.Builder severity​(ConstraintSeverity severity)
        Identifies the impact constraint violation has on the conformance of the instance.

        This element is required.

        Parameters:
        severity - error | warning
        Returns:
        A reference to this Builder instance

      • human

        public ElementDefinition.Constraint.Builder human​(String human)
        Text that can be used to describe the constraint in messages identifying that the constraint has been violated.

        This element is required.

        Parameters:
        human - Human description of constraint
        Returns:
        A reference to this Builder instance

      • expression

        public ElementDefinition.Constraint.Builder expression​(String expression)
        A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.
        Parameters:
        expression - FHIRPath expression of constraint
        Returns:
        A reference to this Builder instance

      • xpath

        public ElementDefinition.Constraint.Builder xpath​(String xpath)
        An XPath expression of constraint that can be executed to see if this constraint is met.
        Parameters:
        xpath - XPath expression of constraint
        Returns:
        A reference to this Builder instance

      • source

        public ElementDefinition.Constraint.Builder source​(Canonical source)
        A reference to the original source of the constraint, for traceability purposes.
        Parameters:
        source - Reference to original source of constraint
        Returns:
        A reference to this Builder instance