Pharmaceutical Quality Submissions to Food & Drug Administration (PQ/CMC)
0.1.20 - Build CI United States of America flag

Pharmaceutical Quality Submissions to Food & Drug Administration (PQ/CMC), published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.20 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/FHIR-us-pq-cmc/ and changes regularly. See the Directory of published versions

Resource Profile: Drug Product Component

Official URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-component Version: 0.1.20
Draft as of 2024-03-04 Computable Name: DrugProductComponent

The amount details about the drug product components to define the product composition in a product unit. Use composition.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Ingredient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient Ingredient
... meta
.... profile S0..1canonical(StructureDefinition)Profiles this resource claims to conform to
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... additional-info S0..1markdownDrug Product Component Additional Information
URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-additional-info-extension
... role 1..1CodeableConceptPurpose of the ingredient within the product, e.g. active, inactive
Binding: Drug Product Component Function Category Terminology (required)
... substance C1..1BackboneElementThe substance that comprises this ingredient
cmc-strength-type-cases1: IF Strength Type = Mass THEN Strength Numeric and Strength UOM are Mandatory
cmc-strength-type-cases2: IF Strength Type = Activity THEN Strength Textual, Strength UOM ([arb'U]) and Strength Operator are applicable data elements. Strength Textual and Strength UOM will be Mandatory and Operator will be Optional. Codes 75765 [arb'U]; C45420 Activity.
.... code S1..1CodeableReference(Component Substance)Ingredient Substance
.... strength S1..1BackboneElementThe quantity of substance, per presentation, or per volume or mass, and type of quantity
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... strengthFactors S1..1(Complex)Strength Extension
URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension
..... Slices for presentation[x] S1..1The quantity of substance in the unit of presentation
Slice: Unordered, Open by type:$this
...... presentationRatioRatio
...... presentationQuantityQuantity
...... presentation[x]:presentationRatio S0..1RatioThe quantity of substance in the unit of presentation
....... numerator S1..1QuantityNumerator value
........ value S1..1decimalProduct Ingredient Amount Numeric Numerator
........ unit S1..1stringProduct Ingredient Amount Numeric Numerator UOM
........ code S1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
....... denominator S1..1SimpleQuantityDenominator value
........ value S1..1decimalProduct Ingredient Amount Numeric Denominator
........ unit S1..1stringUnit representation
........ code S1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
...... presentation[x]:presentationQuantity S0..1QuantityThe quantity of substance in the unit of presentation
....... value S1..1decimalProduct Ingredient Amount Numeric
....... unit 1..1stringUnit representation
....... code 1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
..... textPresentation S1..1stringStrength Textual

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Ingredient.rolerequiredPqcmcDrugProductComponentFunctionCategoryTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-drug-product-component-function-category-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationRatio.numerator.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationRatio.denominator.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationQuantity.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG

Constraints

IdGradePath(s)DetailsRequirements
cmc-strength-type-cases1errorIngredient.substanceIF Strength Type = Mass THEN Strength Numeric and Strength UOM are Mandatory
: strength.extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthType').value.where(value = 'C168628').exists() implies strength.ofType(Ratio).exists() or ((strength.ofType(Quantity).exists() and strength.ofType(Quantity).extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthOperator').exists().not()))
cmc-strength-type-cases2errorIngredient.substanceIF Strength Type = Activity THEN Strength Textual, Strength UOM ([arb'U]) and Strength Operator are applicable data elements. Strength Textual and Strength UOM will be Mandatory and Operator will be Optional. Codes 75765 [arb'U]; C45420 Activity.
: strength.extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthType').value.where(value = 'C45420').exists() implies ((strength.ofType(Ratio).exists() and strength.ofType(Ratio).numerator.code = 'C75765').exists()) or ((strength.ofType(Quantity).exists() and strength.ofType(Quantity).code = 'C75765' ).exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C0..*IngredientAn ingredient of a manufactured item or pharmaceutical product
ing-1: If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
... meta Σ0..1MetaMetadata about the resource
.... profile SΣ0..1canonical(StructureDefinition)Profiles this resource claims to conform to
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... additional-info S0..1markdownDrug Product Component Additional Information
URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-additional-info-extension
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... for Σ0..*Reference(MedicinalProductDefinition | AdministrableProductDefinition | ManufacturedItemDefinition)Reference to MedicinalProductDefinition
... role Σ1..1CodeableConceptPurpose of the ingredient within the product, e.g. active, inactive
Binding: Drug Product Component Function Category Terminology (required)
... substance ΣC1..1BackboneElementThe substance that comprises this ingredient
cmc-strength-type-cases1: IF Strength Type = Mass THEN Strength Numeric and Strength UOM are Mandatory
cmc-strength-type-cases2: IF Strength Type = Activity THEN Strength Textual, Strength UOM ([arb'U]) and Strength Operator are applicable data elements. Strength Textual and Strength UOM will be Mandatory and Operator will be Optional. Codes 75765 [arb'U]; C45420 Activity.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣC1..1CodeableReference(Component Substance)Ingredient Substance
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

.... strength SΣ1..1BackboneElementThe quantity of substance, per presentation, or per volume or mass, and type of quantity
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... strengthFactors S1..1(Complex)Strength Extension
URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Slices for presentation[x] SΣ1..1The quantity of substance in the unit of presentation
Slice: Unordered, Closed by type:$this
...... presentationRatioRatio
...... presentationQuantityQuantity
...... presentation[x]:presentationRatio SΣ0..1RatioThe quantity of substance in the unit of presentation
....... numerator SΣC1..1QuantityNumerator value
........ value SΣ1..1decimalProduct Ingredient Amount Numeric Numerator
........ comparator ?!Σ0..1code< | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

........ unit SΣ1..1stringProduct Ingredient Amount Numeric Numerator UOM
........ code SΣC1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
....... denominator SΣC1..1SimpleQuantityDenominator value
........ value SΣ1..1decimalProduct Ingredient Amount Numeric Denominator
........ unit SΣ1..1stringUnit representation
........ code SΣC1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
...... presentation[x]:presentationQuantity SΣ0..1QuantityThe quantity of substance in the unit of presentation
....... value SΣ1..1decimalProduct Ingredient Amount Numeric
....... comparator ?!Σ0..1code< | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

....... unit Σ1..1stringUnit representation
....... code ΣC1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
..... textPresentation SΣ1..1stringStrength Textual

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Ingredient.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Ingredient.rolerequiredPqcmcDrugProductComponentFunctionCategoryTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-drug-product-component-function-category-terminology
from this IG
Ingredient.substance.codeexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard
Ingredient.substance.strength.presentation[x]:presentationRatio.numerator.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
Ingredient.substance.strength.presentation[x]:presentationRatio.numerator.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationRatio.denominator.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
Ingredient.substance.strength.presentation[x]:presentationQuantity.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG

Constraints

IdGradePath(s)DetailsRequirements
cmc-strength-type-cases1errorIngredient.substanceIF Strength Type = Mass THEN Strength Numeric and Strength UOM are Mandatory
: strength.extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthType').value.where(value = 'C168628').exists() implies strength.ofType(Ratio).exists() or ((strength.ofType(Quantity).exists() and strength.ofType(Quantity).extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthOperator').exists().not()))
cmc-strength-type-cases2errorIngredient.substanceIF Strength Type = Activity THEN Strength Textual, Strength UOM ([arb'U]) and Strength Operator are applicable data elements. Strength Textual and Strength UOM will be Mandatory and Operator will be Optional. Codes 75765 [arb'U]; C45420 Activity.
: strength.extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthType').value.where(value = 'C45420').exists() implies ((strength.ofType(Ratio).exists() and strength.ofType(Ratio).numerator.code = 'C75765').exists()) or ((strength.ofType(Quantity).exists() and strength.ofType(Quantity).code = 'C75765' ).exists())
dom-2errorIngredientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorIngredientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorIngredientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorIngredientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceIngredientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ing-1errorIngredientIf an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
: Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C0..*IngredientAn ingredient of a manufactured item or pharmaceutical product
ing-1: If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ0..1canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... additional-info S0..1markdownDrug Product Component Additional Information
URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-additional-info-extension
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierAn identifier or code by which the ingredient can be referenced
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... for Σ0..*Reference(MedicinalProductDefinition | AdministrableProductDefinition | ManufacturedItemDefinition)Reference to MedicinalProductDefinition
... role Σ1..1CodeableConceptPurpose of the ingredient within the product, e.g. active, inactive
Binding: Drug Product Component Function Category Terminology (required)
... function Σ0..*CodeableConceptPrecise action within the drug product, e.g. antioxidant, alkalizing agent
Binding: IngredientFunction (example): A classification of the ingredient identifying its precise purpose(s) in the drug product (beyond e.g. active/inactive).


... group Σ0..1CodeableConceptA 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 ΣC0..1booleanIf the ingredient is a known or suspected allergen
... comment 0..1markdownA place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying
... manufacturer Σ0..*BackboneElementAn organization that manufactures this ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ0..1codeallowed | possible | actual
Binding: IngredientManufacturerRole (required): The way in which this manufacturer is associated with the ingredient.

.... manufacturer Σ1..1Reference(Organization)An organization that manufactures this ingredient
... substance ΣC1..1BackboneElementThe substance that comprises this ingredient
cmc-strength-type-cases1: IF Strength Type = Mass THEN Strength Numeric and Strength UOM are Mandatory
cmc-strength-type-cases2: IF Strength Type = Activity THEN Strength Textual, Strength UOM ([arb'U]) and Strength Operator are applicable data elements. Strength Textual and Strength UOM will be Mandatory and Operator will be Optional. Codes 75765 [arb'U]; C45420 Activity.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣC1..1CodeableReference(Component Substance)Ingredient Substance
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

.... strength SΣ1..1BackboneElementThe quantity of substance, per presentation, or per volume or mass, and type of quantity
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... strengthFactors S1..1(Complex)Strength Extension
URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Slices for presentation[x] SΣ1..1The quantity of substance in the unit of presentation
Slice: Unordered, Closed by type:$this
...... presentationRatioRatio
...... presentationQuantityQuantity
...... presentation[x]:presentationRatio SΣ0..1RatioThe quantity of substance in the unit of presentation
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... numerator SΣC1..1QuantityNumerator value
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ value SΣ1..1decimalProduct Ingredient Amount Numeric Numerator
........ comparator ?!Σ0..1code< | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

........ unit SΣ1..1stringProduct Ingredient Amount Numeric Numerator UOM
........ system ΣC0..1uriSystem that defines coded unit form
........ code SΣC1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
....... denominator SΣC1..1SimpleQuantityDenominator value
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ value SΣ1..1decimalProduct Ingredient Amount Numeric Denominator
........ unit SΣ1..1stringUnit representation
........ system ΣC0..1uriSystem that defines coded unit form
........ code SΣC1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
...... presentation[x]:presentationQuantity SΣ0..1QuantityThe quantity of substance in the unit of presentation
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... value SΣ1..1decimalProduct Ingredient Amount Numeric
....... comparator ?!Σ0..1code< | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

....... unit Σ1..1stringUnit representation
....... system ΣC0..1uriSystem that defines coded unit form
....... code ΣC1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
..... textPresentation SΣ1..1stringStrength Textual
..... concentration[x] Σ0..1The strength per unitary volume (or mass)
...... concentrationRatioRatio
...... concentrationRatioRangeRatioRange
...... concentrationCodeableConceptCodeableConcept
...... concentrationQuantityQuantity
..... textConcentration Σ0..1stringText of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio)
..... basis Σ0..1CodeableConceptA code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt)
..... measurementPoint Σ0..1stringWhen strength is measured at a particular point or distance
..... country Σ0..*CodeableConceptWhere the strength range applies
Binding: CountryValueSet (example): Jurisdiction codes


..... referenceStrength Σ0..*BackboneElementStrength expressed in terms of a reference substance
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... substance Σ1..1CodeableReference(SubstanceDefinition)Relevant reference substance
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

...... strength[x] Σ1..1Strength expressed in terms of a reference substance
....... strengthRatioRatio
....... strengthRatioRangeRatioRange
....... strengthQuantityQuantity
...... measurementPoint Σ0..1stringWhen strength is measured at a particular point or distance
...... country Σ0..*CodeableConceptWhere the strength range applies
Binding: CountryValueSet (example): Jurisdiction codes



doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Ingredient.meta.securityextensibleAllSecurityLabels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Ingredient.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Ingredient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Ingredient.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Ingredient.rolerequiredPqcmcDrugProductComponentFunctionCategoryTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-drug-product-component-function-category-terminology
from this IG
Ingredient.functionexampleIngredientFunction
http://hl7.org/fhir/ValueSet/ingredient-function
from the FHIR Standard
Ingredient.manufacturer.rolerequiredIngredientManufacturerRole
http://hl7.org/fhir/ValueSet/ingredient-manufacturer-role|5.0.0
from the FHIR Standard
Ingredient.substance.codeexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard
Ingredient.substance.strength.presentation[x]:presentationRatio.numerator.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
Ingredient.substance.strength.presentation[x]:presentationRatio.numerator.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationRatio.denominator.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
Ingredient.substance.strength.presentation[x]:presentationQuantity.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.countryexampleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
Ingredient.substance.strength.referenceStrength.substanceexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard
Ingredient.substance.strength.referenceStrength.countryexampleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmc-strength-type-cases1errorIngredient.substanceIF Strength Type = Mass THEN Strength Numeric and Strength UOM are Mandatory
: strength.extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthType').value.where(value = 'C168628').exists() implies strength.ofType(Ratio).exists() or ((strength.ofType(Quantity).exists() and strength.ofType(Quantity).extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthOperator').exists().not()))
cmc-strength-type-cases2errorIngredient.substanceIF Strength Type = Activity THEN Strength Textual, Strength UOM ([arb'U]) and Strength Operator are applicable data elements. Strength Textual and Strength UOM will be Mandatory and Operator will be Optional. Codes 75765 [arb'U]; C45420 Activity.
: strength.extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthType').value.where(value = 'C45420').exists() implies ((strength.ofType(Ratio).exists() and strength.ofType(Ratio).numerator.code = 'C75765').exists()) or ((strength.ofType(Quantity).exists() and strength.ofType(Quantity).code = 'C75765' ).exists())
dom-2errorIngredientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorIngredientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorIngredientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorIngredientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceIngredientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ing-1errorIngredientIf an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
: Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2

This structure is derived from Ingredient

Summary

Mandatory: 5 elements (11 nested mandatory elements)
Must-Support: 18 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Ingredient.substance.strength.presentation[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Ingredient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient Ingredient
... meta
.... profile S0..1canonical(StructureDefinition)Profiles this resource claims to conform to
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... additional-info S0..1markdownDrug Product Component Additional Information
URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-additional-info-extension
... role 1..1CodeableConceptPurpose of the ingredient within the product, e.g. active, inactive
Binding: Drug Product Component Function Category Terminology (required)
... substance C1..1BackboneElementThe substance that comprises this ingredient
cmc-strength-type-cases1: IF Strength Type = Mass THEN Strength Numeric and Strength UOM are Mandatory
cmc-strength-type-cases2: IF Strength Type = Activity THEN Strength Textual, Strength UOM ([arb'U]) and Strength Operator are applicable data elements. Strength Textual and Strength UOM will be Mandatory and Operator will be Optional. Codes 75765 [arb'U]; C45420 Activity.
.... code S1..1CodeableReference(Component Substance)Ingredient Substance
.... strength S1..1BackboneElementThe quantity of substance, per presentation, or per volume or mass, and type of quantity
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... strengthFactors S1..1(Complex)Strength Extension
URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension
..... Slices for presentation[x] S1..1The quantity of substance in the unit of presentation
Slice: Unordered, Open by type:$this
...... presentationRatioRatio
...... presentationQuantityQuantity
...... presentation[x]:presentationRatio S0..1RatioThe quantity of substance in the unit of presentation
....... numerator S1..1QuantityNumerator value
........ value S1..1decimalProduct Ingredient Amount Numeric Numerator
........ unit S1..1stringProduct Ingredient Amount Numeric Numerator UOM
........ code S1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
....... denominator S1..1SimpleQuantityDenominator value
........ value S1..1decimalProduct Ingredient Amount Numeric Denominator
........ unit S1..1stringUnit representation
........ code S1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
...... presentation[x]:presentationQuantity S0..1QuantityThe quantity of substance in the unit of presentation
....... value S1..1decimalProduct Ingredient Amount Numeric
....... unit 1..1stringUnit representation
....... code 1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
..... textPresentation S1..1stringStrength Textual

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Ingredient.rolerequiredPqcmcDrugProductComponentFunctionCategoryTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-drug-product-component-function-category-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationRatio.numerator.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationRatio.denominator.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationQuantity.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG

Constraints

IdGradePath(s)DetailsRequirements
cmc-strength-type-cases1errorIngredient.substanceIF Strength Type = Mass THEN Strength Numeric and Strength UOM are Mandatory
: strength.extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthType').value.where(value = 'C168628').exists() implies strength.ofType(Ratio).exists() or ((strength.ofType(Quantity).exists() and strength.ofType(Quantity).extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthOperator').exists().not()))
cmc-strength-type-cases2errorIngredient.substanceIF Strength Type = Activity THEN Strength Textual, Strength UOM ([arb'U]) and Strength Operator are applicable data elements. Strength Textual and Strength UOM will be Mandatory and Operator will be Optional. Codes 75765 [arb'U]; C45420 Activity.
: strength.extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthType').value.where(value = 'C45420').exists() implies ((strength.ofType(Ratio).exists() and strength.ofType(Ratio).numerator.code = 'C75765').exists()) or ((strength.ofType(Quantity).exists() and strength.ofType(Quantity).code = 'C75765' ).exists())

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C0..*IngredientAn ingredient of a manufactured item or pharmaceutical product
ing-1: If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
... meta Σ0..1MetaMetadata about the resource
.... profile SΣ0..1canonical(StructureDefinition)Profiles this resource claims to conform to
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... additional-info S0..1markdownDrug Product Component Additional Information
URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-additional-info-extension
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... for Σ0..*Reference(MedicinalProductDefinition | AdministrableProductDefinition | ManufacturedItemDefinition)Reference to MedicinalProductDefinition
... role Σ1..1CodeableConceptPurpose of the ingredient within the product, e.g. active, inactive
Binding: Drug Product Component Function Category Terminology (required)
... substance ΣC1..1BackboneElementThe substance that comprises this ingredient
cmc-strength-type-cases1: IF Strength Type = Mass THEN Strength Numeric and Strength UOM are Mandatory
cmc-strength-type-cases2: IF Strength Type = Activity THEN Strength Textual, Strength UOM ([arb'U]) and Strength Operator are applicable data elements. Strength Textual and Strength UOM will be Mandatory and Operator will be Optional. Codes 75765 [arb'U]; C45420 Activity.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣC1..1CodeableReference(Component Substance)Ingredient Substance
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

.... strength SΣ1..1BackboneElementThe quantity of substance, per presentation, or per volume or mass, and type of quantity
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... strengthFactors S1..1(Complex)Strength Extension
URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Slices for presentation[x] SΣ1..1The quantity of substance in the unit of presentation
Slice: Unordered, Closed by type:$this
...... presentationRatioRatio
...... presentationQuantityQuantity
...... presentation[x]:presentationRatio SΣ0..1RatioThe quantity of substance in the unit of presentation
....... numerator SΣC1..1QuantityNumerator value
........ value SΣ1..1decimalProduct Ingredient Amount Numeric Numerator
........ comparator ?!Σ0..1code< | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

........ unit SΣ1..1stringProduct Ingredient Amount Numeric Numerator UOM
........ code SΣC1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
....... denominator SΣC1..1SimpleQuantityDenominator value
........ value SΣ1..1decimalProduct Ingredient Amount Numeric Denominator
........ unit SΣ1..1stringUnit representation
........ code SΣC1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
...... presentation[x]:presentationQuantity SΣ0..1QuantityThe quantity of substance in the unit of presentation
....... value SΣ1..1decimalProduct Ingredient Amount Numeric
....... comparator ?!Σ0..1code< | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

....... unit Σ1..1stringUnit representation
....... code ΣC1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
..... textPresentation SΣ1..1stringStrength Textual

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Ingredient.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Ingredient.rolerequiredPqcmcDrugProductComponentFunctionCategoryTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-drug-product-component-function-category-terminology
from this IG
Ingredient.substance.codeexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard
Ingredient.substance.strength.presentation[x]:presentationRatio.numerator.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
Ingredient.substance.strength.presentation[x]:presentationRatio.numerator.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationRatio.denominator.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
Ingredient.substance.strength.presentation[x]:presentationQuantity.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG

Constraints

IdGradePath(s)DetailsRequirements
cmc-strength-type-cases1errorIngredient.substanceIF Strength Type = Mass THEN Strength Numeric and Strength UOM are Mandatory
: strength.extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthType').value.where(value = 'C168628').exists() implies strength.ofType(Ratio).exists() or ((strength.ofType(Quantity).exists() and strength.ofType(Quantity).extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthOperator').exists().not()))
cmc-strength-type-cases2errorIngredient.substanceIF Strength Type = Activity THEN Strength Textual, Strength UOM ([arb'U]) and Strength Operator are applicable data elements. Strength Textual and Strength UOM will be Mandatory and Operator will be Optional. Codes 75765 [arb'U]; C45420 Activity.
: strength.extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthType').value.where(value = 'C45420').exists() implies ((strength.ofType(Ratio).exists() and strength.ofType(Ratio).numerator.code = 'C75765').exists()) or ((strength.ofType(Quantity).exists() and strength.ofType(Quantity).code = 'C75765' ).exists())
dom-2errorIngredientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorIngredientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorIngredientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorIngredientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceIngredientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ing-1errorIngredientIf an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
: Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ingredient C0..*IngredientAn ingredient of a manufactured item or pharmaceutical product
ing-1: If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ0..1canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... additional-info S0..1markdownDrug Product Component Additional Information
URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pq-additional-info-extension
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierAn identifier or code by which the ingredient can be referenced
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... for Σ0..*Reference(MedicinalProductDefinition | AdministrableProductDefinition | ManufacturedItemDefinition)Reference to MedicinalProductDefinition
... role Σ1..1CodeableConceptPurpose of the ingredient within the product, e.g. active, inactive
Binding: Drug Product Component Function Category Terminology (required)
... function Σ0..*CodeableConceptPrecise action within the drug product, e.g. antioxidant, alkalizing agent
Binding: IngredientFunction (example): A classification of the ingredient identifying its precise purpose(s) in the drug product (beyond e.g. active/inactive).


... group Σ0..1CodeableConceptA 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 ΣC0..1booleanIf the ingredient is a known or suspected allergen
... comment 0..1markdownA place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying
... manufacturer Σ0..*BackboneElementAn organization that manufactures this ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ0..1codeallowed | possible | actual
Binding: IngredientManufacturerRole (required): The way in which this manufacturer is associated with the ingredient.

.... manufacturer Σ1..1Reference(Organization)An organization that manufactures this ingredient
... substance ΣC1..1BackboneElementThe substance that comprises this ingredient
cmc-strength-type-cases1: IF Strength Type = Mass THEN Strength Numeric and Strength UOM are Mandatory
cmc-strength-type-cases2: IF Strength Type = Activity THEN Strength Textual, Strength UOM ([arb'U]) and Strength Operator are applicable data elements. Strength Textual and Strength UOM will be Mandatory and Operator will be Optional. Codes 75765 [arb'U]; C45420 Activity.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣC1..1CodeableReference(Component Substance)Ingredient Substance
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

.... strength SΣ1..1BackboneElementThe quantity of substance, per presentation, or per volume or mass, and type of quantity
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... strengthFactors S1..1(Complex)Strength Extension
URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... Slices for presentation[x] SΣ1..1The quantity of substance in the unit of presentation
Slice: Unordered, Closed by type:$this
...... presentationRatioRatio
...... presentationQuantityQuantity
...... presentation[x]:presentationRatio SΣ0..1RatioThe quantity of substance in the unit of presentation
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... numerator SΣC1..1QuantityNumerator value
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ value SΣ1..1decimalProduct Ingredient Amount Numeric Numerator
........ comparator ?!Σ0..1code< | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

........ unit SΣ1..1stringProduct Ingredient Amount Numeric Numerator UOM
........ system ΣC0..1uriSystem that defines coded unit form
........ code SΣC1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
....... denominator SΣC1..1SimpleQuantityDenominator value
........ id 0..1idUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ value SΣ1..1decimalProduct Ingredient Amount Numeric Denominator
........ unit SΣ1..1stringUnit representation
........ system ΣC0..1uriSystem that defines coded unit form
........ code SΣC1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
...... presentation[x]:presentationQuantity SΣ0..1QuantityThe quantity of substance in the unit of presentation
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... value SΣ1..1decimalProduct Ingredient Amount Numeric
....... comparator ?!Σ0..1code< | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

....... unit Σ1..1stringUnit representation
....... system ΣC0..1uriSystem that defines coded unit form
....... code ΣC1..1codeCoded form of the unit
Binding: Units Of Measure Terminology (required)
..... textPresentation SΣ1..1stringStrength Textual
..... concentration[x] Σ0..1The strength per unitary volume (or mass)
...... concentrationRatioRatio
...... concentrationRatioRangeRatioRange
...... concentrationCodeableConceptCodeableConcept
...... concentrationQuantityQuantity
..... textConcentration Σ0..1stringText of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio)
..... basis Σ0..1CodeableConceptA code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt)
..... measurementPoint Σ0..1stringWhen strength is measured at a particular point or distance
..... country Σ0..*CodeableConceptWhere the strength range applies
Binding: CountryValueSet (example): Jurisdiction codes


..... referenceStrength Σ0..*BackboneElementStrength expressed in terms of a reference substance
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... substance Σ1..1CodeableReference(SubstanceDefinition)Relevant reference substance
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

...... strength[x] Σ1..1Strength expressed in terms of a reference substance
....... strengthRatioRatio
....... strengthRatioRangeRatioRange
....... strengthQuantityQuantity
...... measurementPoint Σ0..1stringWhen strength is measured at a particular point or distance
...... country Σ0..*CodeableConceptWhere the strength range applies
Binding: CountryValueSet (example): Jurisdiction codes



doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Ingredient.meta.securityextensibleAllSecurityLabels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Ingredient.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Ingredient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Ingredient.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Ingredient.rolerequiredPqcmcDrugProductComponentFunctionCategoryTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-drug-product-component-function-category-terminology
from this IG
Ingredient.functionexampleIngredientFunction
http://hl7.org/fhir/ValueSet/ingredient-function
from the FHIR Standard
Ingredient.manufacturer.rolerequiredIngredientManufacturerRole
http://hl7.org/fhir/ValueSet/ingredient-manufacturer-role|5.0.0
from the FHIR Standard
Ingredient.substance.codeexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard
Ingredient.substance.strength.presentation[x]:presentationRatio.numerator.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
Ingredient.substance.strength.presentation[x]:presentationRatio.numerator.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationRatio.denominator.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.presentation[x]:presentationQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
Ingredient.substance.strength.presentation[x]:presentationQuantity.coderequiredPqcmcUnitsMeasureTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-units-of-measure-terminology
from this IG
Ingredient.substance.strength.countryexampleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
Ingredient.substance.strength.referenceStrength.substanceexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard
Ingredient.substance.strength.referenceStrength.countryexampleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmc-strength-type-cases1errorIngredient.substanceIF Strength Type = Mass THEN Strength Numeric and Strength UOM are Mandatory
: strength.extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthType').value.where(value = 'C168628').exists() implies strength.ofType(Ratio).exists() or ((strength.ofType(Quantity).exists() and strength.ofType(Quantity).extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthOperator').exists().not()))
cmc-strength-type-cases2errorIngredient.substanceIF Strength Type = Activity THEN Strength Textual, Strength UOM ([arb'U]) and Strength Operator are applicable data elements. Strength Textual and Strength UOM will be Mandatory and Operator will be Optional. Codes 75765 [arb'U]; C45420 Activity.
: strength.extension('http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/strength-extension').extension('strengthType').value.where(value = 'C45420').exists() implies ((strength.ofType(Ratio).exists() and strength.ofType(Ratio).numerator.code = 'C75765').exists()) or ((strength.ofType(Quantity).exists() and strength.ofType(Quantity).code = 'C75765' ).exists())
dom-2errorIngredientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorIngredientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorIngredientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorIngredientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceIngredientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ing-1errorIngredientIf an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
: Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2

This structure is derived from Ingredient

Summary

Mandatory: 5 elements (11 nested mandatory elements)
Must-Support: 18 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Ingredient.substance.strength.presentation[x] is sliced based on the value of type:$this

 

Other representations of profile: CSV, Excel, Schematron