Package org.hl7.fhir.dstu2.model
Class ElementDefinition
java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.Element
org.hl7.fhir.dstu2.model.Type
org.hl7.fhir.dstu2.model.ElementDefinition
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,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.ICompositeType
public class ElementDefinition
extends Type
implements org.hl7.fhir.instance.model.api.ICompositeType
Captures constraints on each element within the resource, profile, or
extension.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static class
static enum
static class
static class
static class
static class
static class
static class
static enum
static class
static enum
static class
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<StringType> Identifies additional names by which this element might also be known.Information about the base definition of the element, provided to make it unncessary for tools to trace the deviation of the element through the derived and related profiles.Binds to a value set if this element is coded (code, Coding, CodeableConcept).A code that provides the meaning for the element according to a particular terminology.protected MarkdownType
Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc.A reference to an invariant that may make additional statements about the cardinality or value in the instance.Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.protected Type
The value that should be used if there is no value stated in the instance (e.g.protected MarkdownType
Provides a complete explanation of the meaning of the data element for human readability.protected Type
A sample value for this element demonstrating the type of information that would typically be captured.protected Type
Specifies a value that SHALL be exactly the value for this element in the instance.protected BooleanType
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.protected BooleanType
Whether the element should be included if a client requests a search with the parameter _summary=true.protected StringType
The text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.Identifies a concept from an external specification that roughly corresponds to this element.protected StringType
The maximum number of times this element is permitted to appear in the instance.protected IntegerType
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.protected Type
The maximum allowed value for the element.protected MarkdownType
The Implicit meaning that is to be understood when this element is missing (e.g.protected IntegerType
The minimum number of times this element SHALL appear in the instance.protected Type
The minimum allowed value for the element.protected BooleanType
If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way.protected StringType
The name of this element definition (to refer to it from other element definitions using ElementDefinition.nameReference).protected StringType
Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element.protected StringType
The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension.protected Type
Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance.protected List
<Enumeration<ElementDefinition.PropertyRepresentation>> Codes that define how this element is represented in instances, when the deviation varies from the normal case.protected MarkdownType
This element is for traceability of why the element was created and why the constraints exist as they do.protected StringType
A concise description of what this element means (e.g.Indicates that the element is sliced into a set of alternative definitions (i.e.protected List
<ElementDefinition.TypeRefComponent> The data type or resource that the value of this element is permitted to be. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddCode()
addCondition
(String value) addType()
copy()
boolean
equalsDeep
(Base other) boolean
equalsShallow
(Base other) fhirType()
getAlias()
getBase()
getCode()
getFixed()
boolean
boolean
getLabel()
getMax()
int
int
getMin()
boolean
getName()
getPath()
getShort()
getType()
boolean
hasAlias()
boolean
boolean
hasBase()
boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
hasCondition
(String value) boolean
boolean
boolean
boolean
boolean
boolean
hasFixed()
boolean
boolean
boolean
boolean
boolean
hasLabel()
boolean
boolean
boolean
hasMax()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasMin()
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
boolean
hasPath()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasShort()
boolean
boolean
boolean
hasType()
boolean
isEmpty()
protected void
listChildren
(List<Property> childrenList) setComments
(String value) setCommentsElement
(MarkdownType value) setDefaultValue
(Type value) setDefinition
(String value) setDefinitionElement
(MarkdownType value) setExample
(Type value) setIsModifier
(boolean value) setIsModifierElement
(BooleanType value) setIsSummary
(boolean value) setIsSummaryElement
(BooleanType value) setLabelElement
(StringType value) setMaxElement
(StringType value) setMaxLength
(int value) setMaxLengthElement
(IntegerType value) setMaxValue
(Type value) setMeaningWhenMissing
(String value) setMin
(int value) setMinElement
(IntegerType value) setMinValue
(Type value) setMustSupport
(boolean value) setMustSupportElement
(BooleanType value) setNameElement
(StringType value) setNameReference
(String value) setPathElement
(StringType value) setPattern
(Type value) void
setProperty
(String name, Base value) setRepresentation
(List<Enumeration<ElementDefinition.PropertyRepresentation>> representation) setRequirements
(String value) setShortElement
(StringType value) protected ElementDefinition
Methods inherited from class org.hl7.fhir.dstu2.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
-
Field Details
-
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. -
representation
Codes that define how this element is represented in instances, when the deviation varies from the normal case. -
name
The name of this element definition (to refer to it from other element definitions using ElementDefinition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element. -
label
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
A code that provides the meaning for the element according to a particular terminology. -
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_
A concise description of what this element means (e.g. for use in autogenerated summaries). -
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. -
comments
Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc. -
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
Identifies additional names by which this element might also be known. -
min
The minimum number of times this element SHALL appear in the instance. -
max
The maximum number of times this element is permitted to appear in the instance. -
base
Information about the base definition of the element, provided to make it unncessary for tools to trace the deviation of the element through the derived and related profiles. This information is only provided where the element definition represents a constraint on another element definition, and must be present if there is a base element definition. -
type
The data type or resource that the value of this element is permitted to be. -
nameReference
Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element. -
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
The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing'. -
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
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. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.). -
example
A sample value for this element demonstrating the type of information that would typically be captured. -
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
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
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
A reference to an invariant that may make additional statements about the cardinality or value in the instance. -
constraint
Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance. -
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. -
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. -
isSummary
Whether the element should be included if a client requests a search with the parameter _summary=true. -
binding
Binds to a value set if this element is coded (code, Coding, CodeableConcept). -
mapping
Identifies a concept from an external specification that roughly corresponds to this element.
-
-
Constructor Details
-
ElementDefinition
public ElementDefinition() -
ElementDefinition
-
-
Method Details
-
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
-
hasPathElement
-
hasPath
-
setPathElement
- 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
- 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
- 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.
-
getRepresentation
- Returns:
representation
(Codes that define how this element is represented in instances, when the deviation varies from the normal case.)
-
setRepresentation
public ElementDefinition setRepresentation(List<Enumeration<ElementDefinition.PropertyRepresentation>> representation) -
hasRepresentation
-
addRepresentationElement
- Returns:
representation
(Codes that define how this element is represented in instances, when the deviation varies from the normal case.)
-
addRepresentation
- Parameters:
value
-representation
(Codes that define how this element is represented in instances, when the deviation varies from the normal case.)
-
hasRepresentation
- Parameters:
value
-representation
(Codes that define how this element is represented in instances, when the deviation varies from the normal case.)
-
getNameElement
- Returns:
name
(The name of this element definition (to refer to it from other element definitions using ElementDefinition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
-
hasName
-
setNameElement
- Parameters:
value
-name
(The name of this element definition (to refer to it from other element definitions using ElementDefinition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
- Returns:
- The name of this element definition (to refer to it from other element definitions using ElementDefinition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element.
-
setName
- Parameters:
value
- The name of this element definition (to refer to it from other element definitions using ElementDefinition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element.
-
getLabelElement
- Returns:
label
(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
-
hasLabelElement
-
hasLabel
-
setLabelElement
- Parameters:
value
-label
(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
- Returns:
- 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
- Parameters:
value
- 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
- Returns:
code
(A code that provides the meaning for the element according to a particular terminology.)
-
hasCode
-
addCode
- Returns:
code
(A code that provides the meaning for the element according to a particular terminology.)
-
addCode
-
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).)
-
hasSlicing
-
setSlicing
- 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
- 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
-
hasShortElement
-
hasShort
-
setShortElement
- 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
- Returns:
- A concise description of what this element means (e.g. for use in autogenerated summaries).
-
setShort
- Parameters:
value
- A concise description of what this element means (e.g. for use in autogenerated summaries).
-
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.). This is the underlying object with id, value and extensions. The accessor "getDefinition" gives direct access to the value
-
hasDefinitionElement
-
hasDefinition
-
setDefinitionElement
- 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.). This is the underlying object with id, value and extensions. The accessor "getDefinition" gives direct access to the value
-
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.
-
setDefinition
- 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.
-
getCommentsElement
- Returns:
comments
(Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc.). This is the underlying object with id, value and extensions. The accessor "getComments" gives direct access to the value
-
hasCommentsElement
-
hasComments
-
setCommentsElement
- Parameters:
value
-comments
(Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc.). This is the underlying object with id, value and extensions. The accessor "getComments" gives direct access to the value
-
getComments
- Returns:
- Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc.
-
setComments
- 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.
-
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
-
hasRequirementsElement
-
hasRequirements
-
setRequirementsElement
- 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
- 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
- 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
- Returns:
alias
(Identifies additional names by which this element might also be known.)
-
hasAlias
-
addAliasElement
- Returns:
alias
(Identifies additional names by which this element might also be known.)
-
addAlias
- Parameters:
value
-alias
(Identifies additional names by which this element might also be known.)
-
hasAlias
- Parameters:
value
-alias
(Identifies additional names by which this element might also be known.)
-
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
-
hasMinElement
-
hasMin
-
setMinElement
- 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
- Returns:
- The minimum number of times this element SHALL appear in the instance.
-
setMin
- Parameters:
value
- The minimum number of times this element SHALL appear in the instance.
-
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
-
hasMaxElement
-
hasMax
-
setMaxElement
- 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
- Returns:
- The maximum number of times this element is permitted to appear in the instance.
-
setMax
- Parameters:
value
- The maximum number of times this element is permitted to appear in the instance.
-
getBase
- Returns:
base
(Information about the base definition of the element, provided to make it unncessary for tools to trace the deviation of the element through the derived and related profiles. This information is only provided where the element definition represents a constraint on another element definition, and must be present if there is a base element definition.)
-
hasBase
-
setBase
- Parameters:
value
-base
(Information about the base definition of the element, provided to make it unncessary for tools to trace the deviation of the element through the derived and related profiles. This information is only provided where the element definition represents a constraint on another element definition, and must be present if there is a base element definition.)
-
getType
- Returns:
type
(The data type or resource that the value of this element is permitted to be.)
-
hasType
-
addType
- Returns:
type
(The data type or resource that the value of this element is permitted to be.)
-
addType
-
getNameReferenceElement
- Returns:
nameReference
(Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element.). This is the underlying object with id, value and extensions. The accessor "getNameReference" gives direct access to the value
-
hasNameReferenceElement
-
hasNameReference
-
setNameReferenceElement
- Parameters:
value
-nameReference
(Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element.). This is the underlying object with id, value and extensions. The accessor "getNameReference" gives direct access to the value
-
getNameReference
- Returns:
- Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element.
-
setNameReference
- Parameters:
value
- Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element.
-
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').)
-
hasDefaultValue
-
setDefaultValue
- 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
- 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
-
hasMeaningWhenMissingElement
-
hasMeaningWhenMissing
-
setMeaningWhenMissingElement
- 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
- 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
- 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'.
-
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.)
-
hasFixed
-
setFixed
- 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
- 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. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).)
-
hasPattern
-
setPattern
- 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. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).)
-
getExample
- Returns:
example
(A sample value for this element demonstrating the type of information that would typically be captured.)
-
hasExample
-
setExample
- Parameters:
value
-example
(A sample value for this element demonstrating the type of information that would typically be captured.)
-
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.)
-
hasMinValue
-
setMinValue
- 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
- 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.)
-
hasMaxValue
-
setMaxValue
- 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
- 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
-
hasMaxLengthElement
-
hasMaxLength
-
setMaxLengthElement
- 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
- 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
- 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
- Returns:
condition
(A reference to an invariant that may make additional statements about the cardinality or value in the instance.)
-
hasCondition
-
addConditionElement
- Returns:
condition
(A reference to an invariant that may make additional statements about the cardinality or value in the instance.)
-
addCondition
- Parameters:
value
-condition
(A reference to an invariant that may make additional statements about the cardinality or value in the instance.)
-
hasCondition
- Parameters:
value
-condition
(A reference to an invariant that may make additional statements about the cardinality or value in the instance.)
-
getConstraint
- Returns:
constraint
(Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.)
-
hasConstraint
-
addConstraint
- Returns:
constraint
(Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.)
-
addConstraint
-
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.). This is the underlying object with id, value and extensions. The accessor "getMustSupport" gives direct access to the value
-
hasMustSupportElement
-
hasMustSupport
-
setMustSupportElement
- 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.). This is the underlying object with id, value and extensions. The accessor "getMustSupport" gives direct access to the value
-
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.
-
setMustSupport
- 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.
-
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
-
hasIsModifierElement
-
hasIsModifier
-
setIsModifierElement
- 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
- 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
- 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.
-
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
-
hasIsSummaryElement
-
hasIsSummary
-
setIsSummaryElement
- 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
- Returns:
- Whether the element should be included if a client requests a search with the parameter _summary=true.
-
setIsSummary
- Parameters:
value
- Whether the element should be included if a client requests a search with the parameter _summary=true.
-
getBinding
- Returns:
binding
(Binds to a value set if this element is coded (code, Coding, CodeableConcept).)
-
hasBinding
-
setBinding
- Parameters:
value
-binding
(Binds to a value set if this element is coded (code, Coding, CodeableConcept).)
-
getMapping
- Returns:
mapping
(Identifies a concept from an external specification that roughly corresponds to this element.)
-
hasMapping
-
addMapping
- Returns:
mapping
(Identifies a concept from an external specification that roughly corresponds to this element.)
-
addMapping
-
listChildren
- Overrides:
listChildren
in classElement
-
setProperty
- Overrides:
setProperty
in classElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
-
fhirType
-
copy
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classElement
-
equalsShallow
- Overrides:
equalsShallow
in classElement
-
isEmpty
-