Package com.ibm.fhir.model.type

Class ElementDefinition.Constraint

  • All Implemented Interfaces:
    Visitable
    Enclosing class:
    ElementDefinition
    public static class ElementDefinition.Constraint
extends BackboneElement
    Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.

    • Method Detail

      • getKey

        public Id getKey()
        Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.
        Returns:
        An immutable object of type Id that is non-null.

      • getRequirements

        public String getRequirements()
        Description of why this constraint is necessary or appropriate.
        Returns:
        An immutable object of type String that may be null.

      • getSeverity

        public ConstraintSeverity getSeverity()
        Identifies the impact constraint violation has on the conformance of the instance.
        Returns:
        An immutable object of type ConstraintSeverity that is non-null.

      • getHuman

        public String getHuman()
        Text that can be used to describe the constraint in messages identifying that the constraint has been violated.
        Returns:
        An immutable object of type String that is non-null.

      • getExpression

        public String getExpression()
        A [FHIRPath](fhirpath.html) expression of constraint that can be executed to see if this constraint is met.
        Returns:
        An immutable object of type String that may be null.

      • getXpath

        public String getXpath()
        An XPath expression of constraint that can be executed to see if this constraint is met.
        Returns:
        An immutable object of type String that may be null.

      • getSource

        public Canonical getSource()
        A reference to the original source of the constraint, for traceability purposes.
        Returns:
        An immutable object of type Canonical that may be null.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object