Generated Narrative: StructureDefinition ext-R4B-Ingredient Name Flags Card. Type Description & Constraints Extension 0..* Extension(4.0.1) An ingredient of a manufactured item or pharmaceutical product #xD; Slices for extension 3..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:status 1..1 Extension draft | active | retired | unknown #xD; url 1..1 uri "status" #xD; value[x] 0..1 code draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. #xD; extension:for 0..* Extension The product which this ingredient is a constituent part of #xD; url 1..1 uri "for" #xD; value[x] 0..1 Reference() The product which this ingredient is a constituent part of #xD; extension:role 1..1 Extension Purpose of the ingredient within the product, e.g. active, inactive #xD; url 1..1 uri "role" #xD; value[x] 0..1 CodeableConcept Purpose of the ingredient within the product, e.g. active, inactive Binding: R4B_ingredient_role_for_R4 (0.0.1-snapshot-2) (example): A classification of the ingredient identifying its purpose within the product, e.g. active, inactive. #xD; extension:function 0..* Extension Precise action within the drug product, e.g. antioxidant, alkalizing agent #xD; url 1..1 uri "function" #xD; value[x] 0..1 CodeableConcept Precise action within the drug product, e.g. antioxidant, alkalizing agent Binding: R4B_ingredient_function_for_R4 (0.0.1-snapshot-2) (example): A classification of the ingredient identifying its precise purpose(s) in the drug product (beyond e.g. active/inactive). #xD; extension:allergenicIndicator 0..1 Extension If the ingredient is a known or suspected allergen #xD; url 1..1 uri "allergenicIndicator" #xD; value[x] 0..1 boolean If the ingredient is a known or suspected allergen #xD; <a href="StructureDefinition-ext-R4B-Ingredient-definitions.html#Extension.extension:manufacturer" title="Slice 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.">extension:manufacturer 0..* Extension An organization that manufactures this ingredient #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:role 0..1 Extension allowed | possible | actual #xD; url 1..1 uri "role" #xD; value[x] 0..1 code allowed | possible | actual Binding: R4B_ingredient_manufacturer_role_for_R4 (0.0.1-snapshot-2) (required): The way in which this manufacturer is associated with the ingredient. #xD; extension:manufacturer 1..1 Extension An organization that manufactures this ingredient #xD; url 1..1 uri "manufacturer" #xD; value[x] 0..1 Reference() An organization that manufactures this ingredient #xD; url 1..1 uri "manufacturer" #xD; extension:substance 1..1 Extension The substance that comprises this ingredient #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:code 1..1 Extension A code or full resource that represents the ingredient substance #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:concept 0..1 Extension Reference to a concept (by class) #xD; url 1..1 uri "concept" #xD; value[x] 0..1 CodeableConcept Reference to a concept (by class) #xD; extension:reference 0..1 Extension Reference to a resource (by instance) #xD; url 1..1 uri "reference" #xD; value[x] 0..1 Reference() Reference to a resource (by instance) #xD; extension:_datatype 0..1 (Complex) Data type name for Ingredient.substance.code from FHIR R4B URL: http://hl7.org/fhir/StructureDefinition/_datatype #xD; value[x] 1..1 string Value of extension Fixed Value: CodeableReference #xD; url 1..1 uri "code" #xD; <a href="StructureDefinition-ext-R4B-Ingredient-definitions.html#Extension.extension:substance.extension:strength" title="Slice strength: 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.">extension:strength 0..* Extension The quantity of substance, per presentation, or per volume or mass, and type of quantity #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Closed by value:url #xD; <a href="StructureDefinition-ext-R4B-Ingredient-definitions.html#Extension.extension:substance.extension:strength.extension:presentation[x]" title="Slice presentation[x]: 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').">extension:presentation[x] 0..1 Extension The quantity of substance in the unit of presentation #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:lowNumerator 0..1 Extension Low Numerator limit #xD; url 1..1 uri "lowNumerator" #xD; value[x] 0..1 SimpleQuantity(4.0.1) Low Numerator limit #xD; extension:highNumerator 0..1 Extension High Numerator limit #xD; url 1..1 uri "highNumerator" #xD; value[x] 0..1 SimpleQuantity(4.0.1) High Numerator limit #xD; extension:denominator 0..1 Extension Denominator value #xD; url 1..1 uri "denominator" #xD; value[x] 0..1 SimpleQuantity(4.0.1) Denominator value #xD; extension:_datatype 0..1 (Complex) Data type name for Ingredient.substance.strength.presentation[x] from FHIR R4B URL: http://hl7.org/fhir/StructureDefinition/_datatype #xD; value[x] 1..1 string Value of extension Fixed Value: RatioRange #xD; url 1..1 uri "presentation[x]" #xD; <a href="StructureDefinition-ext-R4B-Ingredient-definitions.html#Extension.extension:substance.extension:strength.extension:presentation[x].value[x]" title="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').">value[x] 0..1 Ratio The quantity of substance in the unit of presentation #xD; extension:textPresentation 0..1 Extension Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio) #xD; url 1..1 uri "textPresentation" #xD; value[x] 0..1 string Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio) #xD; extension:concentration[x] 0..1 Extension The strength per unitary volume (or mass) #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:lowNumerator 0..1 Extension Low Numerator limit #xD; url 1..1 uri "lowNumerator" #xD; value[x] 0..1 SimpleQuantity(4.0.1) Low Numerator limit #xD; extension:highNumerator 0..1 Extension High Numerator limit #xD; url 1..1 uri "highNumerator" #xD; value[x] 0..1 SimpleQuantity(4.0.1) High Numerator limit #xD; extension:denominator 0..1 Extension Denominator value #xD; url 1..1 uri "denominator" #xD; value[x] 0..1 SimpleQuantity(4.0.1) Denominator value #xD; extension:_datatype 0..1 (Complex) Data type name for Ingredient.substance.strength.concentration[x] from FHIR R4B URL: http://hl7.org/fhir/StructureDefinition/_datatype #xD; value[x] 1..1 string Value of extension Fixed Value: RatioRange #xD; url 1..1 uri "concentration[x]" #xD; value[x] 0..1 Ratio The strength per unitary volume (or mass) #xD; extension:textConcentration 0..1 Extension Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio) #xD; url 1..1 uri "textConcentration" #xD; value[x] 0..1 string Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio) #xD; <a href="StructureDefinition-ext-R4B-Ingredient-definitions.html#Extension.extension:substance.extension:strength.extension:measurementPoint" title="Slice measurementPoint: 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.">extension:measurementPoint 0..1 Extension When strength is measured at a particular point or distance #xD; url 1..1 uri "measurementPoint" #xD; <a href="StructureDefinition-ext-R4B-Ingredient-definitions.html#Extension.extension:substance.extension:strength.extension:measurementPoint.value[x]" title="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.">value[x] 0..1 string When strength is measured at a particular point or distance #xD; extension:country 0..* Extension Where the strength range applies #xD; url 1..1 uri "country" #xD; value[x] 0..1 CodeableConcept Where the strength range applies Binding: R4B_country_for_R4 (0.0.1-snapshot-2) (example): Jurisdiction codes #xD; <a href="StructureDefinition-ext-R4B-Ingredient-definitions.html#Extension.extension:substance.extension:strength.extension:referenceStrength" title="Slice referenceStrength: 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.">extension:referenceStrength 0..* Extension Strength expressed in terms of a reference substance #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:substance 0..1 Extension Relevant reference substance #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:concept 0..1 Extension Reference to a concept (by class) #xD; url 1..1 uri "concept" #xD; value[x] 0..1 CodeableConcept Reference to a concept (by class) #xD; extension:reference 0..1 Extension Reference to a resource (by instance) #xD; url 1..1 uri "reference" #xD; value[x] 0..1 Reference() Reference to a resource (by instance) #xD; extension:_datatype 0..1 (Complex) Data type name for Ingredient.substance.strength.referenceStrength.substance from FHIR R4B URL: http://hl7.org/fhir/StructureDefinition/_datatype #xD; value[x] 1..1 string Value of extension Fixed Value: CodeableReference #xD; url 1..1 uri "substance" #xD; extension:strength[x] 1..1 Extension Strength expressed in terms of a reference substance #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:lowNumerator 0..1 Extension Low Numerator limit #xD; url 1..1 uri "lowNumerator" #xD; value[x] 0..1 SimpleQuantity(4.0.1) Low Numerator limit #xD; extension:highNumerator 0..1 Extension High Numerator limit #xD; url 1..1 uri "highNumerator" #xD; value[x] 0..1 SimpleQuantity(4.0.1) High Numerator limit #xD; extension:denominator 0..1 Extension Denominator value #xD; url 1..1 uri "denominator" #xD; value[x] 0..1 SimpleQuantity(4.0.1) Denominator value #xD; extension:_datatype 0..1 (Complex) Data type name for Ingredient.substance.strength.referenceStrength.strength[x] from FHIR R4B URL: http://hl7.org/fhir/StructureDefinition/_datatype #xD; value[x] 1..1 string Value of extension Fixed Value: RatioRange #xD; url 1..1 uri "strength[x]" #xD; value[x] 0..1 Ratio Strength expressed in terms of a reference substance #xD; extension:measurementPoint 0..1 Extension When strength is measured at a particular point or distance #xD; url 1..1 uri "measurementPoint" #xD; value[x] 0..1 string When strength is measured at a particular point or distance #xD; extension:country 0..* Extension Where the strength range applies #xD; url 1..1 uri "country" #xD; value[x] 0..1 CodeableConcept Where the strength range applies Binding: R4B_country_for_R4 (0.0.1-snapshot-2) (example): Jurisdiction codes #xD; url 1..1 uri "referenceStrength" #xD; url 1..1 uri "strength" #xD; url 1..1 uri "substance" #xD; url 1..1 uri "http://hl7.org/fhir/4.3/StructureDefinition/extension-Ingredient" #xD; Documentation for this format
Cross-version Extension for R4B.Ingredient for use in FHIR R4
This cross-version extension represents Ingredient from http://hl7.org/fhir/StructureDefinition/Ingredient|4.3.0 for use in FHIR R4.
An ingredient of a manufactured item or pharmaceutical product
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
The status of this ingredient. Enables tracking the life-cycle of the content.
Additional content defined by implementations
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.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
The product which this ingredient is a constituent part of
This cross-version extension represents Ingredient.for from http://hl7.org/fhir/StructureDefinition/Ingredient|4.3.0 for use in FHIR R4.
Purpose of the ingredient within the product, e.g. active, inactive
A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.
Precise action within the drug product, e.g. antioxidant, alkalizing agent
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.
A classification of the ingredient identifying its precise purpose(s) in the drug product (beyond e.g. active/inactive).
If the ingredient is a known or suspected allergen
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.
An organization that manufactures this ingredient
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.
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.
The way in which this manufacturer is associated with the ingredient.
This cross-version extension represents Ingredient.manufacturer.manufacturer from http://hl7.org/fhir/StructureDefinition/Ingredient|4.3.0 for use in FHIR R4.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
The substance that comprises this ingredient
This cross-version extension represents Ingredient.substance from http://hl7.org/fhir/StructureDefinition/Ingredient|4.3.0 for use in FHIR R4.
A code or full resource that represents the ingredient substance
A code or full resource that represents the ingredient's substance.
A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.
A reference to a resource the provides exact details about the information being referenced.
Data type name for Ingredient.substance.code from FHIR R4B
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).
The quantity of substance, per presentation, or per volume or mass, and type of quantity
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.
The quantity of substance in the unit of presentation
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').
Data type name for Ingredient.substance.strength.presentation[x] from FHIR R4B
Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio)
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.
The strength per unitary volume (or mass)
This cross-version extension represents Ingredient.substance.strength.concentration[x] from http://hl7.org/fhir/StructureDefinition/Ingredient|4.3.0 for use in FHIR R4.
Data type name for Ingredient.substance.strength.concentration[x] from FHIR R4B
Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio)
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.
When strength is measured at a particular point or distance
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.
The country or countries for which the strength range applies.
Strength expressed in terms of a reference substance
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.
This cross-version extension represents Ingredient.substance.strength.referenceStrength.substance from http://hl7.org/fhir/StructureDefinition/Ingredient|4.3.0 for use in FHIR R4.
Data type name for Ingredient.substance.strength.referenceStrength.substance from FHIR R4B
This cross-version extension represents Ingredient.substance.strength.referenceStrength.strength[x] from http://hl7.org/fhir/StructureDefinition/Ingredient|4.3.0 for use in FHIR R4.
Data type name for Ingredient.substance.strength.referenceStrength.strength[x] from FHIR R4B
For when strength is measured at a particular point or distance.