MedicinalProductIngredient - FHIR Resource (r4)
This MedicinalProductIngredient Resource uses the FHIR API standard for access and structure.
Validate an MedicinalProductIngredient FHIR Resource (r4)
MedicinalProductIngredient Attributes
AttributeField is listTypeDescription
Description: Identifier for the ingredient
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (MedicinalProductIngredient) identifier FHIR attribute
Description: Ingredient role e.g. Active ingredient, excipient
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"role": {
"coding": [
{
"system": "http://ema.europa.eu/example/ingredientRole",
"code": "ActiveBase"
}
]
}Learn more about the (MedicinalProductIngredient) role FHIR attribute
Description: If the ingredient is a known or suspected allergen
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"allergenicIndicator": Learn more about the (MedicinalProductIngredient) allergenicIndicator FHIR attribute
Description: Manufacturer of this Ingredient
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"manufacturer": [
{
"reference": "Organization/example"
}
]Learn more about the (MedicinalProductIngredient) manufacturer FHIR attribute
Description: A specified substance that comprises this ingredient
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"specifiedSubstance": [
{
"code": {
"coding": [
{
"system": "http://ema.europa.eu/example/specifiedSubstance",
"code": "equixabanCompanyequixaban1"
}
]
},
"group": {
"coding": [
{
"system": "http://ema.europa.eu/example/specifiedSubstanceGroup",
"code": "2"
}
]
}
}
]Learn more about the (MedicinalProductIngredient) specifiedSubstance FHIR attribute
Description: Relevant reference substance
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"substance": {
"code": {
"coding": [
{
"system": "http://ema.europa.eu/example/substance",
"code": "EQUIXABAN"
}
]
},
"strength": [
{
"presentation": {
"numerator": {
"value": 2.5,
"unit": "mg"
},
"denominator": {
"value": 1,
"unit": "{tablet}"
}
}
}
]
}Learn more about the (MedicinalProductIngredient) substance FHIR attribute
MedicinalProductIngredient Example
{
"resourceType": "MedicinalProductIngredient",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>role</b>: ActiveBase <span>(Details : {http://ema.europa.eu/example/ingredientRole code 'ActiveBase' = 'ActiveBase)</span></p><p><b>manufacturer</b>: <a>Organization/example</a></p><h3>SpecifiedSubstances</h3><table><tr><td>-</td><td><b>Code</b></td><td><b>Group</b></td></tr><tr><td>*</td><td>equixabanCompanyequixaban1 <span>(Details : {http://ema.europa.eu/example/specifiedSubstance code 'equixabanCompanyequixaban1' = 'equixabanCompanyequixaban1)</span></td><td>2 <span>(Details : {http://ema.europa.eu/example/specifiedSubstanceGroup code '2' = '2)</span></td></tr></table><blockquote><p><b>substance</b></p><p><b>code</b>: EQUIXABAN <span>(Details : {http://ema.europa.eu/example/substance code 'EQUIXABAN' = 'EQUIXABAN)</span></p><h3>Strengths</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote></div>"
},
"role": {
"coding": [
{
"system": "http://ema.europa.eu/example/ingredientRole",
"code": "ActiveBase"
}
]
},
"manufacturer": [
{
"reference": "Organization/example"
}
],
"specifiedSubstance": [
{
"code": {
"coding": [
{
"system": "http://ema.europa.eu/example/specifiedSubstance",
"code": "equixabanCompanyequixaban1"
}
]
},
"group": {
"coding": [
{
"system": "http://ema.europa.eu/example/specifiedSubstanceGroup",
"code": "2"
}
]
}
}
],
"substance": {
"code": {
"coding": [
{
"system": "http://ema.europa.eu/example/substance",
"code": "EQUIXABAN"
}
]
},
"strength": [
{
"presentation": {
"numerator": {
"value": 2.5,
"unit": "mg"
},
"denominator": {
"value": 1,
"unit": "{tablet}"
}
}
}
]
}
}MedicinalProductIngredient Structure
{
"resourceType" : "MedicinalProductIngredient",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : { Identifier }, // Identifier for the ingredient
"role" : { CodeableConcept }, // R! Ingredient role e.g. Active ingredient, excipient
"allergenicIndicator" : <boolean>, // If the ingredient is a known or suspected allergen
"manufacturer" : [{ Reference(Organization) }], // Manufacturer of this Ingredient
"specifiedSubstance" : [{ // A specified substance that comprises this ingredient
"code" : { CodeableConcept }, // R! The specified substance
"group" : { CodeableConcept }, // R! The group of specified substance, e.g. group 1 to 4
"confidentiality" : { CodeableConcept }, // Confidentiality level of the specified substance as the ingredient
"strength" : [{ // Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
"presentation" : { Ratio }, // R! The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
"presentationLowLimit" : { Ratio }, // A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit
"concentration" : { Ratio }, // The strength per unitary volume (or mass)
"concentrationLowLimit" : { Ratio }, // A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit
"measurementPoint" : "<string>", // For when strength is measured at a particular point or distance
"country" : [{ CodeableConcept }], // The country or countries for which the strength range applies
"referenceStrength" : [{ // Strength expressed in terms of a reference substance
"substance" : { CodeableConcept }, // Relevant reference substance
"strength" : { Ratio }, // R! Strength expressed in terms of a reference substance
"strengthLowLimit" : { Ratio }, // Strength expressed in terms of a reference substance
"measurementPoint" : "<string>", // For when strength is measured at a particular point or distance
"country" : [{ CodeableConcept }] // The country or countries for which the strength range applies
}]
}]
}],
"substance" : { // The ingredient substance
"code" : { CodeableConcept }, // R! The ingredient substance
"strength" : [{ Content as for MedicinalProductIngredient.specifiedSubstance.strength }] // Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
}
}
MedicinalProductIngredient Search Parameters
The following search parameters can be used to query MedicinalProductIngredient resources. Just submit them like so:
https://api.1up.health/fhir/r4/MedicinalProductIngredient?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|
