R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example Ingredient/example (XML)

Biomedical Research and Regulation Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: No defined compartments

Raw XML (canonical form + also see XML Format Specification)

Jump past Narrative

General example of an active ingredient, with presentation, concentration and reference strength (id = "example")

<?xml version="1.0" encoding="UTF-8"?>

<Ingredient xmlns="http://hl7.org/fhir">
  <id value="example"/> 
      <!--    note this doesn't indicate an "active ingredient" as opposed to an excipient
   (for which see ingredient.role)    -->
  <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative: Ingredient</b> <a name="example"> </a> </p> <div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border:
       1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Ingredient &quot;example&quot; </p> </div> <p> <b> status</b> : <span title="  note this doesn't indicate an &quot;active ingredient&quot; as opposed to an
         excipient (for which see ingredient.role)  ">active</span> </p> <p> <b> role</b> : ActiveBase <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (ingredientRole#ActiveBase)</span> </p> <h3> Manufacturers</h3> <table class="grid"><tr> <td style="display: none">-</td> <td> <b> Manufacturer</b> </td> </tr> <tr> <td style="display: none">*</td> <td> <a href="broken-link.html">Organization/example</a> </td> </tr> </table> <blockquote> <p> <b> substance</b> </p> <h3> Codes</h3> <table class="grid"><tr> <td style="display: none">-</td> <td> <b> Concept</b> </td> </tr> <tr> <td style="display: none">*</td> <td> EQUIXABAN <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (substance#EQUIXABAN)</span> </td> </tr> </table> <blockquote> <p> <b> strength</b> </p> <p> <b> presentation</b> : <span title="  a single strength is commonly expressed in two ways: 
         presentation - per item (e.g. per tablet), 
         and concentration - per unit of measure (usually with a unitary demoninator)
              &amp;#10;  these are not different strengths - and have the same real value -
             but are different ways of expressing the same single strength  &amp;#10;  presentation
             is meant for humans/consumers, concentration is meant for calculations/experts
              ">50 mg<span style="background: LightGoldenRodYellow"> (Details: UCUM code mg = 'mg')</span> /1 tablet<span style="background: LightGoldenRodYellow"> (Details: UCUM code {tablet} = '{tablet}')</span> </span> </p> <p> <b> concentration</b> : 5 mg<span style="background: LightGoldenRodYellow"> (Details: UCUM code mg = 'mg')</span> /1 mg<span style="background: LightGoldenRodYellow"> (Details: UCUM code mg = 'mg')</span> </p> <blockquote> <p> <b> referenceStrength</b> </p> <h3> Substances</h3> <table class="grid"><tr> <td style="display: none">-</td> <td> <b> Concept</b> </td> </tr> <tr> <td style="display: none">*</td> <td> EQUIXABAN-SULPHATE <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (substance#EQUIXABAN-SULPHATE)</span> </td> </tr> </table> <p> <b> strength</b> : 5.03 mg<span style="background: LightGoldenRodYellow"> (Details: UCUM code mg = 'mg')</span> /1 mg<span style="background: LightGoldenRodYellow"> (Details: UCUM code mg = 'mg')</span> </p> </blockquote> </blockquote> </blockquote> </div> </text> <status value="active"/>  
  <role> 
    <coding> 
      <system value="http://ema.europa.eu/example/ingredientRole"/> 
      <code value="ActiveBase"/> 
    </coding> 
  </role> 
  <manufacturer> 
    <manufacturer> 
      <reference value="Organization/example"/> 
    </manufacturer> 
  </manufacturer> 
  <substance> 
    <code> 
      <concept> 
        <coding> 
          <system value="http://ema.europa.eu/example/substance"/> 
          <code value="EQUIXABAN"/> 
        </coding> 
      </concept> 
    </code> 
    <strength> 
          <!--    a single strength is commonly expressed in two ways: 
         presentation - per item (e.g. per tablet), 
         and concentration - per unit of measure (usually with a unitary demoninator)
          -->
          <!--    these are not different strengths - and have the same real value - but are different
       ways of expressing the same single strength    -->
          <!--    presentation is meant for humans/consumers, concentration is meant for calculations/expert
      s    -->
      <presentationRatio> 
        <numerator> 
          <value value="50"/> 
          <unit value="mg"/> 
          <system value="http://unitsofmeasure.org"/>  
          <code value="mg"/> 
        </numerator> 
        <denominator> 
          <value value="1"/> 
          <unit value="tablet"/> 
          <system value="http://unitsofmeasure.org"/>  
          <code value="{tablet}"/> 
        </denominator> 
      </presentationRatio> 
      <concentrationRatio> 
            <!--    5mg/1mg (which means - because the presentation is 50mg/tablet - it must be
         a 10mg tablet)    -->
        <numerator> 
          <value value="5"/>  
          <unit value="mg"/> 
          <system value="http://unitsofmeasure.org"/>  
          <code value="mg"/> 
        </numerator> 
        <denominator> 
              <!--    since this is for caculations, this is normally "1", a unitary ratio    -->
          <value value="1"/>  
          <unit value="mg"/> 
          <system value="http://unitsofmeasure.org"/>  
          <code value="mg"/> 
        </denominator> 
      </concentrationRatio> 
          <!--    A reference strength is a different strength value for the same substance, 
         expressed in terms of a related but different substance.
         This other substance is usually another chemical form of the same thing e.g.
       the "salt" form of the active igredient, 
           for example a chloride or sulfate. The salt may be the form of the substance
       molecule that is 
           actually present, even though the strength is usually expressed in terms
       of only the active "base" 
           part of the molecule.
         A tablet of morphine sulfate may acually have a stated active ingredient of
       just morphine, 
         and may express the amount (strength) of the active ingredient as 
         the mass of morphine - ignoring the mass of the sulfate group. 
         Reference strength allows for additionally expressing the amount accurately
       in terms of the entire molecule.
         -->
      <referenceStrength> 
        <substance> 
          <concept> 
            <coding> 
              <system value="http://ema.europa.eu/example/substance"/> 
              <code value="EQUIXABAN-SULPHATE"/> 
            </coding> 
          </concept> 
        </substance> 
        <strengthRatio> 
          <numerator> 
            <value value="5.03"/>  
            <unit value="mg"/> 
            <system value="http://unitsofmeasure.org"/>  
            <code value="mg"/> 
          </numerator> 
          <denominator> 
            <value value="1"/>  
            <unit value="mg"/> 
            <system value="http://unitsofmeasure.org"/>  
            <code value="mg"/> 
          </denominator> 
        </strengthRatio> 
      </referenceStrength> 
    </strength> 
  </substance> 
</Ingredient> 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.