Package com.ibm.fhir.model.annotation

Annotation Type Constraint

@Repeatable(Constraints.class)
@Target(TYPE)
@Retention(RUNTIME)
public @interface Constraint

An annotation interface that represents a formal constraint (invariant)

Constraints can be computationally evaluated using a FHIRPath engine or an instance of ConstraintValidator.

Field Summary

Fields

Modifier and Type	Fields	Description
static String	LEVEL_RULE
static String	LEVEL_WARNING
static String	LOCATION_BASE
static String	SOURCE_UNKNOWN

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	description	A description used in messages identifying that the constraint has been violated
String	expression	A FHIRPath expression that must evaluate to true when run on the validation target Element or Resource
String	id	Identifies the constraint uniquely amongst all the constraints in the context
String	level	The severity of the constraint
String	location	The location (path) of the validation target Element or Resource
String	source	The original source of the constraint

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	generated	Indicates whether the constraint was generated
boolean	modelChecked	Indicates whether the constraint is checked in the model
Class<? extends ConstraintValidator<?>>	validatorClass	The ConstraintValidator class used to validate this constraint

Field Detail

LEVEL_RULE

static final String LEVEL_RULE

LEVEL_WARNING

static final String LEVEL_WARNING

LOCATION_BASE

static final String LOCATION_BASE

SOURCE_UNKNOWN

static final String SOURCE_UNKNOWN

Element Detail

id

String id

Identifies the constraint uniquely amongst all the constraints in the context

Returns:

the id

See Also:

ElementDefinition.Constraint.getKey()

level

String level

The severity of the constraint

Returns:

the level

See Also:

ElementDefinition.Constraint.getSeverity()

location

String location

The location (path) of the validation target Element or Resource

Returns:

the location

See Also:

ElementDefinition.getPath()

description

String description

A description used in messages identifying that the constraint has been violated

Returns:

the description

See Also:

ElementDefinition.Constraint.getHuman()

expression

String expression

A FHIRPath expression that must evaluate to true when run on the validation target Element or Resource

Returns:

the expression

See Also:

ElementDefinition.Constraint.getExpression()

source

String source

The original source of the constraint

Returns:

the source

See Also:

ElementDefinition.Constraint.getSource()

modelChecked

boolean modelChecked

Indicates whether the constraint is checked in the model

Returns:

true if the constraint is checked in the model, false otherwise

Default:

false

generated

boolean generated

Indicates whether the constraint was generated

Returns:

true if the constraint was generated, false otherwise

Default:

false

validatorClass

Class<? extends ConstraintValidator<?>> validatorClass

The ConstraintValidator class used to validate this constraint

Returns:

the ConstraintValidator class used to validate this constraint

Default:

com.ibm.fhir.model.annotation.Constraint.FHIRPathConstraintValidator.class