Ingredient

Property	Value
Publisher
Name	Ingredient
URL	http://hl7.org/fhir/StructureDefinition/Ingredient
Status	draft
Description
Abstract	false

Structure

Path	Cardinality	Type	Description
Ingredient	0..*	Ingredient	An ingredient of a manufactured item or pharmaceutical product.
Ingredient.id	0..1	http://hl7.org/fhirpath/System.String	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Ingredient.meta	0..1	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.
Ingredient.implicitRules	0..1	uri	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.
Ingredient.language	0..1	code	The base language in which the resource is written.
Ingredient.text	0..1	Narrative	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.
Ingredient.contained	0..*	Resource	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Ingredient.extension	0..*	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.
Ingredient.modifierExtension	0..*	Extension	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).
Ingredient.identifier	0..1	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.
Ingredient.status	1..1	code	The status of this ingredient. Enables tracking the life-cycle of the content.
Ingredient.for	0..*	Reference	The product which this ingredient is a constituent part of.
Ingredient.role	1..1	CodeableConcept	A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.
Ingredient.function	0..*	CodeableConcept	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.
Ingredient.allergenicIndicator	0..1	boolean	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.
Ingredient.manufacturer	0..*	BackboneElement	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.
Ingredient.manufacturer.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Ingredient.manufacturer.extension	0..*	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.
Ingredient.manufacturer.modifierExtension	0..*	Extension	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).
Ingredient.manufacturer.role	0..1	code	The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role.
Ingredient.manufacturer.manufacturer	1..1	Reference	An organization that manufactures this ingredient.
Ingredient.substance	1..1	BackboneElement	The substance that comprises this ingredient.
Ingredient.substance.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Ingredient.substance.extension	0..*	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.
Ingredient.substance.modifierExtension	0..*	Extension	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).
Ingredient.substance.code	1..1	CodeableReference	A code or full resource that represents the ingredient's substance.
Ingredient.substance.strength	0..*	BackboneElement	The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. The allowed repetitions do not represent different strengths, but are different representations - mathematically equivalent - of a single strength.
Ingredient.substance.strength.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Ingredient.substance.strength.extension	0..*	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.
Ingredient.substance.strength.modifierExtension	0..*	Extension	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).
Ingredient.substance.strength.presentation[x]	0..1	Ratio	The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').
Ingredient.substance.strength.textPresentation	0..1	string	A textual represention of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.
Ingredient.substance.strength.concentration[x]	0..1	Ratio	The strength per unitary volume (or mass).
Ingredient.substance.strength.textConcentration	0..1	string	A textual represention of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.
Ingredient.substance.strength.measurementPoint	0..1	string	For when strength is measured at a particular point or distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization.
Ingredient.substance.strength.country	0..*	CodeableConcept	The country or countries for which the strength range applies.
Ingredient.substance.strength.referenceStrength	0..*	BackboneElement	Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed.
Ingredient.substance.strength.referenceStrength.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Ingredient.substance.strength.referenceStrength.extension	0..*	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.
Ingredient.substance.strength.referenceStrength.modifierExtension	0..*	Extension	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).
Ingredient.substance.strength.referenceStrength.substance	0..1	CodeableReference	Relevant reference substance.
Ingredient.substance.strength.referenceStrength.strength[x]	1..1	Ratio	Strength expressed in terms of a reference substance.
Ingredient.substance.strength.referenceStrength.measurementPoint	0..1	string	For when strength is measured at a particular point or distance.
Ingredient.substance.strength.referenceStrength.country	0..*	CodeableConcept	The country or countries for which the strength range applies.

Search Parameters

Name	Type	Description	Expression
_text	string	Search on the narrative of the resource
_content	string	Search on the entire content of the resource
_filter	token	Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_has	string	Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_id	token	Logical id of this artifact	Resource.id
_lastUpdated	date	When the resource version last changed	Resource.meta.lastUpdated
_list	string	All resources in nominated list (by id, Type/id, url or one of the magic List types)
_profile	uri	Profiles this resource claims to conform to	Resource.meta.profile
_query	token	A custom search profile that describes a specific defined query operation
_security	token	Security Labels applied to this resource	Resource.meta.security
_source	uri	Identifies where the resource comes from	Resource.meta.source
_tag	token	Tags applied to this resource	Resource.meta.tag
_text	string	Search on the narrative text (html) of the resource
_type	token	Used when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
for	reference	The product which this ingredient is a constituent part of	Ingredient.for
function	token	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	Ingredient.function
identifier	token	An identifier or code by which the ingredient can be referenced	Ingredient.identifier
manufacturer	reference	The organization that manufactures this ingredient	Ingredient.manufacturer
role	token	A classification of the ingredient identifying its purpose within the product, e.g. active, inactive	Ingredient.role
substance	reference	Reference to a resource (by instance)	Ingredient.substance.code.reference
substance-code	token	Reference to a concept (by class)	Ingredient.substance.code.concept
substance-definition	reference	Reference to a resource (by instance)	Ingredient.substance.code.reference