FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5
0.0.1-snapshot-2 - informative International flag

FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 - Version 0.0.1-snapshot-2. See the Directory of published versions

: Cross-version VS for R5.RoleClassIngredientEntity for use in FHIR R4 - JSON Representation

Page standards status: Informative Maturity Level: 0

Raw json | Download

{
  "resourceType" : "ValueSet",
  "id" : "R5-v3-RoleClassIngredientEntity-for-R4",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ValueSet R5-v3-RoleClassIngredientEntity-for-R4</b></p><a name=\"R5-v3-RoleClassIngredientEntity-for-R4\"> </a><a name=\"hcR5-v3-RoleClassIngredientEntity-for-R4\"> </a><p>This value set expansion contains 15 concepts.</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>System</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-INGR\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-INGR\">INGR</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>ingredient</td><td><div><p>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.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-ACTI\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-ACTI\">ACTI</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>active ingredient</td><td><div><p><strong>Definition:</strong> 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).</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-ACTIB\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-ACTIB\">ACTIB</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>active ingredient - basis of strength</td><td><div><p><strong>Description:</strong>  Active ingredient, where the ingredient substance (player) is itself the &quot;basis of strength&quot;, i.e., where the Role.quantity specifies exactly the quantity of the player substance in the medicine formulation.</p>\n<p><strong>Examples:</strong> 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.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-ACTIM\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-ACTIM\">ACTIM</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>active ingredient - moiety is basis of strength</td><td><div><p><strong>Description:</strong> Active ingredient, where not the ingredient substance (player), but itaTMs active moiety is the &quot;basis of strength&quot;, i.e., where the Role.quantity specifies the quantity of the player substance's active moiety in the medicine formulation.</p>\n<p><strong>Examples:</strong> 1 mL of Betopic 5mg/mL eye drops contains 5.6 mg betaxolol hydrochloride equivalent to betaxolol base 5 mg.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-ACTIR\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-ACTIR\">ACTIR</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>active ingredient - reference substance is basis of strength</td><td><div><p><strong>Description:</strong> Active ingredient, where not the ingredient substance (player) but another reference substance with the same active moiety, is the &quot;basis of strength&quot;, 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.</p>\n<p><strong>Examples:</strong> Toprol-XL 50 mg contains 47.5 mg of metoprolol succinate equivalent to 50 mg of metoprolol tartrate.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-ADJV\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-ADJV\">ADJV</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>adjuvant</td><td><div><p>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.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-ADTV\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-ADTV\">ADTV</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>additive</td><td><div><p>An ingredient (player) that is added to a base (scoper), that amounts to a minor part of the overall mixture.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-BASE\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-BASE\">BASE</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>base</td><td><div><p>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.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-CNTM\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-CNTM\">CNTM</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>contaminant ingredient</td><td><div><p>An ingredient whose presence is not intended but may not be reasonably avoided given the circumstances of the mixture's nature or origin.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-IACT\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-IACT\">IACT</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>inactive ingredient</td><td><div><p>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.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-COLR\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-COLR\">COLR</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>color additive</td><td><div><p>A substance (player) influencing the optical aspect of material (scoper).</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-FLVR\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-FLVR\">FLVR</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>flavor additive</td><td><div><p>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).</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-PRSV\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-PRSV\">PRSV</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>preservative</td><td><div><p>A substance (player) added to a mixture (scoper) to prevent microorganisms (fungi, bacteria) to spoil the mixture.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-STBL\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-STBL\">STBL</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>stabilizer</td><td><div><p>A stabilizer (player) added to a mixture (scoper) in order to prevent the molecular disintegration of the main substance.</p>\n</div></td></tr><tr><td style=\"white-space:nowrap\"><a name=\"R5-v3-RoleClassIngredientEntity-for-R4-http://terminology.hl7.org/CodeSystem/v3-RoleClass-MECH\"> </a>\u00a0\u00a0<a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-v3-RoleClass.html#v3-RoleClass-MECH\">MECH</a></td><td>http://terminology.hl7.org/CodeSystem/v3-RoleClass</td><td>mechanical ingredient</td><td><div><p>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.</p>\n<p>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.</p>\n</div></td></tr></table></div>"
  },
  "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.0.1-snapshot-2"
        }
      ],
      "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/5.0/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "informative",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/5.0/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/5.0/ValueSet/R5-v3-RoleClassIngredientEntity-for-R4",
  "version" : "0.0.1-snapshot-2",
  "name" : "R5_v3_RoleClassIngredientEntity_for_R4",
  "title" : "Cross-version VS for R5.RoleClassIngredientEntity for use in FHIR R4",
  "status" : "active",
  "experimental" : false,
  "date" : "2025-09-01T22:37:05.371468+10: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 concepts from http://terminology.hl7.org/ValueSet/v3-RoleClassIngredientEntity|2.0.0 for use in FHIR R4. Concepts not present here have direct `equivalent` mappings crossing all versions from R5 to R4.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "compose" : {
    "include" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
        "version" : "3.1.0",
        "concept" : [
          {
            "code" : "INGR",
            "display" : "ingredient"
          },
          {
            "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" : "IACT",
            "display" : "inactive ingredient"
          },
          {
            "code" : "COLR",
            "display" : "color additive"
          },
          {
            "code" : "FLVR",
            "display" : "flavor additive"
          },
          {
            "code" : "PRSV",
            "display" : "preservative"
          },
          {
            "code" : "STBL",
            "display" : "stabilizer"
          },
          {
            "code" : "MECH",
            "display" : "mechanical ingredient"
          }
        ]
      }
    ]
  },
  "expansion" : {
    "timestamp" : "2025-09-01T22:37:05.371464+10:00",
    "contains" : [
      {
        "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" : "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" : "IACT",
        "display" : "inactive 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" : "PRSV",
        "display" : "preservative"
      },
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
        "version" : "3.1.0",
        "code" : "STBL",
        "display" : "stabilizer"
      },
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
        "version" : "3.1.0",
        "code" : "MECH",
        "display" : "mechanical ingredient"
      }
    ]
  }
}