15.8.9 JSON Schema for Ingredient

Biomedical Research and Regulation Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Not linked to any defined compartments

This is a representation of the json schema for Ingredient, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/Ingredient",
  "$ref": "#/definitions/Ingredient",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "Ingredient": {
      "description": "An ingredient of a manufactured item or pharmaceutical product.",
      "properties": {
        "resourceType": {
          "description": "This is a Ingredient resource",
          "const": "Ingredient"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "id.schema.json#/definitions/id"
        },
        "meta": {
          "description": "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.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "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.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "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.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "identifier": {
          "description": "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.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "status": {
          "description": "The status of this ingredient. Enables tracking the life-cycle of the content.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "for": {
          "description": "The product which this ingredient is a constituent part of.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "role": {
          "description": "A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "function": {
          "description": "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.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "group": {
          "description": "A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "allergenicIndicator": {
          "description": "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.",
          "$ref": "#/definitions/boolean"
        },
        "_allergenicIndicator": {
          "description": "Extensions for allergenicIndicator",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "manufacturer": {
          "description": "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.",
          "items": {
            "$ref": "#/definitions/Ingredient_Manufacturer"
          },
          "type": "array"
        },
        "substance": {
          "description": "The substance that comprises this ingredient.",
          "$ref": "#/definitions/Ingredient_Substance"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "role",
        "substance",
        "resourceType"
      ]
    },
    "Ingredient_Manufacturer": {
      "description": "An ingredient of a manufactured item or pharmaceutical product.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "role": {
          "description": "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.",
          "$ref": "#/definitions/code"
        },
        "_role": {
          "description": "Extensions for role",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "manufacturer": {
          "description": "An organization that manufactures this ingredient.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "manufacturer"
      ]
    },
    "Ingredient_Substance": {
      "description": "An ingredient of a manufactured item or pharmaceutical product.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "code": {
          "description": "A code or full resource that represents the ingredient\u0027s substance.",
          "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
        },
        "strength": {
          "description": "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.",
          "items": {
            "$ref": "#/definitions/Ingredient_Strength"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "code"
      ]
    },
    "Ingredient_Strength": {
      "description": "An ingredient of a manufactured item or pharmaceutical product.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "presentationRatio": {
          "description": "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 \u0027per 20mg\u0027 (the size of the tablet). It is not generally normalized as a unitary unit, which would be \u0027per mg\u0027).",
          "$ref": "Ratio.schema.json#/definitions/Ratio"
        },
        "presentationRatioRange": {
          "description": "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 \u0027per 20mg\u0027 (the size of the tablet). It is not generally normalized as a unitary unit, which would be \u0027per mg\u0027).",
          "$ref": "RatioRange.schema.json#/definitions/RatioRange"
        },
        "presentationCodeableConcept": {
          "description": "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 \u0027per 20mg\u0027 (the size of the tablet). It is not generally normalized as a unitary unit, which would be \u0027per mg\u0027).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "presentationQuantity": {
          "description": "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 \u0027per 20mg\u0027 (the size of the tablet). It is not generally normalized as a unitary unit, which would be \u0027per mg\u0027).",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "textPresentation": {
          "description": "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.",
          "$ref": "#/definitions/string"
        },
        "_textPresentation": {
          "description": "Extensions for textPresentation",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "concentrationRatio": {
          "description": "The strength per unitary volume (or mass).",
          "$ref": "Ratio.schema.json#/definitions/Ratio"
        },
        "concentrationRatioRange": {
          "description": "The strength per unitary volume (or mass).",
          "$ref": "RatioRange.schema.json#/definitions/RatioRange"
        },
        "concentrationCodeableConcept": {
          "description": "The strength per unitary volume (or mass).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "concentrationQuantity": {
          "description": "The strength per unitary volume (or mass).",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "textConcentration": {
          "description": "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.",
          "$ref": "#/definitions/string"
        },
        "_textConcentration": {
          "description": "Extensions for textConcentration",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "basis": {
          "description": "A 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).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "measurementPoint": {
          "description": "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.",
          "$ref": "#/definitions/string"
        },
        "_measurementPoint": {
          "description": "Extensions for measurementPoint",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "country": {
          "description": "The country or countries for which the strength range applies.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "referenceStrength": {
          "description": "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.",
          "items": {
            "$ref": "#/definitions/Ingredient_ReferenceStrength"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false
    },
    "Ingredient_ReferenceStrength": {
      "description": "An ingredient of a manufactured item or pharmaceutical product.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "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.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "substance": {
          "description": "Relevant reference substance.",
          "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
        },
        "strengthRatio": {
          "description": "Strength expressed in terms of a reference substance.",
          "$ref": "Ratio.schema.json#/definitions/Ratio"
        },
        "strengthRatioRange": {
          "description": "Strength expressed in terms of a reference substance.",
          "$ref": "RatioRange.schema.json#/definitions/RatioRange"
        },
        "strengthQuantity": {
          "description": "Strength expressed in terms of a reference substance.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "measurementPoint": {
          "description": "For when strength is measured at a particular point or distance.",
          "$ref": "#/definitions/string"
        },
        "_measurementPoint": {
          "description": "Extensions for measurementPoint",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "country": {
          "description": "The country or countries for which the strength range applies.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  }
}