Package org.hl7.fhir.r5.model

Class ElementDefinition.ElementDefinitionConstraintComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.ElementDefinition.ElementDefinitionConstraintComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatypeElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions

Enclosing class:

ElementDefinition

public static class ElementDefinition.ElementDefinitionConstraintComponent
extends Element
implements org.hl7.fhir.instance.model.api.IBaseDatatypeElement

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected StringType	expression	A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.
protected StringType	human	Text that can be used to describe the constraint in messages identifying that the constraint has been violated.
protected IdType	key	Allows identification of which elements have their cardinalities impacted by the constraint.
protected MarkdownType	requirements	Description of why this constraint is necessary or appropriate.
protected Enumeration<ElementDefinition.ConstraintSeverity>	severity	Identifies the impact constraint violation has on the conformance of the instance.
protected CanonicalType	source	A reference to the original source of the constraint, for traceability purposes.
protected BooleanType	suppress	If true, indicates that the warning or best practice guideline should be suppressed.

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
ElementDefinitionConstraintComponent()	Constructor
ElementDefinitionConstraintComponent(String key, ElementDefinition.ConstraintSeverity severity, String human)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ElementDefinition.ElementDefinitionConstraintComponent	copy()
void	copyValues(ElementDefinition.ElementDefinitionConstraintComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getExpression()
StringType	getExpressionElement()
String	getHuman()
StringType	getHumanElement()
String	getKey()
IdType	getKeyElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getRequirements()
MarkdownType	getRequirementsElement()
ElementDefinition.ConstraintSeverity	getSeverity()
Enumeration<ElementDefinition.ConstraintSeverity>	getSeverityElement()
String	getSource()
CanonicalType	getSourceElement()
boolean	getSuppress()
BooleanType	getSuppressElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasExpression()
boolean	hasExpressionElement()
boolean	hasHuman()
boolean	hasHumanElement()
boolean	hasKey()
boolean	hasKeyElement()
boolean	hasRequirements()
boolean	hasRequirementsElement()
boolean	hasSeverity()
boolean	hasSeverityElement()
boolean	hasSource()
boolean	hasSourceElement()
boolean	hasSuppress()
boolean	hasSuppressElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ElementDefinition.ElementDefinitionConstraintComponent	setExpression(String value)
ElementDefinition.ElementDefinitionConstraintComponent	setExpressionElement(StringType value)
ElementDefinition.ElementDefinitionConstraintComponent	setHuman(String value)
ElementDefinition.ElementDefinitionConstraintComponent	setHumanElement(StringType value)
ElementDefinition.ElementDefinitionConstraintComponent	setKey(String value)
ElementDefinition.ElementDefinitionConstraintComponent	setKeyElement(IdType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ElementDefinition.ElementDefinitionConstraintComponent	setRequirements(String value)
ElementDefinition.ElementDefinitionConstraintComponent	setRequirementsElement(MarkdownType value)
ElementDefinition.ElementDefinitionConstraintComponent	setSeverity(ElementDefinition.ConstraintSeverity value)
ElementDefinition.ElementDefinitionConstraintComponent	setSeverityElement(Enumeration<ElementDefinition.ConstraintSeverity> value)
ElementDefinition.ElementDefinitionConstraintComponent	setSource(String value)
ElementDefinition.ElementDefinitionConstraintComponent	setSourceElement(CanonicalType value)
ElementDefinition.ElementDefinitionConstraintComponent	setSuppress(boolean value)
ElementDefinition.ElementDefinitionConstraintComponent	setSuppressElement(BooleanType value)
String	toString()

Methods inherited from class org.hl7.fhir.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

key

protected IdType key

Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.

requirements

protected MarkdownType requirements

Description of why this constraint is necessary or appropriate.

severity

protected Enumeration<ElementDefinition.ConstraintSeverity> severity

Identifies the impact constraint violation has on the conformance of the instance.

suppress

protected BooleanType suppress

If true, indicates that the warning or best practice guideline should be suppressed.

human

protected StringType human

Text that can be used to describe the constraint in messages identifying that the constraint has been violated.

expression

protected StringType expression

A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.

source

protected CanonicalType source

A reference to the original source of the constraint, for traceability purposes.

Constructor Details

ElementDefinitionConstraintComponent

public ElementDefinitionConstraintComponent()

Constructor

ElementDefinitionConstraintComponent

public ElementDefinitionConstraintComponent(String key,
 ElementDefinition.ConstraintSeverity severity,
 String human)

Constructor

Method Details

getKeyElement

public IdType getKeyElement()

Returns:

key (Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.). This is the underlying object with id, value and extensions. The accessor "getKey" gives direct access to the value

hasKeyElement

public boolean hasKeyElement()

hasKey

public boolean hasKey()

setKeyElement

public ElementDefinition.ElementDefinitionConstraintComponent setKeyElement(IdType value)

Parameters:

value - key (Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.). This is the underlying object with id, value and extensions. The accessor "getKey" gives direct access to the value

getKey

public String getKey()

Returns:

Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.

setKey

public ElementDefinition.ElementDefinitionConstraintComponent setKey(String value)

Parameters:

value - Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.

getRequirementsElement

public MarkdownType getRequirementsElement()

Returns:

requirements (Description of why this constraint is necessary or appropriate.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value

hasRequirementsElement

public boolean hasRequirementsElement()

hasRequirements

public boolean hasRequirements()

setRequirementsElement

public ElementDefinition.ElementDefinitionConstraintComponent setRequirementsElement(MarkdownType value)

Parameters:

value - requirements (Description of why this constraint is necessary or appropriate.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value

getRequirements

public String getRequirements()

Returns:

Description of why this constraint is necessary or appropriate.

setRequirements

public ElementDefinition.ElementDefinitionConstraintComponent setRequirements(String value)

Parameters:

value - Description of why this constraint is necessary or appropriate.

getSeverityElement

public Enumeration<ElementDefinition.ConstraintSeverity> getSeverityElement()

Returns:

severity (Identifies the impact constraint violation has on the conformance of the instance.). This is the underlying object with id, value and extensions. The accessor "getSeverity" gives direct access to the value

hasSeverityElement

public boolean hasSeverityElement()

hasSeverity

public boolean hasSeverity()

setSeverityElement

public ElementDefinition.ElementDefinitionConstraintComponent setSeverityElement(Enumeration<ElementDefinition.ConstraintSeverity> value)

Parameters:

value - severity (Identifies the impact constraint violation has on the conformance of the instance.). This is the underlying object with id, value and extensions. The accessor "getSeverity" gives direct access to the value

getSeverity

public ElementDefinition.ConstraintSeverity getSeverity()

Returns:

Identifies the impact constraint violation has on the conformance of the instance.

setSeverity

public ElementDefinition.ElementDefinitionConstraintComponent setSeverity(ElementDefinition.ConstraintSeverity value)

Parameters:

value - Identifies the impact constraint violation has on the conformance of the instance.

getSuppressElement

public BooleanType getSuppressElement()

Returns:

suppress (If true, indicates that the warning or best practice guideline should be suppressed.). This is the underlying object with id, value and extensions. The accessor "getSuppress" gives direct access to the value

hasSuppressElement

public boolean hasSuppressElement()

hasSuppress

public boolean hasSuppress()

setSuppressElement

public ElementDefinition.ElementDefinitionConstraintComponent setSuppressElement(BooleanType value)

Parameters:

value - suppress (If true, indicates that the warning or best practice guideline should be suppressed.). This is the underlying object with id, value and extensions. The accessor "getSuppress" gives direct access to the value

getSuppress

public boolean getSuppress()

Returns:

If true, indicates that the warning or best practice guideline should be suppressed.

setSuppress

public ElementDefinition.ElementDefinitionConstraintComponent setSuppress(boolean value)

Parameters:

value - If true, indicates that the warning or best practice guideline should be suppressed.

getHumanElement

public StringType getHumanElement()

Returns:

human (Text that can be used to describe the constraint in messages identifying that the constraint has been violated.). This is the underlying object with id, value and extensions. The accessor "getHuman" gives direct access to the value

hasHumanElement

public boolean hasHumanElement()

hasHuman

public boolean hasHuman()

setHumanElement

public ElementDefinition.ElementDefinitionConstraintComponent setHumanElement(StringType value)

Parameters:

value - human (Text that can be used to describe the constraint in messages identifying that the constraint has been violated.). This is the underlying object with id, value and extensions. The accessor "getHuman" gives direct access to the value

getHuman

public String getHuman()

Returns:

Text that can be used to describe the constraint in messages identifying that the constraint has been violated.

setHuman

public ElementDefinition.ElementDefinitionConstraintComponent setHuman(String value)

Parameters:

value - Text that can be used to describe the constraint in messages identifying that the constraint has been violated.

getExpressionElement

public StringType getExpressionElement()

Returns:

expression (A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.). This is the underlying object with id, value and extensions. The accessor "getExpression" gives direct access to the value

hasExpressionElement

public boolean hasExpressionElement()

hasExpression

public boolean hasExpression()

setExpressionElement

public ElementDefinition.ElementDefinitionConstraintComponent setExpressionElement(StringType value)

Parameters:

value - expression (A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.). This is the underlying object with id, value and extensions. The accessor "getExpression" gives direct access to the value

getExpression

public String getExpression()

Returns:

A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.

setExpression

public ElementDefinition.ElementDefinitionConstraintComponent setExpression(String value)

Parameters:

value - A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.

getSourceElement

public CanonicalType getSourceElement()

Returns:

source (A reference to the original source of the constraint, for traceability purposes.). This is the underlying object with id, value and extensions. The accessor "getSource" gives direct access to the value

hasSourceElement

public boolean hasSourceElement()

hasSource

public boolean hasSource()

setSourceElement

public ElementDefinition.ElementDefinitionConstraintComponent setSourceElement(CanonicalType value)

Parameters:

value - source (A reference to the original source of the constraint, for traceability purposes.). This is the underlying object with id, value and extensions. The accessor "getSource" gives direct access to the value

getSource

public String getSource()

Returns:

A reference to the original source of the constraint, for traceability purposes.

setSource

public ElementDefinition.ElementDefinitionConstraintComponent setSource(String value)

Parameters:

value - A reference to the original source of the constraint, for traceability purposes.

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Element

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public ElementDefinition.ElementDefinitionConstraintComponent copy()

Specified by:

copy in class Element

copyValues

public void copyValues(ElementDefinition.ElementDefinitionConstraintComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Element

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Element

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class Element

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class Element

Returns:

the FHIR type name of the instance (not the java class name)

toString

public String toString()

Overrides:

toString in class Object