Ingredient
An ingredient of a manufactured item or pharmaceutical product.
Endpoints
dev
https://api.sandbox.ovok.com/fhir/R5/Ingredient| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/Ingredient/[id] |
| Vread | GET | /fhir/R5/Ingredient/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/Ingredient/[id] |
| Patch | PATCH | /fhir/R5/Ingredient/[id] |
| Delete | DELETE | /fhir/R5/Ingredient/[id] |
| Create | POST | /fhir/R5/Ingredient |
| Search | GET | /fhir/R5/Ingredient?... |
| History | GET | /fhir/R5/Ingredient/[id]/_history |
| Type-history | GET | /fhir/R5/Ingredient/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
identifier | Identifier | 0..1 | An identifier or code by which the ingredient can be referenced |
status | code | 1..1 | draft |
for | Reference | 0..* | The product which this ingredient is a constituent part of |
role | CodeableConcept | 1..1 | Purpose of the ingredient within the product, e.g. active, inactive |
function | CodeableConcept | 0..* | Precise action within the drug product, e.g. antioxidant, alkalizing agent |
group | CodeableConcept | 0..1 | 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 |
allergenicIndicator | boolean | 0..1 | If the ingredient is a known or suspected allergen |
comment | markdown | 0..1 | A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying |
manufacturer | BackboneElement | 0..* | An organization that manufactures this ingredient |
substance | BackboneElement | 1..1 | The substance that comprises this ingredient |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
for | reference | The product which this ingredient is a constituent part of |
function | token | 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 |
identifier | token | An identifier or code by which the ingredient can be referenced |
manufacturer | reference | The organization that manufactures this ingredient |
role | token | A classification of the ingredient identifying its purpose within the product, e.g. active, inactive |
status | token | The status of this ingredient. Enables tracking the life-cycle of the content |
strength-concentration-quantity | quantity | Ingredient concentration strength as quantity |
strength-concentration-ratio | composite | Ingredient concentration strength as ratio, numerator and denominator parameter pair |
strength-presentation-quantity | quantity | Ingredient presentation strength as quantity |
strength-presentation-ratio | composite | Ingredient presentation strength as ratio, numerator and denominator parameter pair |
substance | reference | Reference to a resource (by instance) |
substance-code | token | Reference to a concept (by class) |
substance-definition | reference | Reference to a resource (by instance) |
Reference
- Official FHIR R5 spec:
Ingredient - Maturity: Trial Use 2 (FMM 2).