SubstanceDefinitionRelationship constructor

const SubstanceDefinitionRelationship({
  1. @JsonKey(name: 'id') FhirId? fhirId,
  2. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  3. List<FhirExtension>? modifierExtension,
  4. Reference? substanceDefinitionReference,
  5. CodeableConcept? substanceDefinitionCodeableConcept,
  6. required CodeableConcept type,
  7. FhirBoolean? isDefining,
  8. @JsonKey(name: '_isDefining') Element? isDefiningElement,
  9. Quantity? amountQuantity,
  10. Ratio? amountRatio,
  11. FhirMarkdown? amountString,
  12. @JsonKey(name: '_amountString') Element? amountStringElement,
  13. Ratio? ratioHighLimitAmount,
  14. CodeableConcept? comparator,
  15. List<Reference>? source,
})

SubstanceDefinitionRelationship The detailed description of a substance, typically at a level beyond what is used for prescribing.

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).;

substanceDefinitionReference A pointer to another substance, as a resource or just a representational code.;

substanceDefinitionCodeableConcept A pointer to another substance, as a resource or just a representational code.;

type For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of".;

isDefining For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.;

isDefiningElement (_isDefining): Extensions for isDefining;

amountQuantity A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.;

amountRatio A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.;

amountString A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.;

amountStringElement (_amountString): Extensions for amountString;

ratioHighLimitAmount For use when the numeric has an uncertain range.;

comparator An operator for the amount, for example "average", "approximately", "less than".;

source Supporting literature.;

Implementation

///
/// [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).;
///
/// [substanceDefinitionReference] A pointer to another substance, as a resource or just a representational code.;
///
/// [substanceDefinitionCodeableConcept] A pointer to another substance, as a resource or just a representational code.;
///
/// [type] For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of".;
///
/// [isDefining] For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.;
///
/// [isDefiningElement] (_isDefining): Extensions for isDefining;
///
/// [amountQuantity] A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.;
///
/// [amountRatio] A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.;
///
/// [amountString] A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.;
///
/// [amountStringElement] (_amountString): Extensions for amountString;
///
/// [ratioHighLimitAmount] For use when the numeric has an uncertain range.;
///
/// [comparator] An operator for the amount, for example "average", "approximately", "less than".;
///
/// [source] Supporting literature.;
const factory SubstanceDefinitionRelationship({
  /// [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') FhirId? 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,

  /// [substanceDefinitionReference] A pointer to another substance, as a resource or just a representational code.;
  Reference? substanceDefinitionReference,

  /// [substanceDefinitionCodeableConcept] A pointer to another substance, as a resource or just a representational code.;
  CodeableConcept? substanceDefinitionCodeableConcept,

  /// [type] For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of".;
  required CodeableConcept type,

  /// [isDefining] For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.;
  FhirBoolean? isDefining,

  /// [isDefiningElement] (_isDefining): Extensions for isDefining;
  @JsonKey(name: '_isDefining') Element? isDefiningElement,

  /// [amountQuantity] A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.;
  Quantity? amountQuantity,

  /// [amountRatio] A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.;
  Ratio? amountRatio,

  /// [amountString] A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.;
  FhirMarkdown? amountString,

  /// [amountStringElement] (_amountString): Extensions for amountString;
  @JsonKey(name: '_amountString') Element? amountStringElement,

  /// [ratioHighLimitAmount] For use when the numeric has an uncertain range.;
  Ratio? ratioHighLimitAmount,

  /// [comparator] An operator for the amount, for example "average", "approximately", "less than".;
  CodeableConcept? comparator,

  /// [source] Supporting literature.;
  List<Reference>? source,
}) = _SubstanceDefinitionRelationship;