Skip to main content

Product Knowledge

Summary

This resource stores all foundational information about a given product, foundational information is anything need not be duplicated across different individual products, ie ingredient lists, possible allergens, nutritional information and so on..

All Products will have a Product Knowledge item in Care.

Production Knowledge can be instance or facility level.

Key Purpose

  • Define comprehensive, facility-wide information about products.
  • Standardize product data across different batches and instances.
  • Facilitate integration with FHIR resources for interoperability.
  • Support inventory management, prescribing, and dispensing processes.

Core Data Structure – Essential Fields

  • facility: Reference to the facility where the product is available (nullable).
  • slug: A URL-friendly identifier for the product.
  • status: Current status of the product knowledge entry (e.g., draft, active, retired, unknown).
  • product_type: Type of product (e.g., Medication, NutritionProduct, Consumable).
  • code: A code representing the product, with the value set depending on the product type.
  • name: The primary name of the product.
  • base_unit: The unit in which the product is measured or dispensed.
  • names: A list of alternative names for the product, each with a specified name type.
  • storage_guidelines: Instructions for storing the product, including notes, stability duration, and environmental settings.
  • definition: Detailed information about the product's form, intended route(s) of administration, ingredients, nutrients, and drug characteristics.

Core Relationships

FieldReference ResourceDescription
facilityOrganizationThe facility where the product is available.
codeCodeSystemThe coding system used to identify the product.
names.name_typeValueSetThe type of name, bound to InventoryItem Name Type.
definition.dose_formValueSetThe form of the medication, bound to Medication Form Codes.
definition.intended_routeValueSetThe intended route(s) of administration, bound to Route Codes.
definition.ingredients.substanceSubstanceThe substance(s) that make up the product.
definition.drug_characteristic.typeValueSetThe type of drug characteristic, bound to Medication Knowledge Characteristic.

Supported Fields

Field NameTypeDescription
facilityReferenceReference to the facility (nullable).
slugstringURL-friendly identifier for the product.
statuscodeStatus of the product knowledge entry.
product_typecodeType of product (e.g., Medication, NutritionProduct, Consumable).
codeCodeableConceptCode representing the product.
namestringPrimary name of the product.
base_unitCodeableConceptUnit in which the product is measured or dispensed.
namesListAlternative names for the product.
names.name_typecodeType of name (e.g., trade name, brand name).
names.namestringThe alternative name.
storage_guidelinesListStorage instructions for the product.
storage_guidelines.notestringAdditional notes on storage.
storage_guidelines.stability_durationDurationDuration for which the product remains stable.
storage_guidelines.environmental_settingListEnvironmental conditions for storage.
storage_guidelines.environmental_setting.typecodeType of environmental condition.
storage_guidelines.environmental_setting.valuestringValue of the environmental condition.
definitionBackboneElementDetailed definition of the product.
definition.dose_formCodeableConceptForm of the medication.
definition.intended_routeListIntended route(s) of administration.
definition.ingredientsListIngredients of the product.
definition.ingredients.is_activebooleanIndicates if the ingredient is active.
definition.ingredients.substanceCodeableConceptSubstance that makes up the ingredient.
definition.ingredients.strengthBackboneElementStrength information of the ingredient.
definition.ingredients.strength.strength_ratioRatioStrength ratio of the ingredient.
definition.ingredients.strength.strength_quantityQuantityStrength quantity of the ingredient.
definition.nutrientsListNutritional components of the product.
definition.drug_characteristicListCharacteristics of the drug.
definition.drug_characteristic.typeCodeableConceptType of drug characteristic.
definition.drug_characteristic.valuestringValue of the drug characteristic.

Functional Workflow

  1. Creation: A Product Knowledge entry is created with comprehensive details about a product, including its classification, composition, and storage guidelines.
  2. Reference: Individual Product instances reference the Product Knowledge entry, inheriting its general attributes while specifying batch-specific details.
  3. Integration: The Product Knowledge resource integrates with FHIR resources like MedicationKnowledge and NutritionProduct, facilitating interoperability across systems.
  4. Maintenance: Updates to product information, such as changes in composition or storage guidelines, are made within the Product Knowledge resource, ensuring consistency across all related Product instances.