Package com.ibm.fhir.model.type

Class ElementDefinition.Builder

    • Method Detail

      • id

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

      • path

        public ElementDefinition.Builder path​(String path)
        The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension.

        This element is required.

        Parameters:
        path - Path of the element in the hierarchy of elements
        Returns:
        A reference to this Builder instance

      • representation

        public ElementDefinition.Builder representation​(PropertyRepresentation... representation)
        Codes that define how this element is represented in instances, when the deviation varies from the normal case.

        Adds new element(s) to the existing list

        Parameters:
        representation - xmlAttr | xmlText | typeAttr | cdaText | xhtml
        Returns:
        A reference to this Builder instance

      • representation

        public ElementDefinition.Builder representation​(Collection<PropertyRepresentation> representation)
        Codes that define how this element is represented in instances, when the deviation varies from the normal case.

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

        Parameters:
        representation - xmlAttr | xmlText | typeAttr | cdaText | xhtml
        Returns:
        A reference to this Builder instance

      • sliceName

        public ElementDefinition.Builder sliceName​(String sliceName)
        The name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element.
        Parameters:
        sliceName - Name for this particular element (in a set of slices)
        Returns:
        A reference to this Builder instance

      • sliceIsConstraining

        public ElementDefinition.Builder sliceIsConstraining​(Boolean sliceIsConstraining)
        If true, indicates that this slice definition is constraining a slice definition with the same name in an inherited profile. If false, the slice is not overriding any slice in an inherited profile. If missing, the slice might or might not be overriding a slice in an inherited profile, depending on the sliceName.
        Parameters:
        sliceIsConstraining - If this slice definition constrains an inherited slice definition (or not)
        Returns:
        A reference to this Builder instance

      • label

        public ElementDefinition.Builder label​(String label)
        A single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.
        Parameters:
        label - Name for element to display with or prompt for element
        Returns:
        A reference to this Builder instance

      • code

        public ElementDefinition.Builder code​(Coding... code)
        A code that has the same meaning as the element in a particular terminology.

        Adds new element(s) to the existing list

        Parameters:
        code - Corresponding codes in terminologies
        Returns:
        A reference to this Builder instance

      • code

        public ElementDefinition.Builder code​(Collection<Coding> code)
        A code that has the same meaning as the element in a particular terminology.

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

        Parameters:
        code - Corresponding codes in terminologies
        Returns:
        A reference to this Builder instance

      • slicing

        public ElementDefinition.Builder slicing​(ElementDefinition.Slicing slicing)
        Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).
        Parameters:
        slicing - This element is sliced - slices follow
        Returns:
        A reference to this Builder instance

      • _short

        public ElementDefinition.Builder _short​(String _short)
        A concise description of what this element means (e.g. for use in autogenerated summaries).
        Parameters:
        _short - Concise definition for space-constrained presentation
        Returns:
        A reference to this Builder instance

      • definition

        public ElementDefinition.Builder definition​(Markdown definition)
        Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource. (Note: The text you are reading is specified in ElementDefinition.definition).
        Parameters:
        definition - Full formal definition as narrative text
        Returns:
        A reference to this Builder instance

      • comment

        public ElementDefinition.Builder comment​(Markdown comment)
        Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc. (Note: The text you are reading is specified in ElementDefinition.comment).
        Parameters:
        comment - Comments about the use of this element
        Returns:
        A reference to this Builder instance

      • requirements

        public ElementDefinition.Builder requirements​(Markdown requirements)
        This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element.
        Parameters:
        requirements - Why this resource has been created
        Returns:
        A reference to this Builder instance

      • alias

        public ElementDefinition.Builder alias​(String... alias)
        Identifies additional names by which this element might also be known.

        Adds new element(s) to the existing list

        Parameters:
        alias - Other names
        Returns:
        A reference to this Builder instance

      • alias

        public ElementDefinition.Builder alias​(Collection<String> alias)
        Identifies additional names by which this element might also be known.

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

        Parameters:
        alias - Other names
        Returns:
        A reference to this Builder instance

      • min

        public ElementDefinition.Builder min​(UnsignedInt min)
        The minimum number of times this element SHALL appear in the instance.
        Parameters:
        min - Minimum Cardinality
        Returns:
        A reference to this Builder instance

      • max

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

      • base

        public ElementDefinition.Builder base​(ElementDefinition.Base base)
        Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same.
        Parameters:
        base - Base definition information for tools
        Returns:
        A reference to this Builder instance

      • contentReference

        public ElementDefinition.Builder contentReference​(Uri contentReference)
        Identifies an element defined elsewhere in the definition whose content rules should be applied to the current element. ContentReferences bring across all the rules that are in the ElementDefinition for the element, including definitions, cardinality constraints, bindings, invariants etc.
        Parameters:
        contentReference - Reference to definition of content for the element
        Returns:
        A reference to this Builder instance

      • type

        public ElementDefinition.Builder type​(ElementDefinition.Type... type)
        The data type or resource that the value of this element is permitted to be.

        Adds new element(s) to the existing list

        Parameters:
        type - Data type and Profile for this element
        Returns:
        A reference to this Builder instance

      • type

        public ElementDefinition.Builder type​(Collection<ElementDefinition.Type> type)
        The data type or resource that the value of this element is permitted to be.

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

        Parameters:
        type - Data type and Profile for this element
        Returns:
        A reference to this Builder instance

      • meaningWhenMissing

        public ElementDefinition.Builder meaningWhenMissing​(Markdown meaningWhenMissing)
        The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing').
        Parameters:
        meaningWhenMissing - Implicit meaning when this element is missing
        Returns:
        A reference to this Builder instance

      • orderMeaning

        public ElementDefinition.Builder orderMeaning​(String orderMeaning)
        If present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning.
        Parameters:
        orderMeaning - What the order of the elements means
        Returns:
        A reference to this Builder instance

      • example

        public ElementDefinition.Builder example​(ElementDefinition.Example... example)
        A sample value for this element demonstrating the type of information that would typically be found in the element.

        Adds new element(s) to the existing list

        Parameters:
        example - Example value (as defined for type)
        Returns:
        A reference to this Builder instance

      • example

        public ElementDefinition.Builder example​(Collection<ElementDefinition.Example> example)
        A sample value for this element demonstrating the type of information that would typically be found in the element.

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

        Parameters:
        example - Example value (as defined for type)
        Returns:
        A reference to this Builder instance

      • maxLength

        public ElementDefinition.Builder maxLength​(Integer maxLength)
        Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element.
        Parameters:
        maxLength - Max length for strings
        Returns:
        A reference to this Builder instance

      • condition

        public ElementDefinition.Builder condition​(Id... condition)
        A reference to an invariant that may make additional statements about the cardinality or value in the instance.

        Adds new element(s) to the existing list

        Parameters:
        condition - Reference to invariant about presence
        Returns:
        A reference to this Builder instance

      • condition

        public ElementDefinition.Builder condition​(Collection<Id> condition)
        A reference to an invariant that may make additional statements about the cardinality or value in the instance.

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

        Parameters:
        condition - Reference to invariant about presence
        Returns:
        A reference to this Builder instance

      • constraint

        public ElementDefinition.Builder constraint​(ElementDefinition.Constraint... constraint)
        Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.

        Adds new element(s) to the existing list

        Parameters:
        constraint - Condition that must evaluate to true
        Returns:
        A reference to this Builder instance

      • constraint

        public ElementDefinition.Builder constraint​(Collection<ElementDefinition.Constraint> constraint)
        Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.

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

        Parameters:
        constraint - Condition that must evaluate to true
        Returns:
        A reference to this Builder instance

      • mustSupport

        public ElementDefinition.Builder mustSupport​(Boolean mustSupport)
        If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way. If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation.
        Parameters:
        mustSupport - If the element must be supported
        Returns:
        A reference to this Builder instance

      • isModifier

        public ElementDefinition.Builder isModifier​(Boolean isModifier)
        If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.
        Parameters:
        isModifier - If this modifies the meaning of other elements
        Returns:
        A reference to this Builder instance

      • isModifierReason

        public ElementDefinition.Builder isModifierReason​(String isModifierReason)
        Explains how that element affects the interpretation of the resource or element that contains it.
        Parameters:
        isModifierReason - Reason that this element is marked as a modifier
        Returns:
        A reference to this Builder instance

      • isSummary

        public ElementDefinition.Builder isSummary​(Boolean isSummary)
        Whether the element should be included if a client requests a search with the parameter _summary=true.
        Parameters:
        isSummary - Include when _summary = true?
        Returns:
        A reference to this Builder instance

      • binding

        public ElementDefinition.Builder binding​(ElementDefinition.Binding binding)
        Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).
        Parameters:
        binding - ValueSet details if this is coded
        Returns:
        A reference to this Builder instance

      • mapping

        public ElementDefinition.Builder mapping​(ElementDefinition.Mapping... mapping)
        Identifies a concept from an external specification that roughly corresponds to this element.

        Adds new element(s) to the existing list

        Parameters:
        mapping - Map element to another set of definitions
        Returns:
        A reference to this Builder instance

      • mapping

        public ElementDefinition.Builder mapping​(Collection<ElementDefinition.Mapping> mapping)
        Identifies a concept from an external specification that roughly corresponds to this element.

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

        Parameters:
        mapping - Map element to another set of definitions
        Returns:
        A reference to this Builder instance