FHIR IG analytics| Package | hl7.fhir.uv.xver-r5.r4 |
| Resource Type | ValueSet |
| Id | ValueSet-R5-v3-RoleClassIngredientEntity-for-R4.json |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/ValueSet-R5-v3-RoleClassIngredientEntity-for-R4.html |
| URL | http://hl7.org/fhir/uv/xver/ValueSet/R5-v3-RoleClassIngredientEntity-for-R4 |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-03-17T21:02:03.8104715+00:00 |
| Name | R5V3RoleClassIngredientEntityForR4 |
| Title | Cross-version ValueSet R5.RoleClassIngredientEntity for use in FHIR R4 |
| Realm | uv |
| Authority | hl7 |
| Description | This cross-version ValueSet represents content from `http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity|2.0.0` for use in FHIR R4. |
| Purpose | This value set is part of the cross-version definitions generated to enable use of the value set `http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity|2.0.0` as defined in FHIR R5 in FHIR R4. The source value set is bound to the following FHIR R5 elements: * `MedicationKnowledge.definitional.ingredient.type` Note that all concepts are included in this cross-version definition because no concepts have compatible representations Following are the generation technical comments: FHIR ValueSet `http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity|2.0.0`, defined in FHIR R5 does not have any mapping to FHIR R4 |
| StructureDefinition | ||
| hl7.fhir.uv.xver-r5.r4#0.1.0 | extension-MedicationKnowledge.definitional.ingredient.type | R5: A code that defines the type of ingredient, active, base, etc (new) |
| CodeSystem | ||
| hl7.terminology#current | v3-RoleClass | RoleClass |
Note: links and images are rebased to the (stated) source
Generated Narrative: ValueSet R5-v3-RoleClassIngredientEntity-for-R4
This value set expansion contains 15 concepts.
| System | Version | Code | Display | Definition |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | ACTI | active ingredient | Definition: a therapeutically active ingredient (player) in a mixture (scoper), where the mixture is typically a manufactured pharmaceutical. It is unknown if the quantity of such an ingredient is expressed precisely in terms of the playing ingredient substance, or, if it is specified in terms of a closely related substance (active moiety or reference substance). |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | ACTIB | active ingredient - basis of strength | Description: Active ingredient, where the ingredient substance (player) is itself the "basis of strength", i.e., where the Role.quantity specifies exactly the quantity of the player substance in the medicine formulation. Examples: Lopressor 50 mg actually contains 50 mg of metoprolol succinate, even though the active moiety is metoprolol, but also: Tenormin 50 mg contain 50 mg of atenolol, as free base, i.e., where the active ingredient atenolol is also the active moiety. |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | ACTIM | active ingredient - moiety is basis of strength | Description: Active ingredient, where not the ingredient substance (player), but itaTMs active moiety is the "basis of strength", i.e., where the Role.quantity specifies the quantity of the player substance's active moiety in the medicine formulation. Examples: 1 mL of Betopic 5mg/mL eye drops contains 5.6 mg betaxolol hydrochloride equivalent to betaxolol base 5 mg. |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | ACTIR | active ingredient - reference substance is basis of strength | Description: Active ingredient, where not the ingredient substance (player) but another reference substance with the same active moiety, is the "basis of strength", i.e., where the Role.quantity specifies the quantity of a reference substance, similar but different from the player substance's in the medicine formulation. Examples: Toprol-XL 50 mg contains 47.5 mg of metoprolol succinate equivalent to 50 mg of metoprolol tartrate. |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | ADJV | adjuvant | A component (player) added to enhance the action of an active ingredient (scoper) (in the manner of a catalyst) but which has no active effect in and of itself. Such ingredients are significant in defining equivalence of products in a way that inactive ingredients are not. |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | ADTV | additive | An ingredient (player) that is added to a base (scoper), that amounts to a minor part of the overall mixture. |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | BASE | base | A base ingredient (player) is what comprises the major part of a mixture (scoper). E.g., Water in most i.v. solutions, or Vaseline in salves. Among all ingredients of a material, there should be only one base. A base substance can, in turn, be a mixture. |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | CNTM | contaminant ingredient | An ingredient whose presence is not intended but may not be reasonably avoided given the circumstances of the mixture's nature or origin. |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | COLR | color additive | A substance (player) influencing the optical aspect of material (scoper). |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | FLVR | flavor additive | A substance (player) added to a mixture (scoper) to make it taste a certain way. In food the use is obvious, in pharmaceuticals flavors can hide disgusting taste of the active ingredient (important in pediatric treatments). |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | IACT | inactive ingredient | An ingredient which is not considered therapeutically active, e.g., colors, flavors, stabilizers, or preservatives, fillers, or structural components added to an active ingredient in order to facilitate administration of the active ingredient but without being considered therapeutically active. An inactive ingredient need not be biologically inert, e.g., might be active as an allergen or might have a pleasant taste, but is not an essential constituent delivering the therapeutic effect. |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | INGR | ingredient | Relates a component (player) to a mixture (scoper). E.g., Glucose and Water are ingredients of D5W, latex may be an ingredient in a tracheal tube. |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | MECH | mechanical ingredient | An ingredient (player) of a medication (scoper) that is inseparable from the active ingredients, but has no intended chemical or pharmaceutical effect itself, but which may have some systemic effect on the patient. An example is a collagen matrix used as a base for transplanting skin cells. The collagen matrix can be left permanently in the graft site. Because it is of bovine origin, the patient may exhibit allergies or may have cultural objections to its use. |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | PRSV | preservative | A substance (player) added to a mixture (scoper) to prevent microorganisms (fungi, bacteria) to spoil the mixture. |
http://terminology.hl7.org/CodeSystem/v3-RoleClass | 3.1.0 | STBL | stabilizer | A stabilizer (player) added to a mixture (scoper) in order to prevent the molecular disintegration of the main substance. |
FHIR
FHIRsmith{
"resourceType": "ValueSet",
"id": "R5-v3-RoleClassIngredientEntity-for-R4",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"extension": [
{
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r5.r4"
},
{
"url": "version",
"valueString": "0.1.0"
},
{
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/xver/ValueSet/R5-v3-RoleClassIngredientEntity-for-R4",
"version": "0.1.0",
"name": "R5V3RoleClassIngredientEntityForR4",
"title": "Cross-version ValueSet R5.RoleClassIngredientEntity for use in FHIR R4",
"status": "active",
"experimental": false,
"date": "2026-03-17T21:02:03.8104715+00:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "This cross-version ValueSet represents content from `http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity|2.0.0` for use in FHIR R4.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"purpose": "This value set is part of the cross-version definitions generated to enable use of the\r\nvalue set `http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity|2.0.0` as defined in FHIR R5\r\nin FHIR R4.\r\n\r\nThe source value set is bound to the following FHIR R5 elements:\r\n* `MedicationKnowledge.definitional.ingredient.type`\r\n\r\nNote that all concepts are included in this cross-version definition because no concepts have compatible representations\r\n\r\nFollowing are the generation technical comments:\r\n\nFHIR ValueSet `http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity|2.0.0`, defined in FHIR R5 does not have any mapping to FHIR R4",
"compose": {
"include": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"concept": [
{
"code": "ACTI",
"display": "active ingredient"
},
{
"code": "ACTIB",
"display": "active ingredient - basis of strength"
},
{
"code": "ACTIM",
"display": "active ingredient - moiety is basis of strength"
},
{
"code": "ACTIR",
"display": "active ingredient - reference substance is basis of strength"
},
{
"code": "ADJV",
"display": "adjuvant"
},
{
"code": "ADTV",
"display": "additive"
},
{
"code": "BASE",
"display": "base"
},
{
"code": "CNTM",
"display": "contaminant ingredient"
},
{
"code": "COLR",
"display": "color additive"
},
{
"code": "FLVR",
"display": "flavor additive"
},
{
"code": "IACT",
"display": "inactive ingredient"
},
{
"code": "INGR",
"display": "ingredient"
},
{
"code": "MECH",
"display": "mechanical ingredient"
},
{
"code": "PRSV",
"display": "preservative"
},
{
"code": "STBL",
"display": "stabilizer"
}
]
}
]
},
"expansion": {
"timestamp": "2026-03-17T21:02:03.8104715+00:00",
"contains": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "ACTI",
"display": "active ingredient"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "ACTIB",
"display": "active ingredient - basis of strength"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "ACTIM",
"display": "active ingredient - moiety is basis of strength"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "ACTIR",
"display": "active ingredient - reference substance is basis of strength"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "ADJV",
"display": "adjuvant"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "ADTV",
"display": "additive"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "BASE",
"display": "base"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "CNTM",
"display": "contaminant ingredient"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "COLR",
"display": "color additive"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "FLVR",
"display": "flavor additive"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "IACT",
"display": "inactive ingredient"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "INGR",
"display": "ingredient"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "MECH",
"display": "mechanical ingredient"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "PRSV",
"display": "preservative"
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"version": "3.1.0",
"code": "STBL",
"display": "stabilizer"
}
]
}
}