Ingredient constructor

const Ingredient({ @Default(R5ResourceType.Ingredient) @JsonKey(unknownEnumValue: R5ResourceType.Ingredient) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<Resource>? contained, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, Identifier? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, @JsonKey(name: 'for') List<Reference>? for_, required CodeableConcept role, @JsonKey(name: 'function') List<CodeableConcept>? function_, CodeableConcept? group, FhirBoolean? allergenicIndicator, @JsonKey(name: '_allergenicIndicator') Element? allergenicIndicatorElement, FhirMarkdown? comment, @JsonKey(name: '_comment') Element? commentElement, List<IngredientManufacturer>? manufacturer, required IngredientSubstance substance, })

Ingredient An ingredient of a manufactured item or pharmaceutical product.

resourceType This is a Ingredient resource

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRules A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

implicitRulesElement ("_implicitRules") Extensions for implicitRules

language The base language in which the resource is written.

languageElement ("_language") Extensions for language

text A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

extension_ ("extension") May be used to represent additional information that is not part of the basic definition of the resource. 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 resource and that modifies the understanding of the element that contains it 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 is allowed to 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).

identifier The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.

status The status of this ingredient. Enables tracking the life-cycle of the content.

statusElement ("_status") Extensions for status

for_ ("for") The product which this ingredient is a constituent part of.

role A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.

function_ ("function") A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: antioxidant, alkalizing agent.

group A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink.

allergenicIndicator If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here.

allergenicIndicatorElement ("_allergenicIndicator") Extensions for allergenicIndicator

comment A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying.

commentElement ("_comment") Extensions for comment

manufacturer The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case.

substance The substance that comprises this ingredient.

Implementation

const factory Ingredient({
  /// [resourceType] This is a Ingredient resource
  @Default(R5ResourceType.Ingredient)
  @JsonKey(unknownEnumValue: R5ResourceType.Ingredient)
  R5ResourceType resourceType,
  @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,

  /// [id] The logical id of the resource, as used in the URL for the
  ///  resource. Once assigned, this value never changes.
  @JsonKey(name: 'id') FhirId? fhirId,

  /// [meta] The metadata about the resource. This is content that is
  ///  maintained by the infrastructure. Changes to the content might not
  ///  always be associated with version changes to the resource.
  FhirMeta? meta,

  /// [implicitRules] A reference to a set of rules that were followed when
  ///  the resource was constructed, and which must be understood when
  ///  processing the content. Often, this is a reference to an
  ///  implementation guide that defines the special rules along with other
  ///  profiles etc.
  FhirUri? implicitRules,

  /// [implicitRulesElement] ("_implicitRules") Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.
  FhirCode? language,

  /// [languageElement] ("_language") Extensions for language
  @JsonKey(name: '_language') Element? languageElement,

  /// [text] A human-readable narrative that contains a summary of the
  ///  resource and can be used to represent the content of the resource to a
  ///  human. The narrative need not encode all the structured data, but is
  ///  required to contain sufficient detail to make it "clinically safe" for
  ///  a human to just read the narrative. Resource definitions may define
  ///  what content should be represented in the narrative to ensure clinical
  ///  safety.
  Narrative? text,

  /// [contained] These resources do not have an independent existence apart
  ///  from the resource that contains them - they cannot be identified
  ///  independently, nor can they have their own independent transaction
  ///  scope. This is allowed to be a Parameters resource if and only if it
  ///  is referenced by a resource that provides context/meaning.
  List<Resource>? contained,

  /// [extension_] ("extension") May be used to represent additional
  ///  information that is not part of the basic definition of the resource.
  ///  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 resource and that
  ///  modifies the understanding of the element that contains it 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 is allowed to 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,

  /// [identifier] The identifier(s) of this Ingredient that are assigned by
  ///  business processes and/or used to refer to it when a direct URL
  ///  reference to the resource itself is not appropriate.
  Identifier? identifier,

  /// [status] The status of this ingredient. Enables tracking the life-cycle
  ///  of the content.
  FhirCode? status,

  /// [statusElement] ("_status") Extensions for status
  @JsonKey(name: '_status') Element? statusElement,

  /// [for_] ("for") The product which this ingredient is a constituent part
  ///  of.
  @JsonKey(name: 'for') List<Reference>? for_,

  /// [role] A classification of the ingredient identifying its purpose
  ///  within the product, e.g. active, inactive.
  required CodeableConcept role,

  /// [function_] ("function") A classification of the ingredient identifying
  ///  its precise purpose(s) in the drug product. This extends the
  ///  Ingredient.role to add more detail. Example: antioxidant, alkalizing
  ///  agent.
  @JsonKey(name: 'function') List<CodeableConcept>? function_,

  /// [group] A classification of the ingredient according to where in the
  ///  physical item it tends to be used, such the outer shell of a tablet,
  ///  inner body or ink.
  CodeableConcept? group,

  /// [allergenicIndicator] If the ingredient is a known or suspected
  ///  allergen. Note that this is a property of the substance, so if a
  ///  reference to a SubstanceDefinition is used to decribe that (rather
  ///  than just a code), the allergen information should go there, not here.
  FhirBoolean? allergenicIndicator,

  /// [allergenicIndicatorElement] ("_allergenicIndicator") Extensions for
  ///  allergenicIndicator
  @JsonKey(name: '_allergenicIndicator') Element? allergenicIndicatorElement,

  /// [comment] A place for providing any notes that are relevant to the
  ///  component, e.g. removed during process, adjusted for loss on drying.
  FhirMarkdown? comment,

  /// [commentElement] ("_comment") Extensions for comment
  @JsonKey(name: '_comment') Element? commentElement,

  /// [manufacturer] The organization(s) that manufacture this ingredient.
  ///  Can be used to indicate:         1) Organizations we are aware of that
  ///  manufacture this ingredient         2) Specific Manufacturer(s)
  ///  currently being used         3) Set of organisations allowed to
  ///  manufacture this ingredient for this product         Users must be
  ///  clear on the application of context relevant to their use case.
  List<IngredientManufacturer>? manufacturer,

  /// [substance] The substance that comprises this ingredient.
  required IngredientSubstance substance,
}) = _Ingredient;