Data Model Libraries
    Preparing search index...

    Class ElementDefinitionConstraintComponent

    ElementDefinitionConstraintComponent Class

    FHIR Specification

    • Short: Condition that must evaluate to true
    • Definition: Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.
    • Comment: Constraints should be declared on the "context" element - the lowest element in the hierarchy that is common to all nodes referenced by the constraint.

    Hierarchy (View Summary)

    • DataType
      • ElementDefinitionConstraintComponent

    Implements

    Index

    Constructors

    Properties

    key: null | IdType

    ElementDefinition.constraint.key Element

    FHIR Specification

    • Short: Target of 'condition' reference above
    • Definition: Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.
    • FHIR Type: id
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    requirements?: StringType

    ElementDefinition.constraint.requirements Element

    FHIR Specification

    • Short: Why this constraint is necessary or appropriate
    • Definition: Description of why this constraint is necessary or appropriate.
    • Comment: To be used if the reason for the constraint might not be intuitive to all implementers.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    constraintSeverityEnum: ConstraintSeverityEnum

    FHIR CodeSystem: ConstraintSeverity

    severity: null | EnumCodeType

    ElementDefinition.constraint.severity Element

    FHIR Specification

    • Short: error | warning
    • Definition: Identifies the impact constraint violation has on the conformance of the instance.
    • Comment: This allows constraints to be asserted as "shall" (error) and "should" (warning).
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ConstraintSeverityEnum

    human: null | StringType

    ElementDefinition.constraint.human Element

    FHIR Specification

    • Short: Human description of constraint
    • Definition: Text that can be used to describe the constraint in messages identifying that the constraint has been violated.
    • Comment: Should be expressed in business terms as much as possible.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    expression?: StringType

    ElementDefinition.constraint.expression Element

    FHIR Specification

    • Short: FHIRPath expression of constraint
    • Definition: A FHIRPath expression of constraint that can be executed to see if this constraint is met.
    • Comment: In the absense of an expression, the expression is likely not enforceable by validators, and might be missed by many systems.
    • Requirements: Used by validation tooling tests of the validity of the resource.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    xpath?: StringType

    ElementDefinition.constraint.xpath Element

    FHIR Specification

    • Short: XPath expression of constraint
    • Definition: An XPath expression of constraint that can be executed to see if this constraint is met.
    • Comment: Elements SHALL use "f" as the namespace prefix for the FHIR namespace, and "x" for the xhtml namespace, and SHALL NOT use any other prefixes. Note: XPath is generally considered not useful because it does not apply to JSON and other formats and because of XSLT implementation issues, and may be removed in the future.
    • Requirements: Used in Schematron tests of the validity of the resource.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    source?: CanonicalType

    ElementDefinition.constraint.source Element

    FHIR Specification

    • Short: Reference to original source of constraint
    • Definition: A reference to the original source of the constraint, for traceability purposes.
    • Comment: This is used when, e.g. rendering, where it is not useful to present inherited constraints when rendering the snapshot.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided ElementDefinitionConstraintComponent JSON to instantiate the ElementDefinitionConstraintComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ElementDefinitionConstraintComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ElementDefinitionConstraintComponent

      Returns undefined | ElementDefinitionConstraintComponent

      ElementDefinitionConstraintComponent data model or undefined for ElementDefinitionConstraintComponent

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise