Package com.babylonhealth.lit.hl7_java.builders

Class ElementDefinitionBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(java.lang.String path)
        Required fields for ElementDefinition
        Parameters:
        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.

    • Method Detail

      • withId

        public ElementDefinitionBuilder.Impl withId​(@NonNull
                                            @NonNull java.lang.String id)
        Parameters:
        id - - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      • withMin

        public ElementDefinitionBuilder.Impl withMin​(@NonNull
                                             @NonNull java.lang.Integer min)
        Parameters:
        min - - The minimum number of times this element SHALL appear in the instance.

      • withMax

        public ElementDefinitionBuilder.Impl withMax​(@NonNull
                                             @NonNull java.lang.String max)
        Parameters:
        max - - The maximum number of times this element is permitted to appear in the instance.

      • withCode

        public ElementDefinitionBuilder.Impl withCode​(@NonNull
                                              @NonNull com.babylonhealth.lit.core.model.Coding... code)
        Parameters:
        code - - A code that has the same meaning as the element in a particular terminology.

      • withCode

        public ElementDefinitionBuilder.Impl withCode​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Coding> code)
        Parameters:
        code - - A code that has the same meaning as the element in a particular terminology.

      • withLabel

        public ElementDefinitionBuilder.Impl withLabel​(@NonNull
                                               @NonNull java.lang.String label)
        Parameters:
        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.

      • withShort

        public ElementDefinitionBuilder.Impl withShort​(@NonNull
                                               @NonNull java.lang.String _short)
        Parameters:
        _short - - A concise description of what this element means (e.g. for use in autogenerated summaries).

      • withAlias

        public ElementDefinitionBuilder.Impl withAlias​(@NonNull
                                               @NonNull java.lang.String... alias)
        Parameters:
        alias - - Identifies additional names by which this element might also be known.

      • withAlias

        public ElementDefinitionBuilder.Impl withAlias​(@NonNull
                                               @NonNull java.util.Collection<java.lang.String> alias)
        Parameters:
        alias - - Identifies additional names by which this element might also be known.

      • withComment

        public ElementDefinitionBuilder.Impl withComment​(@NonNull
                                                 @NonNull java.lang.String comment)
        Parameters:
        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).

      • withFixed

        public ElementDefinitionBuilder.Impl withFixed​(@NonNull
                                               @NonNull com.babylonhealth.lit.core_java.model.Unions.ChoiceAll fixed)
        Parameters:
        fixed - - Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing. Field is a 'choice' field. Type should be one of Address, Age, Annotation, Attachment, byte[], BigDecimal, Boolean, String, CodeableConcept, Coding, ContactDetail, ContactPoint, Contributor, Count, DataRequirement, Distance, Dosage, Duration, Expression, FHIRDate, FHIRDateTime, HumanName, Identifier, Integer, LocalTime, Meta, Money, ParameterDefinition, Period, Quantity, Range, Ratio, Reference, RelatedArtifact, SampledData, Signature, Timing, TriggerDefinition, UUID, UsageContext, ZonedDateTime. To pass the value in, wrap with one of the ElementDefinitionBuilder.fixed static methods

      • withExtension

        public ElementDefinitionBuilder.Impl withExtension​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.Extension... extension)
        Parameters:
        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.

      • withExtension

        public ElementDefinitionBuilder.Impl withExtension​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> extension)
        Parameters:
        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.

      • withExtension

        public ElementDefinitionBuilder.Impl withExtension​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... extension)

      • withSliceName

        public ElementDefinitionBuilder.Impl withSliceName​(@NonNull
                                                   @NonNull java.lang.String sliceName)
        Parameters:
        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.

      • withMaxLength

        public ElementDefinitionBuilder.Impl withMaxLength​(@NonNull
                                                   @NonNull java.lang.Integer maxLength)
        Parameters:
        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.

      • withCondition

        public ElementDefinitionBuilder.Impl withCondition​(@NonNull
                                                   @NonNull java.lang.String... condition)
        Parameters:
        condition - - A reference to an invariant that may make additional statements about the cardinality or value in the instance.

      • withCondition

        public ElementDefinitionBuilder.Impl withCondition​(@NonNull
                                                   @NonNull java.util.Collection<java.lang.String> condition)
        Parameters:
        condition - - A reference to an invariant that may make additional statements about the cardinality or value in the instance.

      • withIsSummary

        public ElementDefinitionBuilder.Impl withIsSummary​(@NonNull
                                                   @NonNull java.lang.Boolean isSummary)
        Parameters:
        isSummary - - Whether the element should be included if a client requests a search with the parameter _summary=true.

      • withDefinition

        public ElementDefinitionBuilder.Impl withDefinition​(@NonNull
                                                    @NonNull java.lang.String definition)
        Parameters:
        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).

      • withPattern

        public ElementDefinitionBuilder.Impl withPattern​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core_java.model.Unions.ChoiceAll pattern)
        Parameters:
        pattern - - Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example.

        When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.

        When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.

        When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,

        1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value. Field is a 'choice' field. Type should be one of Address, Age, Annotation, Attachment, byte[], BigDecimal, Boolean, String, CodeableConcept, Coding, ContactDetail, ContactPoint, Contributor, Count, DataRequirement, Distance, Dosage, Duration, Expression, FHIRDate, FHIRDateTime, HumanName, Identifier, Integer, LocalTime, Meta, Money, ParameterDefinition, Period, Quantity, Range, Ratio, Reference, RelatedArtifact, SampledData, Signature, Timing, TriggerDefinition, UUID, UsageContext, ZonedDateTime. To pass the value in, wrap with one of the ElementDefinitionBuilder.pattern static methods

      • withIsModifier

        public ElementDefinitionBuilder.Impl withIsModifier​(@NonNull
                                                    @NonNull java.lang.Boolean isModifier)
        Parameters:
        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.

      • withMinValue

        public ElementDefinitionBuilder.Impl withMinValue​(@NonNull
                                                  @NonNull Unions.Choice01480857620 minValue)
        Parameters:
        minValue - - The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. Field is a 'choice' field. Type should be one of BigDecimal, FHIRDate, FHIRDateTime, Integer, LocalTime, Quantity, ZonedDateTime. To pass the value in, wrap with one of the ElementDefinitionBuilder.minValue static methods

      • withMaxValue

        public ElementDefinitionBuilder.Impl withMaxValue​(@NonNull
                                                  @NonNull Unions.Choice01480857620 maxValue)
        Parameters:
        maxValue - - The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity. Field is a 'choice' field. Type should be one of BigDecimal, FHIRDate, FHIRDateTime, Integer, LocalTime, Quantity, ZonedDateTime. To pass the value in, wrap with one of the ElementDefinitionBuilder.maxValue static methods

      • withMustSupport

        public ElementDefinitionBuilder.Impl withMustSupport​(@NonNull
                                                     @NonNull java.lang.Boolean mustSupport)
        Parameters:
        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.

      • withRequirements

        public ElementDefinitionBuilder.Impl withRequirements​(@NonNull
                                                      @NonNull java.lang.String requirements)
        Parameters:
        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.

      • withOrderMeaning

        public ElementDefinitionBuilder.Impl withOrderMeaning​(@NonNull
                                                      @NonNull java.lang.String orderMeaning)
        Parameters:
        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.

      • withRepresentation

        public ElementDefinitionBuilder.Impl withRepresentation​(@NonNull
                                                        @NonNull com.babylonhealth.lit.hl7.PROPERTY_REPRESENTATION... representation)
        Parameters:
        representation - - Codes that define how this element is represented in instances, when the deviation varies from the normal case.

      • withRepresentation

        public ElementDefinitionBuilder.Impl withRepresentation​(@NonNull
                                                        @NonNull java.util.Collection<com.babylonhealth.lit.hl7.PROPERTY_REPRESENTATION> representation)
        Parameters:
        representation - - Codes that define how this element is represented in instances, when the deviation varies from the normal case.

      • withBase

        public ElementDefinitionBuilder.Impl withBase​(@NonNull
                                              com.babylonhealth.lit.hl7.model.ElementDefinition.Base base)
        Parameters:
        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.

      • withDefaultValue

        public ElementDefinitionBuilder.Impl withDefaultValue​(@NonNull
                                                      @NonNull com.babylonhealth.lit.core_java.model.Unions.ChoiceAll defaultValue)
        Parameters:
        defaultValue - - The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false'). Field is a 'choice' field. Type should be one of Address, Age, Annotation, Attachment, byte[], BigDecimal, Boolean, String, CodeableConcept, Coding, ContactDetail, ContactPoint, Contributor, Count, DataRequirement, Distance, Dosage, Duration, Expression, FHIRDate, FHIRDateTime, HumanName, Identifier, Integer, LocalTime, Meta, Money, ParameterDefinition, Period, Quantity, Range, Ratio, Reference, RelatedArtifact, SampledData, Signature, Timing, TriggerDefinition, UUID, UsageContext, ZonedDateTime. To pass the value in, wrap with one of the ElementDefinitionBuilder.defaultValue static methods

      • withContentReference

        public ElementDefinitionBuilder.Impl withContentReference​(@NonNull
                                                          @NonNull java.lang.String contentReference)
        Parameters:
        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.

      • withIsModifierReason

        public ElementDefinitionBuilder.Impl withIsModifierReason​(@NonNull
                                                          @NonNull java.lang.String isModifierReason)
        Parameters:
        isModifierReason - - Explains how that element affects the interpretation of the resource or element that contains it.

      • withModifierExtension

        public ElementDefinitionBuilder.Impl withModifierExtension​(@NonNull
                                                           @NonNull com.babylonhealth.lit.core.model.Extension... modifierExtension)
        Parameters:
        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).

      • withModifierExtension

        public ElementDefinitionBuilder.Impl withModifierExtension​(@NonNull
                                                           @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> modifierExtension)
        Parameters:
        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).

      • withModifierExtension

        public ElementDefinitionBuilder.Impl withModifierExtension​(@NonNull
                                                           @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... modifierExtension)

      • withExample

        public ElementDefinitionBuilder.Impl withExample​(@NonNull
                                                 @NonNull com.babylonhealth.lit.hl7.model.ElementDefinition.Example... example)
        Parameters:
        example - - A sample value for this element demonstrating the type of information that would typically be found in the element.

      • withExample

        public ElementDefinitionBuilder.Impl withExample​(@NonNull
                                                 @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.ElementDefinition.Example> example)
        Parameters:
        example - - A sample value for this element demonstrating the type of information that would typically be found in the element.

      • withMapping

        public ElementDefinitionBuilder.Impl withMapping​(@NonNull
                                                 @NonNull com.babylonhealth.lit.hl7.model.ElementDefinition.Mapping... mapping)
        Parameters:
        mapping - - Identifies a concept from an external specification that roughly corresponds to this element.

      • withMapping

        public ElementDefinitionBuilder.Impl withMapping​(@NonNull
                                                 @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.ElementDefinition.Mapping> mapping)
        Parameters:
        mapping - - Identifies a concept from an external specification that roughly corresponds to this element.

      • withType

        public ElementDefinitionBuilder.Impl withType​(@NonNull
                                              @NonNull com.babylonhealth.lit.hl7.model.ElementDefinition.Type... _type)
        Parameters:
        _type - - The data type or resource that the value of this element is permitted to be.

      • withType

        public ElementDefinitionBuilder.Impl withType​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.ElementDefinition.Type> _type)
        Parameters:
        _type - - The data type or resource that the value of this element is permitted to be.

      • withMeaningWhenMissing

        public ElementDefinitionBuilder.Impl withMeaningWhenMissing​(@NonNull
                                                            @NonNull java.lang.String meaningWhenMissing)
        Parameters:
        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').

      • withSliceIsConstraining

        public ElementDefinitionBuilder.Impl withSliceIsConstraining​(@NonNull
                                                             @NonNull java.lang.Boolean sliceIsConstraining)
        Parameters:
        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.

      • withBinding

        public ElementDefinitionBuilder.Impl withBinding​(@NonNull
                                                 com.babylonhealth.lit.hl7.model.ElementDefinition.Binding binding)
        Parameters:
        binding - - Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).

      • withConstraint

        public ElementDefinitionBuilder.Impl withConstraint​(@NonNull
                                                    @NonNull com.babylonhealth.lit.hl7.model.ElementDefinition.Constraint... constraint)
        Parameters:
        constraint - - Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.

      • withConstraint

        public ElementDefinitionBuilder.Impl withConstraint​(@NonNull
                                                    @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.ElementDefinition.Constraint> constraint)
        Parameters:
        constraint - - Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.

      • withSlicing

        public ElementDefinitionBuilder.Impl withSlicing​(@NonNull
                                                 com.babylonhealth.lit.hl7.model.ElementDefinition.Slicing slicing)
        Parameters:
        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).

      • build

        public com.babylonhealth.lit.hl7.model.ElementDefinition build()
        Specified by:
        build in interface com.babylonhealth.lit.core_java.builders.BackboneElementBuilder
        Specified by:
        build in interface com.babylonhealth.lit.core_java.builders.ElementBuilder
        Specified by:
        build in interface ElementDefinitionBuilder