ElementDefinitionConstraint constructor

const ElementDefinitionConstraint({ @JsonKey(name: 'id') String? fhirId, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, FhirId? key, @JsonKey(name: '_key') Element? keyElement, String? requirements, @JsonKey(name: '_requirements') Element? requirementsElement, @JsonKey(unknownEnumValue: ElementDefinitionConstraintSeverity.unknown) ElementDefinitionConstraintSeverity? severity, @JsonKey(name: '_severity') Element? severityElement, String? human, @JsonKey(name: '_human') Element? humanElement, String? expression, @JsonKey(name: '_expression') Element? expressionElement, String? xpath, @JsonKey(name: '_xpath') Element? xpathElement, FhirCanonical? source, })

ElementDefinitionConstraint Captures constraints on each element within the resource, profile, or extension.

id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extension_ May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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

keyElement Extensions for key

requirements Description of why this constraint is necessary or appropriate.

requirementsElement Extensions for requirements

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

severityElement Extensions for severity

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

humanElement Extensions for human

expression A FHIRPath expression of constraint that can be executed to see if this constraint is met.

expressionElement Extensions for expression

xpath An XPath expression of constraint that can be executed to see if this constraint is met.

xpathElement Extensions for xpath

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

Implementation

const factory ElementDefinitionConstraint({
  /// [id] Unique id for the element within a resource (for internal
  ///  references). This may be any string value that does not contain spaces.
  @JsonKey(name: 'id') String? fhirId,

  /// [extension_] May be used to represent additional information that is not
  /// part of the basic definition of the element. To make the use of extensions
  /// safe and manageable, there is a strict set of governance  applied to the
  /// definition and use of extensions. Though any implementer can define an
  /// extension, there is a set of requirements that SHALL be met as part of the
  ///  definition of the extension.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] May be used to represent additional information that
  /// is not part of the basic definition of the element and that modifies the
  /// understanding of the element in which it is contained and/or the
  /// understanding of the containing element's descendants. Usually modifier
  /// elements provide negation or qualification. To make the use of extensions
  /// safe and manageable, there is a strict set of governance applied to the
  /// definition and use of extensions. Though any implementer can define an
  /// extension, there is a set of requirements that SHALL be met as part of the
  /// definition of the extension. Applications processing a resource are
  ///  required to check for modifier extensions.
  /// Modifier extensions SHALL NOT change the meaning of any elements on
  /// Resource or DomainResource (including cannot change the meaning of
  ///  modifierExtension itself).
  List<FhirExtension>? modifierExtension,

  /// [key] Allows identification of which elements have their cardinalities
  /// impacted by the constraint.  Will not be referenced for constraints that
  ///  do not affect cardinality.
  FhirId? key,

  /// [keyElement] Extensions for key
  @JsonKey(name: '_key') Element? keyElement,

  /// [requirements] Description of why this constraint is necessary or
  ///  appropriate.
  String? requirements,

  /// [requirementsElement] Extensions for requirements
  @JsonKey(name: '_requirements') Element? requirementsElement,
  @JsonKey(unknownEnumValue: ElementDefinitionConstraintSeverity.unknown)

  /// [severity] Identifies the impact constraint violation has on the
  ///  conformance of the instance.
  ElementDefinitionConstraintSeverity? severity,

  /// [severityElement] Extensions for severity
  @JsonKey(name: '_severity') Element? severityElement,

  /// [human] Text that can be used to describe the constraint in messages
  ///  identifying that the constraint has been violated.
  String? human,

  /// [humanElement] Extensions for human
  @JsonKey(name: '_human') Element? humanElement,

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

  /// [expressionElement] Extensions for expression
  @JsonKey(name: '_expression') Element? expressionElement,

  /// [xpath] An XPath expression of constraint that can be executed to see if
  ///  this constraint is met.
  String? xpath,

  /// [xpathElement] Extensions for xpath
  @JsonKey(name: '_xpath') Element? xpathElement,

  /// [source] A reference to the original source of the constraint, for
  ///  traceability purposes.
  FhirCanonical? source,
}) = _ElementDefinitionConstraint;