Package org.hl7.fhir.r4.model

Class ElementDefinition

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.ICompositeType
    public class ElementDefinition
extends BackboneType
implements org.hl7.fhir.instance.model.api.ICompositeType
    Captures constraints on each element within the resource, profile, or extension.
    See Also:
    Serialized Form

    • Field Detail

      • path

        protected StringType 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.

      • sliceName

        protected StringType 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.

      • sliceIsConstraining

        protected BooleanType 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.

      • label

        protected StringType 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.

      • code

        protected List<Coding> code
        A code that has the same meaning as the element in a particular terminology.

      • slicing

        protected ElementDefinition.ElementDefinitionSlicingComponent 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).

      • short_

        protected StringType short_
        A concise description of what this element means (e.g. for use in autogenerated summaries).

      • definition

        protected MarkdownType 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).

      • comment

        protected MarkdownType 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).

      • requirements

        protected MarkdownType 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.

      • alias

        protected List<StringType> alias
        Identifies additional names by which this element might also be known.

      • min

        protected UnsignedIntType min
        The minimum number of times this element SHALL appear in the instance.

      • max

        protected StringType max
        The maximum number of times this element is permitted to appear in the instance.

      • base

        protected ElementDefinition.ElementDefinitionBaseComponent 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.

      • contentReference

        protected UriType 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.

      • defaultValue

        protected Type 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').

      • meaningWhenMissing

        protected MarkdownType 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').

      • orderMeaning

        protected StringType 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.

      • fixed

        protected Type 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.

      • pattern

        protected Type 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.

      • minValue

        protected Type 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.

      • maxValue

        protected Type 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.

      • maxLength

        protected IntegerType 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.

      • condition

        protected List<IdType> condition
        A reference to an invariant that may make additional statements about the cardinality or value in the instance.

      • mustSupport

        protected BooleanType 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.

      • isModifier

        protected BooleanType 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.

      • isModifierReason

        protected StringType isModifierReason
        Explains how that element affects the interpretation of the resource or element that contains it.

      • isSummary

        protected BooleanType isSummary
        Whether the element should be included if a client requests a search with the parameter _summary=true.

    • Method Detail

      • getPathElement

        public StringType getPathElement()
        Returns:
        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 is the underlying object with id, value and extensions. The accessor "getPath" gives direct access to the value

      • hasPath

        public boolean hasPath()

      • setPathElement

        public ElementDefinition setPathElement​(StringType value)
        Parameters:
        value - 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 is the underlying object with id, value and extensions. The accessor "getPath" gives direct access to the value

      • getPath

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

      • setPath

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

      • getSliceNameElement

        public StringType getSliceNameElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getSliceName" gives direct access to the value

      • setSliceNameElement

        public ElementDefinition setSliceNameElement​(StringType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getSliceName" gives direct access to the value

      • getSliceName

        public String getSliceName()
        Returns:
        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.

      • setSliceName

        public ElementDefinition setSliceName​(String value)
        Parameters:
        value - 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.

      • getSliceIsConstrainingElement

        public BooleanType getSliceIsConstrainingElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getSliceIsConstraining" gives direct access to the value

      • setSliceIsConstrainingElement

        public ElementDefinition setSliceIsConstrainingElement​(BooleanType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getSliceIsConstraining" gives direct access to the value

      • getSliceIsConstraining

        public boolean getSliceIsConstraining()
        Returns:
        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.

      • setSliceIsConstraining

        public ElementDefinition setSliceIsConstraining​(boolean value)
        Parameters:
        value - 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.

      • getLabelElement

        public StringType getLabelElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value

      • setLabelElement

        public ElementDefinition setLabelElement​(StringType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value

      • getLabel

        public String getLabel()
        Returns:
        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.

      • setLabel

        public ElementDefinition setLabel​(String value)
        Parameters:
        value - 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.

      • getCode

        public List<Coding> getCode()
        Returns:
        code (A code that has the same meaning as the element in a particular terminology.)

      • hasCode

        public boolean hasCode()

      • getCodeFirstRep

        public Coding getCodeFirstRep()
        Returns:
        The first repetition of repeating field code, creating it if it does not already exist

      • getSlicing

        public ElementDefinition.ElementDefinitionSlicingComponent getSlicing()
        Returns:
        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).)

      • setSlicing

        public ElementDefinition setSlicing​(ElementDefinition.ElementDefinitionSlicingComponent value)
        Parameters:
        value - 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).)

      • getShortElement

        public StringType getShortElement()
        Returns:
        short_ (A concise description of what this element means (e.g. for use in autogenerated summaries).). This is the underlying object with id, value and extensions. The accessor "getShort" gives direct access to the value

      • setShortElement

        public ElementDefinition setShortElement​(StringType value)
        Parameters:
        value - short_ (A concise description of what this element means (e.g. for use in autogenerated summaries).). This is the underlying object with id, value and extensions. The accessor "getShort" gives direct access to the value

      • getShort

        public String getShort()
        Returns:
        A concise description of what this element means (e.g. for use in autogenerated summaries).

      • setShort

        public ElementDefinition setShort​(String value)
        Parameters:
        value - A concise description of what this element means (e.g. for use in autogenerated summaries).

      • getDefinitionElement

        public MarkdownType getDefinitionElement()
        Returns:
        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).). This is the underlying object with id, value and extensions. The accessor "getDefinition" gives direct access to the value

      • setDefinitionElement

        public ElementDefinition setDefinitionElement​(MarkdownType value)
        Parameters:
        value - 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).). This is the underlying object with id, value and extensions. The accessor "getDefinition" gives direct access to the value

      • getDefinition

        public String getDefinition()
        Returns:
        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).

      • setDefinition

        public ElementDefinition setDefinition​(String value)
        Parameters:
        value - 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).

      • getCommentElement

        public MarkdownType getCommentElement()
        Returns:
        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).). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value

      • setCommentElement

        public ElementDefinition setCommentElement​(MarkdownType value)
        Parameters:
        value - 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).). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value

      • getComment

        public String getComment()
        Returns:
        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).

      • setComment

        public ElementDefinition setComment​(String value)
        Parameters:
        value - 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).

      • getRequirementsElement

        public MarkdownType getRequirementsElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value

      • setRequirementsElement

        public ElementDefinition setRequirementsElement​(MarkdownType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value

      • getRequirements

        public String getRequirements()
        Returns:
        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.

      • setRequirements

        public ElementDefinition setRequirements​(String value)
        Parameters:
        value - 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.

      • getAlias

        public List<StringType> getAlias()
        Returns:
        alias (Identifies additional names by which this element might also be known.)

      • hasAlias

        public boolean hasAlias​(String value)
        Parameters:
        value - alias (Identifies additional names by which this element might also be known.)

      • getMinElement

        public UnsignedIntType getMinElement()
        Returns:
        min (The minimum number of times this element SHALL appear in the instance.). This is the underlying object with id, value and extensions. The accessor "getMin" gives direct access to the value

      • hasMin

        public boolean hasMin()

      • setMinElement

        public ElementDefinition setMinElement​(UnsignedIntType value)
        Parameters:
        value - min (The minimum number of times this element SHALL appear in the instance.). This is the underlying object with id, value and extensions. The accessor "getMin" gives direct access to the value

      • getMin

        public int getMin()
        Returns:
        The minimum number of times this element SHALL appear in the instance.

      • setMin

        public ElementDefinition setMin​(int value)
        Parameters:
        value - The minimum number of times this element SHALL appear in the instance.

      • getMaxElement

        public StringType getMaxElement()
        Returns:
        max (The maximum number of times this element is permitted to appear in the instance.). This is the underlying object with id, value and extensions. The accessor "getMax" gives direct access to the value

      • hasMax

        public boolean hasMax()

      • setMaxElement

        public ElementDefinition setMaxElement​(StringType value)
        Parameters:
        value - max (The maximum number of times this element is permitted to appear in the instance.). This is the underlying object with id, value and extensions. The accessor "getMax" gives direct access to the value

      • getMax

        public String getMax()
        Returns:
        The maximum number of times this element is permitted to appear in the instance.

      • setMax

        public ElementDefinition setMax​(String value)
        Parameters:
        value - The maximum number of times this element is permitted to appear in the instance.

      • getBase

        public ElementDefinition.ElementDefinitionBaseComponent getBase()
        Returns:
        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.)

      • hasBase

        public boolean hasBase()

      • setBase

        public ElementDefinition setBase​(ElementDefinition.ElementDefinitionBaseComponent value)
        Parameters:
        value - 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.)

      • getContentReferenceElement

        public UriType getContentReferenceElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getContentReference" gives direct access to the value

      • setContentReferenceElement

        public ElementDefinition setContentReferenceElement​(UriType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getContentReference" gives direct access to the value

      • getContentReference

        public String getContentReference()
        Returns:
        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.

      • setContentReference

        public ElementDefinition setContentReference​(String value)
        Parameters:
        value - 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.

      • hasType

        public boolean hasType()

      • getDefaultValue

        public Type getDefaultValue()
        Returns:
        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').)

      • setDefaultValue

        public ElementDefinition setDefaultValue​(Type value)
        Parameters:
        value - 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').)

      • getMeaningWhenMissingElement

        public MarkdownType getMeaningWhenMissingElement()
        Returns:
        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').). This is the underlying object with id, value and extensions. The accessor "getMeaningWhenMissing" gives direct access to the value

      • setMeaningWhenMissingElement

        public ElementDefinition setMeaningWhenMissingElement​(MarkdownType value)
        Parameters:
        value - 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').). This is the underlying object with id, value and extensions. The accessor "getMeaningWhenMissing" gives direct access to the value

      • getMeaningWhenMissing

        public String getMeaningWhenMissing()
        Returns:
        The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing').

      • setMeaningWhenMissing

        public ElementDefinition setMeaningWhenMissing​(String value)
        Parameters:
        value - The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing').

      • getOrderMeaningElement

        public StringType getOrderMeaningElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getOrderMeaning" gives direct access to the value

      • setOrderMeaningElement

        public ElementDefinition setOrderMeaningElement​(StringType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getOrderMeaning" gives direct access to the value

      • getOrderMeaning

        public String getOrderMeaning()
        Returns:
        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.

      • setOrderMeaning

        public ElementDefinition setOrderMeaning​(String value)
        Parameters:
        value - 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.

      • getFixed

        public Type getFixed()
        Returns:
        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.)

      • setFixed

        public ElementDefinition setFixed​(Type value)
        Parameters:
        value - 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.)

      • getPattern

        public Type getPattern()
        Returns:
        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.)

      • setPattern

        public ElementDefinition setPattern​(Type value)
        Parameters:
        value - 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.)

      • getMinValue

        public Type getMinValue()
        Returns:
        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.)

      • getMinValueDateType

        public DateType getMinValueDateType()
                             throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMinValueDateTimeType

        public DateTimeType getMinValueDateTimeType()
                                     throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMinValueInstantType

        public InstantType getMinValueInstantType()
                                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMinValueTimeType

        public TimeType getMinValueTimeType()
                             throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMinValueDecimalType

        public DecimalType getMinValueDecimalType()
                                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMinValueIntegerType

        public IntegerType getMinValueIntegerType()
                                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMinValuePositiveIntType

        public PositiveIntType getMinValuePositiveIntType()
                                           throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMinValueUnsignedIntType

        public UnsignedIntType getMinValueUnsignedIntType()
                                           throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMinValueQuantity

        public Quantity getMinValueQuantity()
                             throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • setMinValue

        public ElementDefinition setMinValue​(Type value)
        Parameters:
        value - 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.)

      • getMaxValue

        public Type getMaxValue()
        Returns:
        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.)

      • getMaxValueDateType

        public DateType getMaxValueDateType()
                             throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMaxValueDateTimeType

        public DateTimeType getMaxValueDateTimeType()
                                     throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMaxValueInstantType

        public InstantType getMaxValueInstantType()
                                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMaxValueTimeType

        public TimeType getMaxValueTimeType()
                             throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMaxValueDecimalType

        public DecimalType getMaxValueDecimalType()
                                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMaxValueIntegerType

        public IntegerType getMaxValueIntegerType()
                                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMaxValuePositiveIntType

        public PositiveIntType getMaxValuePositiveIntType()
                                           throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMaxValueUnsignedIntType

        public UnsignedIntType getMaxValueUnsignedIntType()
                                           throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getMaxValueQuantity

        public Quantity getMaxValueQuantity()
                             throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        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.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • setMaxValue

        public ElementDefinition setMaxValue​(Type value)
        Parameters:
        value - 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.)

      • getMaxLengthElement

        public IntegerType getMaxLengthElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getMaxLength" gives direct access to the value

      • setMaxLengthElement

        public ElementDefinition setMaxLengthElement​(IntegerType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getMaxLength" gives direct access to the value

      • getMaxLength

        public int getMaxLength()
        Returns:
        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.

      • setMaxLength

        public ElementDefinition setMaxLength​(int value)
        Parameters:
        value - 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.

      • getCondition

        public List<IdType> getCondition()
        Returns:
        condition (A reference to an invariant that may make additional statements about the cardinality or value in the instance.)

      • addConditionElement

        public IdType addConditionElement()
        Returns:
        condition (A reference to an invariant that may make additional statements about the cardinality or value in the instance.)

      • hasCondition

        public boolean hasCondition​(String value)
        Parameters:
        value - condition (A reference to an invariant that may make additional statements about the cardinality or value in the instance.)

      • getMustSupportElement

        public BooleanType getMustSupportElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getMustSupport" gives direct access to the value

      • setMustSupportElement

        public ElementDefinition setMustSupportElement​(BooleanType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getMustSupport" gives direct access to the value

      • getMustSupport

        public boolean getMustSupport()
        Returns:
        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.

      • setMustSupport

        public ElementDefinition setMustSupport​(boolean value)
        Parameters:
        value - 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.

      • getIsModifierElement

        public BooleanType getIsModifierElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getIsModifier" gives direct access to the value

      • setIsModifierElement

        public ElementDefinition setIsModifierElement​(BooleanType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getIsModifier" gives direct access to the value

      • getIsModifier

        public boolean getIsModifier()
        Returns:
        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.

      • setIsModifier

        public ElementDefinition setIsModifier​(boolean value)
        Parameters:
        value - 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.

      • getIsModifierReasonElement

        public StringType getIsModifierReasonElement()
        Returns:
        isModifierReason (Explains how that element affects the interpretation of the resource or element that contains it.). This is the underlying object with id, value and extensions. The accessor "getIsModifierReason" gives direct access to the value

      • setIsModifierReasonElement

        public ElementDefinition setIsModifierReasonElement​(StringType value)
        Parameters:
        value - isModifierReason (Explains how that element affects the interpretation of the resource or element that contains it.). This is the underlying object with id, value and extensions. The accessor "getIsModifierReason" gives direct access to the value

      • getIsModifierReason

        public String getIsModifierReason()
        Returns:
        Explains how that element affects the interpretation of the resource or element that contains it.

      • getIsSummaryElement

        public BooleanType getIsSummaryElement()
        Returns:
        isSummary (Whether the element should be included if a client requests a search with the parameter _summary=true.). This is the underlying object with id, value and extensions. The accessor "getIsSummary" gives direct access to the value

      • setIsSummaryElement

        public ElementDefinition setIsSummaryElement​(BooleanType value)
        Parameters:
        value - isSummary (Whether the element should be included if a client requests a search with the parameter _summary=true.). This is the underlying object with id, value and extensions. The accessor "getIsSummary" gives direct access to the value

      • getIsSummary

        public boolean getIsSummary()
        Returns:
        Whether the element should be included if a client requests a search with the parameter _summary=true.

      • setIsSummary

        public ElementDefinition setIsSummary​(boolean value)
        Parameters:
        value - Whether the element should be included if a client requests a search with the parameter _summary=true.

      • getProperty

        public Base[] getProperty​(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class BackboneType
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class BackboneType