Skip to main content

Ingredient

Trial Use 2 Specialized — Medication Definition

An ingredient of a manufactured item or pharmaceutical product.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Ingredient
InteractionMethodPath
ReadGET/fhir/R5/Ingredient/[id]
VreadGET/fhir/R5/Ingredient/[id]/_history/[vid]
UpdatePUT/fhir/R5/Ingredient/[id]
PatchPATCH/fhir/R5/Ingredient/[id]
DeleteDELETE/fhir/R5/Ingredient/[id]
CreatePOST/fhir/R5/Ingredient
SearchGET/fhir/R5/Ingredient?...
HistoryGET/fhir/R5/Ingredient/[id]/_history
Type-historyGET/fhir/R5/Ingredient/_history

Top-level elements

ElementType(s)CardinalityDescription
identifierIdentifier0..1An identifier or code by which the ingredient can be referenced
statuscode1..1draft
forReference0..*The product which this ingredient is a constituent part of
roleCodeableConcept1..1Purpose of the ingredient within the product, e.g. active, inactive
functionCodeableConcept0..*Precise action within the drug product, e.g. antioxidant, alkalizing agent
groupCodeableConcept0..1A 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
allergenicIndicatorboolean0..1If the ingredient is a known or suspected allergen
commentmarkdown0..1A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying
manufacturerBackboneElement0..*An organization that manufactures this ingredient
substanceBackboneElement1..1The substance that comprises this ingredient

Resource-specific search parameters

ParameterTypeDescription
forreferenceThe product which this ingredient is a constituent part of
functiontokenA 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
identifiertokenAn identifier or code by which the ingredient can be referenced
manufacturerreferenceThe organization that manufactures this ingredient
roletokenA classification of the ingredient identifying its purpose within the product, e.g. active, inactive
statustokenThe status of this ingredient. Enables tracking the life-cycle of the content
strength-concentration-quantityquantityIngredient concentration strength as quantity
strength-concentration-ratiocompositeIngredient concentration strength as ratio, numerator and denominator parameter pair
strength-presentation-quantityquantityIngredient presentation strength as quantity
strength-presentation-ratiocompositeIngredient presentation strength as ratio, numerator and denominator parameter pair
substancereferenceReference to a resource (by instance)
substance-codetokenReference to a concept (by class)
substance-definitionreferenceReference to a resource (by instance)

Reference

  • Official FHIR R5 spec: Ingredient
  • Maturity: Trial Use 2 (FMM 2).