public class ElementDefinition extends BackboneType implements org.hl7.fhir.instance.model.api.ICompositeType
| Modifier and Type | Field and Description |
|---|---|
protected List<StringType> |
alias
Identifies additional names by which this element might also be known.
|
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.
|
protected ElementDefinition.ElementDefinitionBindingComponent |
binding
Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).
|
protected List<Coding> |
code
A code that has the same meaning as the element in a particular terminology.
|
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.
|
protected List<IdType> |
condition
A reference to an invariant that may make additional statements about the cardinality or value in the instance.
|
protected List<ElementDefinition.ElementDefinitionConstraintComponent> |
constraint
Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.
|
protected UriType |
contentReference
Identifies an element defined elsewhere in the definition whose content rules should be applied to the current element.
|
protected Type |
defaultValue
The value that should be used if there is no value stated in the instance (e.g.
|
protected MarkdownType |
definition
Provides a complete explanation of the meaning of the data element for human readability.
|
protected List<ElementDefinition.ElementDefinitionExampleComponent> |
example
A sample value for this element demonstrating the type of information that would typically be found in the element.
|
protected Type |
fixed
Specifies a value that SHALL be exactly the value for this element in the instance.
|
static boolean |
IS_IN_SUMMARY |
static boolean |
IS_MODIFIER |
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.
|
protected StringType |
isModifierReason
Explains how that element affects the interpretation of the resource or element that contains it.
|
protected BooleanType |
isSummary
Whether the element should be included if a client requests a search with the parameter _summary=true.
|
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.
|
protected List<ElementDefinition.ElementDefinitionMappingComponent> |
mapping
Identifies a concept from an external specification that roughly corresponds to this element.
|
protected StringType |
max
The maximum number of times this element is permitted to appear in the instance.
|
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.
|
protected Type |
maxValue
The maximum allowed value for the element.
|
protected MarkdownType |
meaningWhenMissing
The Implicit meaning that is to be understood when this element is missing (e.g.
|
protected UnsignedIntType |
min
The minimum number of times this element SHALL appear in the instance.
|
protected Type |
minValue
The minimum allowed value for the element.
|
protected BooleanType |
mustSupport
If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way.
|
static boolean |
NOT_IN_SUMMARY |
static boolean |
NOT_MODIFIER |
protected StringType |
orderMeaning
If present, indicates that the order of the repeating element has meaning and describes what that meaning is.
|
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.
|
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.
|
protected List<Enumeration<ElementDefinition.PropertyRepresentation>> |
representation
Codes that define how this element is represented in instances, when the deviation varies from the normal case.
|
protected MarkdownType |
requirements
This element is for traceability of why the element was created and why the constraints exist as they do.
|
protected StringType |
short_
A concise description of what this element means (e.g.
|
protected BooleanType |
sliceIsConstraining
If true, indicates that this slice definition is constraining a slice definition with the same name in an inherited profile.
|
protected StringType |
sliceName
The name of this element definition slice, when slicing is working.
|
protected ElementDefinition.ElementDefinitionSlicingComponent |
slicing
Indicates that the element is sliced into a set of alternative definitions (i.e.
|
protected List<ElementDefinition.TypeRefComponent> |
type
The data type or resource that the value of this element is permitted to be.
|
modifierExtension| Constructor and Description |
|---|
ElementDefinition()
Constructor
|
ElementDefinition(boolean defaults,
boolean modifier,
boolean inSummary) |
ElementDefinition(StringType path)
Constructor
|
addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtensionaddExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElementcastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserDataprotected StringType path
protected List<Enumeration<ElementDefinition.PropertyRepresentation>> representation
protected StringType sliceName
protected BooleanType sliceIsConstraining
protected StringType label
protected List<Coding> code
protected ElementDefinition.ElementDefinitionSlicingComponent slicing
protected StringType short_
protected MarkdownType definition
protected MarkdownType comment
protected MarkdownType requirements
protected List<StringType> alias
protected UnsignedIntType min
protected StringType max
protected ElementDefinition.ElementDefinitionBaseComponent base
protected UriType contentReference
protected List<ElementDefinition.TypeRefComponent> type
protected Type defaultValue
protected MarkdownType meaningWhenMissing
protected StringType orderMeaning
protected Type fixed
protected Type pattern
protected List<ElementDefinition.ElementDefinitionExampleComponent> example
protected Type minValue
protected Type maxValue
protected IntegerType maxLength
protected List<IdType> condition
protected List<ElementDefinition.ElementDefinitionConstraintComponent> constraint
protected BooleanType mustSupport
protected BooleanType isModifier
protected StringType isModifierReason
protected BooleanType isSummary
protected ElementDefinition.ElementDefinitionBindingComponent binding
protected List<ElementDefinition.ElementDefinitionMappingComponent> mapping
public static final boolean NOT_MODIFIER
public static final boolean NOT_IN_SUMMARY
public static final boolean IS_MODIFIER
public static final boolean IS_IN_SUMMARY
public ElementDefinition()
public ElementDefinition(StringType path)
public ElementDefinition(boolean defaults, boolean modifier, boolean inSummary)
public StringType getPathElement()
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 valuepublic boolean hasPathElement()
public boolean hasPath()
public ElementDefinition setPathElement(StringType value)
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 valuepublic String getPath()
public ElementDefinition setPath(String value)
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.public List<Enumeration<ElementDefinition.PropertyRepresentation>> getRepresentation()
representation (Codes that define how this element is represented in instances, when the deviation varies from the normal case.)public ElementDefinition setRepresentation(List<Enumeration<ElementDefinition.PropertyRepresentation>> theRepresentation)
this for easy method chainingpublic boolean hasRepresentation()
public Enumeration<ElementDefinition.PropertyRepresentation> addRepresentationElement()
representation (Codes that define how this element is represented in instances, when the deviation varies from the normal case.)public ElementDefinition addRepresentation(ElementDefinition.PropertyRepresentation value)
value - representation (Codes that define how this element is represented in instances, when the deviation varies from the normal case.)public boolean hasRepresentation(ElementDefinition.PropertyRepresentation value)
value - representation (Codes that define how this element is represented in instances, when the deviation varies from the normal case.)public StringType getSliceNameElement()
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 valuepublic boolean hasSliceNameElement()
public boolean hasSliceName()
public ElementDefinition setSliceNameElement(StringType value)
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 valuepublic String getSliceName()
public ElementDefinition setSliceName(String value)
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.public BooleanType getSliceIsConstrainingElement()
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 valuepublic boolean hasSliceIsConstrainingElement()
public boolean hasSliceIsConstraining()
public ElementDefinition setSliceIsConstrainingElement(BooleanType value)
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 valuepublic boolean getSliceIsConstraining()
public ElementDefinition setSliceIsConstraining(boolean value)
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.public StringType getLabelElement()
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 valuepublic boolean hasLabelElement()
public boolean hasLabel()
public ElementDefinition setLabelElement(StringType value)
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 valuepublic String getLabel()
public ElementDefinition setLabel(String value)
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.public List<Coding> getCode()
code (A code that has the same meaning as the element in a particular terminology.)public ElementDefinition setCode(List<Coding> theCode)
this for easy method chainingpublic boolean hasCode()
public ElementDefinition addCode(Coding t)
public Coding getCodeFirstRep()
code, creating it if it does not already existpublic ElementDefinition.ElementDefinitionSlicingComponent getSlicing()
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).)public boolean hasSlicing()
public ElementDefinition setSlicing(ElementDefinition.ElementDefinitionSlicingComponent value)
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).)public StringType getShortElement()
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 valuepublic boolean hasShortElement()
public boolean hasShort()
public ElementDefinition setShortElement(StringType value)
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 valuepublic String getShort()
public ElementDefinition setShort(String value)
value - A concise description of what this element means (e.g. for use in autogenerated summaries).public MarkdownType getDefinitionElement()
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 valuepublic boolean hasDefinitionElement()
public boolean hasDefinition()
public ElementDefinition setDefinitionElement(MarkdownType value)
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 valuepublic String getDefinition()
public ElementDefinition setDefinition(String value)
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).public MarkdownType getCommentElement()
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 valuepublic boolean hasCommentElement()
public boolean hasComment()
public ElementDefinition setCommentElement(MarkdownType value)
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 valuepublic String getComment()
public ElementDefinition setComment(String value)
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).public MarkdownType getRequirementsElement()
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 valuepublic boolean hasRequirementsElement()
public boolean hasRequirements()
public ElementDefinition setRequirementsElement(MarkdownType value)
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 valuepublic String getRequirements()
public ElementDefinition setRequirements(String value)
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.public List<StringType> getAlias()
alias (Identifies additional names by which this element might also be known.)public ElementDefinition setAlias(List<StringType> theAlias)
this for easy method chainingpublic boolean hasAlias()
public StringType addAliasElement()
alias (Identifies additional names by which this element might also be known.)public ElementDefinition addAlias(String value)
value - alias (Identifies additional names by which this element might also be known.)public boolean hasAlias(String value)
value - alias (Identifies additional names by which this element might also be known.)public UnsignedIntType getMinElement()
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 valuepublic boolean hasMinElement()
public boolean hasMin()
public ElementDefinition setMinElement(UnsignedIntType value)
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 valuepublic int getMin()
public ElementDefinition setMin(int value)
value - The minimum number of times this element SHALL appear in the instance.public StringType getMaxElement()
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 valuepublic boolean hasMaxElement()
public boolean hasMax()
public ElementDefinition setMaxElement(StringType value)
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 valuepublic String getMax()
public ElementDefinition setMax(String value)
value - The maximum number of times this element is permitted to appear in the instance.public ElementDefinition.ElementDefinitionBaseComponent getBase()
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.)public boolean hasBase()
public ElementDefinition setBase(ElementDefinition.ElementDefinitionBaseComponent value)
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.)public UriType getContentReferenceElement()
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 valuepublic boolean hasContentReferenceElement()
public boolean hasContentReference()
public ElementDefinition setContentReferenceElement(UriType value)
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 valuepublic String getContentReference()
public ElementDefinition setContentReference(String value)
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.public List<ElementDefinition.TypeRefComponent> getType()
type (The data type or resource that the value of this element is permitted to be.)public ElementDefinition setType(List<ElementDefinition.TypeRefComponent> theType)
this for easy method chainingpublic boolean hasType()
public ElementDefinition.TypeRefComponent addType()
public ElementDefinition addType(ElementDefinition.TypeRefComponent t)
public ElementDefinition.TypeRefComponent getTypeFirstRep()
type, creating it if it does not already existpublic Type getDefaultValue()
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').)public boolean hasDefaultValue()
public ElementDefinition setDefaultValue(Type value)
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').)public MarkdownType getMeaningWhenMissingElement()
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 valuepublic boolean hasMeaningWhenMissingElement()
public boolean hasMeaningWhenMissing()
public ElementDefinition setMeaningWhenMissingElement(MarkdownType value)
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 valuepublic String getMeaningWhenMissing()
public ElementDefinition setMeaningWhenMissing(String value)
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').public StringType getOrderMeaningElement()
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 valuepublic boolean hasOrderMeaningElement()
public boolean hasOrderMeaning()
public ElementDefinition setOrderMeaningElement(StringType value)
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 valuepublic String getOrderMeaning()
public ElementDefinition setOrderMeaning(String value)
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.public Type getFixed()
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.)public boolean hasFixed()
public ElementDefinition setFixed(Type value)
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.)public Type getPattern()
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.)public boolean hasPattern()
public ElementDefinition setPattern(Type value)
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.)public List<ElementDefinition.ElementDefinitionExampleComponent> getExample()
example (A sample value for this element demonstrating the type of information that would typically be found in the element.)public ElementDefinition setExample(List<ElementDefinition.ElementDefinitionExampleComponent> theExample)
this for easy method chainingpublic boolean hasExample()
public ElementDefinition.ElementDefinitionExampleComponent addExample()
public ElementDefinition addExample(ElementDefinition.ElementDefinitionExampleComponent t)
public ElementDefinition.ElementDefinitionExampleComponent getExampleFirstRep()
example, creating it if it does not already existpublic Type getMinValue()
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.)public DateType getMinValueDateType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMinValueDateType()
public DateTimeType getMinValueDateTimeType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMinValueDateTimeType()
public InstantType getMinValueInstantType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMinValueInstantType()
public TimeType getMinValueTimeType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMinValueTimeType()
public DecimalType getMinValueDecimalType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMinValueDecimalType()
public IntegerType getMinValueIntegerType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMinValueIntegerType()
public PositiveIntType getMinValuePositiveIntType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMinValuePositiveIntType()
public UnsignedIntType getMinValueUnsignedIntType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMinValueUnsignedIntType()
public Quantity getMinValueQuantity() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMinValueQuantity()
public boolean hasMinValue()
public ElementDefinition setMinValue(Type value)
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.)public Type getMaxValue()
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.)public DateType getMaxValueDateType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMaxValueDateType()
public DateTimeType getMaxValueDateTimeType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMaxValueDateTimeType()
public InstantType getMaxValueInstantType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMaxValueInstantType()
public TimeType getMaxValueTimeType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMaxValueTimeType()
public DecimalType getMaxValueDecimalType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMaxValueDecimalType()
public IntegerType getMaxValueIntegerType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMaxValueIntegerType()
public PositiveIntType getMaxValuePositiveIntType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMaxValuePositiveIntType()
public UnsignedIntType getMaxValueUnsignedIntType() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMaxValueUnsignedIntType()
public Quantity getMaxValueQuantity() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMaxValueQuantity()
public boolean hasMaxValue()
public ElementDefinition setMaxValue(Type value)
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.)public IntegerType getMaxLengthElement()
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 valuepublic boolean hasMaxLengthElement()
public boolean hasMaxLength()
public ElementDefinition setMaxLengthElement(IntegerType value)
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 valuepublic int getMaxLength()
public ElementDefinition setMaxLength(int value)
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.public List<IdType> getCondition()
condition (A reference to an invariant that may make additional statements about the cardinality or value in the instance.)public ElementDefinition setCondition(List<IdType> theCondition)
this for easy method chainingpublic boolean hasCondition()
public IdType addConditionElement()
condition (A reference to an invariant that may make additional statements about the cardinality or value in the instance.)public ElementDefinition addCondition(String value)
value - condition (A reference to an invariant that may make additional statements about the cardinality or value in the instance.)public boolean hasCondition(String value)
value - condition (A reference to an invariant that may make additional statements about the cardinality or value in the instance.)public List<ElementDefinition.ElementDefinitionConstraintComponent> getConstraint()
constraint (Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.)public ElementDefinition setConstraint(List<ElementDefinition.ElementDefinitionConstraintComponent> theConstraint)
this for easy method chainingpublic boolean hasConstraint()
public ElementDefinition.ElementDefinitionConstraintComponent addConstraint()
public ElementDefinition addConstraint(ElementDefinition.ElementDefinitionConstraintComponent t)
public ElementDefinition.ElementDefinitionConstraintComponent getConstraintFirstRep()
constraint, creating it if it does not already existpublic BooleanType getMustSupportElement()
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 valuepublic boolean hasMustSupportElement()
public boolean hasMustSupport()
public ElementDefinition setMustSupportElement(BooleanType value)
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 valuepublic boolean getMustSupport()
public ElementDefinition setMustSupport(boolean value)
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.public BooleanType getIsModifierElement()
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 valuepublic boolean hasIsModifierElement()
public boolean hasIsModifier()
public ElementDefinition setIsModifierElement(BooleanType value)
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 valuepublic boolean getIsModifier()
public ElementDefinition setIsModifier(boolean value)
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.public StringType getIsModifierReasonElement()
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 valuepublic boolean hasIsModifierReasonElement()
public boolean hasIsModifierReason()
public ElementDefinition setIsModifierReasonElement(StringType value)
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 valuepublic String getIsModifierReason()
public ElementDefinition setIsModifierReason(String value)
value - Explains how that element affects the interpretation of the resource or element that contains it.public BooleanType getIsSummaryElement()
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 valuepublic boolean hasIsSummaryElement()
public boolean hasIsSummary()
public ElementDefinition setIsSummaryElement(BooleanType value)
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 valuepublic boolean getIsSummary()
public ElementDefinition setIsSummary(boolean value)
value - Whether the element should be included if a client requests a search with the parameter _summary=true.public ElementDefinition.ElementDefinitionBindingComponent getBinding()
binding (Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).)public boolean hasBinding()
public ElementDefinition setBinding(ElementDefinition.ElementDefinitionBindingComponent value)
value - binding (Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).)public List<ElementDefinition.ElementDefinitionMappingComponent> getMapping()
mapping (Identifies a concept from an external specification that roughly corresponds to this element.)public ElementDefinition setMapping(List<ElementDefinition.ElementDefinitionMappingComponent> theMapping)
this for easy method chainingpublic boolean hasMapping()
public ElementDefinition.ElementDefinitionMappingComponent addMapping()
public ElementDefinition addMapping(ElementDefinition.ElementDefinitionMappingComponent t)
public ElementDefinition.ElementDefinitionMappingComponent getMappingFirstRep()
mapping, creating it if it does not already existprotected void listChildren(List<Property> children)
listChildren in class BackboneTypepublic Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
getNamedProperty in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
getTypesForProperty in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class BackboneTypeorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in interface org.hl7.fhir.instance.model.api.IBasefhirType in class BackboneTypepublic ElementDefinition copy()
copy in class BackboneTypepublic void copyValues(ElementDefinition dst)
protected ElementDefinition typedCopy()
public boolean equalsDeep(Base other_)
equalsDeep in class BackboneTypepublic boolean equalsShallow(Base other_)
equalsShallow in class BackboneTypepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class BackboneTypepublic void makeBase()
public String typeSummary()
public ElementDefinition.TypeRefComponent getType(String code)
Copyright © 2014–2021 Health Level 7. All rights reserved.