HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

MedicationIngredientModel

{
  "resourceType" : "StructureDefinition",
  "id" : "cimi-entity-MedicationIngredient-model",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC MedicationIngredient Logical Model</b></p>
  <p>Specifies an material component in a medication.</p>
</div>"
  },
  "url" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-MedicationIngredient-model",
  "identifier" : [
    {
      "system" : "http://hl7.org/fhir/us/breastcancer",
      "value" : "cimi.entity.MedicationIngredient"
    }
  ],
  "version" : "0.2.0",
  "name" : "MedicationIngredientModel",
  "title" : "BC MedicationIngredient Logical Model",
  "status" : "draft",
  "date" : "2018-08-17T00:00:00+10:00",
  "publisher" : "The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cic/index.cfm"
        }
      ]
    }
  ],
  "description" : "Specifies an material component in a medication.",
  "keyword" : [
    {
      "system" : "http://ncimeta.nci.nih.gov",
      "code" : "C3176062"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "cimi-entity-MedicationIngredient-model",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Element",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "cimi-entity-MedicationIngredient-model",
        "path" : "cimi-entity-MedicationIngredient-model",
        "definition" : "Specifies an material component in a medication.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-MedicationIngredient-model",
          "min" : 0,
          "max" : "*"
        },
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-MedicationIngredient-model.value[x]",
        "path" : "cimi-entity-MedicationIngredient-model.value[x]",
        "short" : "Choice of types representing specifies an material component in a medication.",
        "definition" : "Choice of types representing specifies an material component in a medication.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-MedicationIngredient-model.value[x]",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          },
          {
            "code" : "Reference",
            "targetProfile" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Substance-model"
          },
          {
            "code" : "Reference",
            "targetProfile" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Medication-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-MedicationIngredient-model.ingredientAmount",
        "path" : "cimi-entity-MedicationIngredient-model.ingredientAmount",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0456603"
          }
        ],
        "short" : "The amount of an ingredient in a mixture, as a ratio. For example, 250 mg per tablet is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.",
        "definition" : "The amount of an ingredient in a mixture, as a ratio. For example, 250 mg per tablet is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-MedicationIngredient-model.ingredientAmount",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Ratio-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-MedicationIngredient-model.isActiveIngredient",
        "path" : "cimi-entity-MedicationIngredient-model.isActiveIngredient",
        "short" : "True if the ingredient is an active ingredient in the medication.",
        "definition" : "True if the ingredient is an active ingredient in the medication.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-MedicationIngredient-model.isActiveIngredient",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "boolean"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "cimi-entity-MedicationIngredient-model",
        "path" : "cimi-entity-MedicationIngredient-model",
        "definition" : "Specifies an material component in a medication.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-MedicationIngredient-model",
          "min" : 0,
          "max" : "*"
        },
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-MedicationIngredient-model.value[x]",
        "path" : "cimi-entity-MedicationIngredient-model.value[x]",
        "short" : "Choice of types representing specifies an material component in a medication.",
        "definition" : "Choice of types representing specifies an material component in a medication.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-MedicationIngredient-model.value[x]",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          },
          {
            "code" : "Reference",
            "targetProfile" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Substance-model"
          },
          {
            "code" : "Reference",
            "targetProfile" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Medication-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-MedicationIngredient-model.ingredientAmount",
        "path" : "cimi-entity-MedicationIngredient-model.ingredientAmount",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0456603"
          }
        ],
        "short" : "The amount of an ingredient in a mixture, as a ratio. For example, 250 mg per tablet is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.",
        "definition" : "The amount of an ingredient in a mixture, as a ratio. For example, 250 mg per tablet is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-MedicationIngredient-model.ingredientAmount",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Ratio-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-MedicationIngredient-model.isActiveIngredient",
        "path" : "cimi-entity-MedicationIngredient-model.isActiveIngredient",
        "short" : "True if the ingredient is an active ingredient in the medication.",
        "definition" : "True if the ingredient is an active ingredient in the medication.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-MedicationIngredient-model.isActiveIngredient",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "boolean"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      }
    ]
  }
}