Release 4B R5 Final QA

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-draft-final: Final QA Preview for R5 - STU see ballot notes ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B

Ingredient-example.ttl

Example Ingredient/example (Turtle)

Biomedical Research and Regulation Work Group Maturity Level : N/A Standards Status : Informative Compartments : Not linked to any defined compartments

Raw Turtle (+ also see Turtle/RDF Format Specification )

General example of an active ingredient ingredient, with presentation, concentration and reference strength 

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/Ingredient/example> a fhir:Ingredient;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "example"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></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 &quot;example&quot; </p></div><p><b>status</b>: active</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>-</td><td><b>Manufacturer</b></td></tr><tr><td>*</td><td><a href=\"todo.html\">Organization/example</a></td></tr></table><blockquote><p><b>substance</b></p><h3>Strengths</h3><table class=\"grid\"><tr><td>-</td><td><b>Presentation[x]</b></td></tr><tr><td>*</td><td>2.5 mg<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM code mg = 'mg')</span>/1 tablet<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM code {tablet} = '{tablet}')</span></td></tr></table></blockquote></div>"
  ];
  fhir:Ingredient.status [ fhir:value "active"];
  fhir:Ingredient.role [
     fhir:CodeableConcept.coding [
       fhir:index 0;
       fhir:Coding.system [ fhir:value "http://ema.europa.eu/example/ingredientRole" ];
       fhir:Coding.code [ fhir:value "ActiveBase" ]
     ]
  ];
  fhir:Ingredient.manufacturer [
     fhir:index 0;
     fhir:Ingredient.manufacturer.manufacturer [
       fhir:link <http://hl7.org/fhir/Organization/example>;
       fhir:Reference.reference [ fhir:value "Organization/example" ]

[a fhir:Ingredient ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "example"] ; # 
  fhir:text [
     fhir:status [ fhir:v "generated" ] ;
     fhir:div "<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>-</td><td><b>Manufacturer</b></td></tr><tr><td>*</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>-</td><td><b>Concept</b></td></tr><tr><td>*</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: \n				 presentation - per item (e.g. per tablet), \n				 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>-</td><td><b>Concept</b></td></tr><tr><td>*</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>"
  ] ; #    note this doesn't indicate an "active ingredient" as opposed to an excipient (for which see ingredient.role)   
  fhir:status [ fhir:v "active"] ; # 
  fhir:role [
     fhir:coding ( [
       fhir:system [ fhir:v "http://ema.europa.eu/example/ingredientRole"^^xsd:anyURI ] ;
       fhir:code [ fhir:v "ActiveBase" ]
     ] )
  ] ; # 
  fhir:manufacturer ( [
     fhir:manufacturer [
       fhir:reference [ fhir:v "Organization/example" ]

     ]
  ];
  fhir:Ingredient.substance [
     fhir:Ingredient.substance.code [
       fhir:CodeableReference.concept [
         fhir:CodeableConcept.coding [
           fhir:index 0;
           fhir:Coding.system [ fhir:value "http://ema.europa.eu/example/substance" ];
           fhir:Coding.code [ fhir:value "EQUIXABAN" ]
         ]

  ] ) ; # 
  fhir:substance [
     fhir:code [
       fhir:concept [
         fhir:coding ( [
           fhir:system [ fhir:v "http://ema.europa.eu/example/substance"^^xsd:anyURI ] ;
           fhir:code [ fhir:v "EQUIXABAN" ]
         ] )

       ]
     ];
     fhir:Ingredient.substance.strength [
       fhir:index 0;
       fhir:Ingredient.substance.strength.presentationRatio [
         fhir:Ratio.numerator [
           fhir:Quantity.value [ fhir:value "2.5"^^xsd:decimal ];
           fhir:Quantity.unit [ fhir:value "mg" ];
           fhir:Quantity.system [ fhir:value "http://unitsofmeasure.org" ];
           fhir:Quantity.code [ fhir:value "mg" ]
         ];
         fhir:Ratio.denominator [
           fhir:Quantity.value [ fhir:value "1"^^xsd:decimal ];
           fhir:Quantity.unit [ fhir:value "tablet" ];
           fhir:Quantity.system [ fhir:value "http://unitsofmeasure.org" ];
           fhir:Quantity.code [ fhir:value "{tablet}" ]

     ] ;
     fhir:strength ( [
       fhir:presentation [
         a fhir:Ratio ;
         fhir:numerator [
           fhir:value [ fhir:v "50"^^xsd:decimal ] ;
           fhir:unit [ fhir:v "mg" ] ;
           fhir:system [ fhir:v "http://unitsofmeasure.org"^^xsd:anyURI ] ;
           fhir:code [ fhir:v "mg" ]
         ] ;
         fhir:denominator [
           fhir:value [ fhir:v "1"^^xsd:decimal ] ;
           fhir:unit [ fhir:v "tablet" ] ;
           fhir:system [ fhir:v "http://unitsofmeasure.org"^^xsd:anyURI ] ;
           fhir:code [ fhir:v "{tablet}" ]

         ]
       ]
     ]
  ] .

<http://hl7.org/fhir/Organization/example> a fhir:Organization .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/Ingredient/example.ttl> a owl:Ontology;
  owl:imports fhir:fhir.ttl;
  owl:versionIRI <http://build.fhir.org/Ingredient/example.ttl> .

       ] ; #    a single strength is commonly expressed in two ways: \n				 presentation - per item (e.g. per tablet), \n				 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\/experts   
       fhir:concentration [
         a fhir:Ratio ;
         fhir:numerator [
           fhir:value [ fhir:v "5"^^xsd:decimal ] ;
           fhir:unit [ fhir:v "mg" ] ;
           fhir:system [ fhir:v "http://unitsofmeasure.org"^^xsd:anyURI ] ;
           fhir:code [ fhir:v "mg" ]
         ] ; #    5mg\/1mg (which means - because the presentation is 50mg\/tablet - it must be a 10mg tablet)   
         fhir:denominator [
           fhir:value [ fhir:v "1"^^xsd:decimal ] ; #    since this is for caculations, this is normally \"1\", a unitary ratio   
           fhir:unit [ fhir:v "mg" ] ;
           fhir:system [ fhir:v "http://unitsofmeasure.org"^^xsd:anyURI ] ;
           fhir:code [ fhir:v "mg" ]
         ]
       ] ;
       fhir:referenceStrength ( [
         fhir:substance [
           fhir:concept [
             fhir:coding ( [
               fhir:system [ fhir:v "http://ema.europa.eu/example/substance"^^xsd:anyURI ] ;
               fhir:code [ fhir:v "EQUIXABAN-SULPHATE" ]
             ] )
           ]
         ] ;
         fhir:strength [
           a fhir:Ratio ;
           fhir:numerator [
             fhir:value [ fhir:v "5.03"^^xsd:decimal ] ;
             fhir:unit [ fhir:v "mg" ] ;
             fhir:system [ fhir:v "http://unitsofmeasure.org"^^xsd:anyURI ] ;
             fhir:code [ fhir:v "mg" ]
           ] ;
           fhir:denominator [
             fhir:value [ fhir:v "1"^^xsd:decimal ] ;
             fhir:unit [ fhir:v "mg" ] ;
             fhir:system [ fhir:v "http://unitsofmeasure.org"^^xsd:anyURI ] ;
             fhir:code [ fhir:v "mg" ]
           ]
         ]
       ] ) #    A reference strength is a different strength value for the same substance, \n				 expressed in terms of a related but different substance.\n				 This other substance is usually another chemical form of the same thing e.g. the \"salt\" form of the active igredient, \n			     for example a chloride or sulfate. The salt may be the form of the substance molecule that is \n			     actually present, even though the strength is usually expressed in terms of only the active \"base\" \n			     part of the molecule.\n				 A tablet of morphine sulfate may acually have a stated active ingredient of just morphine, \n				 and may express the amount (strength) of the active ingredient as \n				 the mass of morphine - ignoring the mass of the sulfate group. \n				 Reference strength allows for additionally expressing the amount accurately in terms of the entire molecule.\n			  
     ] )
  ]] . # 


# -------------------------------------------------------------------------------------

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.