Ingredient class

Ingredient An ingredient of a manufactured item or pharmaceutical product.

Mixed in types
Annotations
  • @freezed

Constructors

Ingredient({@Default(R4ResourceType.Ingredient) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? 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, List<CodeableConcept>? function, CodeableConcept? group, FhirBoolean? allergenicIndicator, @JsonKey(name: '_allergenicIndicator') Element? allergenicIndicatorElement, List<IngredientManufacturer>? manufacturer, required IngredientSubstance substance})
Ingredient An ingredient of a manufactured item or pharmaceutical product.
const
factory
Ingredient.fromJson(Map<String, dynamic> json)
Factory constructor, accepts Map<String, dynamic> as an argument
factory
Ingredient.fromJsonString(String source)
Acts like a constructor, returns a Ingredient, accepts a String as an argument, mostly because I got tired of typing it out
factory
Ingredient.fromYaml(dynamic yaml)
Factory constructor that accepts a String in YAML format as an argument
factory

Properties

allergenicIndicator FhirBoolean?
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.;
no setterinherited
allergenicIndicatorElement Element?
allergenicIndicatorElement (_allergenicIndicator): Extensions for allergenicIndicator;
no setterinherited
contained List<Resource>?
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.;
no setterinherited
copyWith → $IngredientCopyWith<Ingredient>
no setterinherited
dbId int?
no setterinherited
extension_ List<FhirExtension>?
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 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.;
no setterinherited
fhirId String?
id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.;
no setterinherited
for_ List<Reference>?
for The product which this ingredient is a constituent part of.;
no setterinherited
function List<CodeableConcept>?
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.;
no setterinherited
group CodeableConcept?
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.;
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
identifier Identifier?
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.;
no setterinherited
implicitRules FhirUri?
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.;
no setterinherited
implicitRulesElement Element?
implicitRulesElement (_implicitRules): Extensions for implicitRules;
no setterinherited
language FhirCode?
language The base language in which the resource is written.;
no setterinherited
languageElement Element?
languageElement (_language): Extensions for language;
no setterinherited
manufacturer List<IngredientManufacturer>?
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.;
no setterinherited
meta FhirMeta?
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.;
no setterinherited
modifierExtension List<FhirExtension>?
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 manageable, 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).;
no setterinherited
path String
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
resourceType R4ResourceType
resourceType This is a Ingredient resource;
no setterinherited
resourceTypeString String?
produce a string of the resourceType
no setterinherited
role CodeableConcept
role A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.;
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
status FhirCode?
status The status of this ingredient. Enables tracking the life-cycle of the content.;
no setterinherited
statusElement Element?
statusElement (_status): Extensions for status;
no setterinherited
substance IngredientSubstance
substance The substance that comprises this ingredient.;
no setterinherited
text Narrative?
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.;
no setterinherited
thisReference Reference
Convenience method to return a Reference referring to that Resource
no setterinherited

Methods

newId() Resource
returns the same resource with a new ID (even if there is already an ID present)
inherited
newIdIfNoId() Resource
returns the same resource with a new ID if there is no current ID
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDbJson() Map<String, dynamic>
The normal toJson ignores the dbId, and produces the fhirId as the id However, if you're going to use this as a database entry, you have to switch those two ids
inherited
toJson() Map<String, dynamic>
inherited
toJsonString() String
Another convenience method because more and more I'm transmitting FHIR data as a String and not a Map
override
toString() String
A string representation of this object.
inherited
toYaml() String
Produces a Yaml formatted String version of the object
inherited
updateVersion({FhirMeta? oldMeta}) Resource
Updates the meta field of this Resource, updates the meta.lastUpdated field, adds 1 to the version number
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited