ElementDefinitionAdditional constructor

const ElementDefinitionAdditional({
  1. @JsonKey(name: 'id') String? fhirId,
  2. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  3. List<FhirExtension>? modifierExtension,
  4. FhirCode? purpose,
  5. @JsonKey(name: '_purpose') Element? purposeElement,
  6. required FhirCanonical valueSet,
  7. FhirMarkdown? documentation,
  8. @JsonKey(name: '_documentation') Element? documentationElement,
  9. String? shortDoco,
  10. @JsonKey(name: '_shortDoco') Element? shortDocoElement,
  11. List<UsageContext>? usage,
  12. FhirBoolean? any,
  13. @JsonKey(name: '_any') Element? anyElement,
})

ElementDefinitionAdditional 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_ ("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 managable, 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 managable, 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).

purpose The use of this additional binding.

purposeElement ("_purpose") Extensions for purpose

valueSet The valueSet that is being bound for the purpose.

documentation Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.

documentationElement ("_documentation") Extensions for documentation

shortDoco Concise documentation - for summary tables.

shortDocoElement ("_shortDoco") Extensions for shortDoco

usage Qualifies the usage of the binding. Typically bindings are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.

any Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat.

anyElement ("_any") Extensions for any

Implementation

const factory ElementDefinitionAdditional({
  /// [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_] ("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 managable, 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 managable, 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,

  /// [purpose] The use of this additional binding.
  FhirCode? purpose,

  /// [purposeElement] ("_purpose") Extensions for purpose
  @JsonKey(name: '_purpose') Element? purposeElement,

  /// [valueSet] The valueSet that is being bound for the purpose.
  required FhirCanonical valueSet,

  /// [documentation] Documentation of the purpose of use of the
  ///  bindingproviding additional information about how it is intended to be
  ///  used.
  FhirMarkdown? documentation,

  /// [documentationElement] ("_documentation") Extensions for documentation
  @JsonKey(name: '_documentation') Element? documentationElement,

  /// [shortDoco] Concise documentation - for summary tables.
  String? shortDoco,

  /// [shortDocoElement] ("_shortDoco") Extensions for shortDoco
  @JsonKey(name: '_shortDoco') Element? shortDocoElement,

  /// [usage] Qualifies the usage of the binding. Typically bindings are
  ///  qualified by jurisdiction, but they may also be qualified by gender,
  ///  workflow status, clinical domain etc. The information to decide
  ///  whether a usege context applies is usually outside the resource,
  ///  determined by context, and this might present challenges for
  ///  validation tooling.
  List<UsageContext>? usage,

  /// [any] Whether the binding applies to all repeats, or just to any one of
  ///  them. This is only relevant for elements that can repeat.
  FhirBoolean? any,

  /// [anyElement] ("_any") Extensions for any
  @JsonKey(name: '_any') Element? anyElement,
}) = _ElementDefinitionAdditional;