Substance.profile.xml

Profile for substance

Raw XML

<Profile xmlns="http://hl7.org/fhir">
  <text>
    <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre>
&lt;<a class="dict" href="substance-definitions.html#Substance" title="A homogeneous material with a definite composition."><b>Substance</b></a> xmlns=&quot;http://hl7.org/fhir&quot;&gt; <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span>
 &lt;!-- from <a href="resources.html">Resource</a>: <a href="extensibility.html">extension</a>, <a href="extensibility.html#modifierExtension">modifierExtension</a>, language, <a href="narrative.html#Narrative">text</a>, and <a href="references.html#contained">contained</a> --&gt;
 &lt;<a class="dict" href="substance-definitions.html#Substance.type" title="A code (or set of codes) that identify this substance."><b>type</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-substance-type.html" style="color: navy">What kind of substance this is</a></span><span style="color: Gray"> --&gt;</span>&lt;/type&gt;
 &lt;<a class="dict" href="substance-definitions.html#Substance.description" title="A description of the substance - its appearance, handling requirements, and other usage
         notes."><b>description</b></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">Textual description of the substance, comments</span><span style="color: Gray"> --&gt;</span>
 &lt;<a class="dict" href="substance-definitions.html#Substance.instance" title="Substance may be used to describe a kind of substance, or a specific package/container
         of the substance: an instance."><b>instance</b></a>&gt;  <span style="color: Gray">&lt;!-- <span style="color: brown"><b>0..1</b></span> If this describes a specific package/container of the substance --&gt;</span>
  &lt;<a class="dict" href="substance-definitions.html#Substance.instance.identifier" title="Identifier associated with the package/container (usually a label affixed directly)."><b>identifier</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Identifier">Identifier</a></span> <span style="color: navy">Identifier of the package/container</span><span style="color: Gray"> --&gt;</span>&lt;/identifier&gt;
  &lt;<a class="dict" href="substance-definitions.html#Substance.instance.expiry" title="When the substance is no longer valid to use. For some substances, a single arbitrary
         date is used for expiry."><b>expiry</b></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#dateTime">dateTime</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">When no longer valid to use</span><span style="color: Gray"> --&gt;</span>
  &lt;<a class="dict" href="substance-definitions.html#Substance.instance.quantity" title="The amount of the substance."><b>quantity</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Quantity">Quantity</a></span> <span style="color: navy">Amount of substance in the package</span><span style="color: Gray"> --&gt;</span>&lt;/quantity&gt;
 &lt;/instance&gt;
 &lt;<a class="dict" href="substance-definitions.html#Substance.ingredient" title="A substance can be composed of other substances."><b>ingredient</b></a>&gt;  <span style="color: Gray">&lt;!-- <span style="color: brown"><b>0..*</b></span> Composition information about the substance --&gt;</span>
  &lt;<a class="dict" href="substance-definitions.html#Substance.ingredient.quantity" title="The amount of the ingredient in the substance - a concentration ratio."><b>quantity</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#Ratio">Ratio</a></span> <span style="color: navy">Optional amount (concentration)</span><span style="color: Gray"> --&gt;</span>&lt;/quantity&gt;
  &lt;<a class="dict" href="substance-definitions.html#Substance.ingredient.substance" title="Another substance that is a component of this substance."><b>substance</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="substance.html#Substance">Substance</a>)</span> <span style="color: navy">A component of the substance</span><span style="color: Gray"> --&gt;</span>&lt;/substance&gt;
 &lt;/ingredient&gt;
&lt;/Substance&gt;
</pre></div>
  </text>
  <name value="substance"/>
  <publisher value="FHIR Project"/>
  <description value="Basic Profile. A homogeneous material with a definite composition."/>
  <status value="draft"/>
  <date value="2014-09-30"/>
  <requirements value="Scope and Usage This resource allows for a material to be represented. The resource can
   be used to represent either a kind of a substance - e.g. a formulation commonly used for
   treating patients, or it can be used to describe a particular package of a known substance
   (e.g. bottle, jar, packet).   The composition of the material can be specified in terms
   of a mix of other materials, including with precise amounts if required."/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <structure>
    <type value="Substance"/>
    <publish value="true"/>
    <element>
      <path value="Substance"/>
      <definition>
        <short value="A homogeneous material with a definite composition"/>
        <formal value="A homogeneous material with a definite composition."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="Material"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Substance.extension"/>
      <definition>
        <short value="Additional Content defined by implementations"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource. In order to make the use of extensions safe and manageable, there is
         a strict governance applied to the definition and use of extensions. Though any implementer
         is allowed to define an extension, there is a set of requirements that SHALL be met as
         part of the definition of the extension."/>
        <comments value="there can be no stigma associated with the use of extensions by any application, project,
         or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
          The use of extensions is what allows the FHIR specification to retain a core simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="Substance.modifierExtension"/>
      <definition>
        <short value="Extensions that cannot be ignored"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource, and that modifies the understanding of the element that contains it.
         Usually modifier elements provide negation or qualification. In order to make the use
         of extensions safe and manageable, there is a strict governance applied to the definition
         and use of extensions. Though any implementer is allowed to define an extension, there
         is a set of requirements that SHALL be met as part of the definition of the extension.
         Applications processing a resource are required to check for modifier extensions."/>
        <comments value="there can be no stigma associated with the use of extensions by any application, project,
         or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
          The use of extensions is what allows the FHIR specification to retain a core simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="Substance.text"/>
      <definition>
        <short value="Text summary of the resource, for human interpretation"/>
        <formal value="A human-readable narrative that contains a summary of the resource, and may be used to
         represent the content of the resource to a human. The narrative need not encode all the
         structured data, but is required to contain sufficient detail to make it &quot;clinically
         safe&quot; for a human to just read the narrative. Resource definitions may define what
         content should be represented in the narrative to ensure clinical safety."/>
        <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have
         a narrative."/>
        <synonym value="narrative"/>
        <synonym value="html"/>
        <synonym value="xhtml"/>
        <synonym value="display"/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="Narrative"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="Substance.contained"/>
      <definition>
        <short value="Contained, inline Resources"/>
        <formal value="These resources do not have an independent existence apart from the resource that contains
         them - they cannot be identified independently, and nor can they have their own independent
         transaction scope."/>
        <comments value="This should never be done when the content can be identified properly, as once identification
         is lost, it is extremely difficult (and context dependent) to restore it again."/>
        <synonym value="inline resources"/>
        <synonym value="anonymous resources"/>
        <synonym value="contained resources"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="Substance.type"/>
      <definition>
        <short value="What kind of substance this is"/>
        <formal value="A code (or set of codes) that identify this substance."/>
        <comments value="This could be a reference to an externally defined code.  It could also be a locally assigned
         code (e.g. a formulary),  optionally with translations to the standard drug codes."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="CodeableConcept"/>
        </type>
        <isModifier value="false"/>
        <binding>
          <name value="SubstanceType"/>
          <isExtensible value="true"/>
          <conformance value="example"/>
          <referenceResource>
            <reference value="http://hl7.org/fhir/vs/substance-type"/>
          </referenceResource>
        </binding>
        <mapping>
          <identity value="rim"/>
          <map value=".code"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Substance.description"/>
      <definition>
        <short value="Textual description of the substance, comments"/>
        <formal value="A description of the substance - its appearance, handling requirements, and other usage
         notes."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="string"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".player.desc"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Substance.instance"/>
      <definition>
        <short value="If this describes a specific package/container of the substance"/>
        <formal value="Substance may be used to describe a kind of substance, or a specific package/container
         of the substance: an instance."/>
        <min value="0"/>
        <max value="1"/>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".player.determinerCode"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Substance.instance.extension"/>
      <definition>
        <short value="Additional Content defined by implementations"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource. In order to make the use of extensions safe and manageable, there is
         a strict governance applied to the definition and use of extensions. Though any implementer
         is allowed to define an extension, there is a set of requirements that SHALL be met as
         part of the definition of the extension."/>
        <comments value="there can be no stigma associated with the use of extensions by any application, project,
         or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
          The use of extensions is what allows the FHIR specification to retain a core simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="Substance.instance.modifierExtension"/>
      <definition>
        <short value="Extensions that cannot be ignored"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource, and that modifies the understanding of the element that contains it.
         Usually modifier elements provide negation or qualification. In order to make the use
         of extensions safe and manageable, there is a strict governance applied to the definition
         and use of extensions. Though any implementer is allowed to define an extension, there
         is a set of requirements that SHALL be met as part of the definition of the extension.
         Applications processing a resource are required to check for modifier extensions."/>
        <comments value="there can be no stigma associated with the use of extensions by any application, project,
         or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
          The use of extensions is what allows the FHIR specification to retain a core simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="Substance.instance.identifier"/>
      <definition>
        <short value="Identifier of the package/container"/>
        <formal value="Identifier associated with the package/container (usually a label affixed directly)."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="Identifier"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".id"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Substance.instance.expiry"/>
      <definition>
        <short value="When no longer valid to use"/>
        <formal value="When the substance is no longer valid to use. For some substances, a single arbitrary
         date is used for expiry."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="dateTime"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".expiryTime"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Substance.instance.quantity"/>
      <definition>
        <short value="Amount of substance in the package"/>
        <formal value="The amount of the substance."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="Quantity"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".player.quantity"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Substance.ingredient"/>
      <definition>
        <short value="Composition information about the substance"/>
        <formal value="A substance can be composed of other substances."/>
        <min value="0"/>
        <max value="*"/>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".player.scopesRole[classCode=INGR]"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Substance.ingredient.extension"/>
      <definition>
        <short value="Additional Content defined by implementations"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource. In order to make the use of extensions safe and manageable, there is
         a strict governance applied to the definition and use of extensions. Though any implementer
         is allowed to define an extension, there is a set of requirements that SHALL be met as
         part of the definition of the extension."/>
        <comments value="there can be no stigma associated with the use of extensions by any application, project,
         or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
          The use of extensions is what allows the FHIR specification to retain a core simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="Substance.ingredient.modifierExtension"/>
      <definition>
        <short value="Extensions that cannot be ignored"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource, and that modifies the understanding of the element that contains it.
         Usually modifier elements provide negation or qualification. In order to make the use
         of extensions safe and manageable, there is a strict governance applied to the definition
         and use of extensions. Though any implementer is allowed to define an extension, there
         is a set of requirements that SHALL be met as part of the definition of the extension.
         Applications processing a resource are required to check for modifier extensions."/>
        <comments value="there can be no stigma associated with the use of extensions by any application, project,
         or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
          The use of extensions is what allows the FHIR specification to retain a core simplicity
         for everyone."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="Substance.ingredient.quantity"/>
      <definition>
        <short value="Optional amount (concentration)"/>
        <formal value="The amount of the ingredient in the substance - a concentration ratio."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="Ratio"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".quantity"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Substance.ingredient.substance"/>
      <definition>
        <short value="A component of the substance"/>
        <formal value="Another substance that is a component of this substance."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Substance"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".player"/>
        </mapping>
      </definition>
    </element>
    <searchParam>
      <name value="_id"/>
      <type value="token"/>
      <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/>
    </searchParam>
    <searchParam>
      <name value="_language"/>
      <type value="token"/>
      <documentation value="The language of the resource"/>
    </searchParam>
    <searchParam>
      <name value="expiry"/>
      <type value="date"/>
      <documentation value="When no longer valid to use"/>
      <xpath value="f:Substance/f:instance/f:expiry"/>
    </searchParam>
    <searchParam>
      <name value="identifier"/>
      <type value="token"/>
      <documentation value="Identifier of the package/container"/>
      <xpath value="f:Substance/f:instance/f:identifier"/>
    </searchParam>
    <searchParam>
      <name value="quantity"/>
      <type value="number"/>
      <documentation value="Amount of substance in the package"/>
      <xpath value="f:Substance/f:instance/f:quantity"/>
    </searchParam>
    <searchParam>
      <name value="substance"/>
      <type value="reference"/>
      <documentation value="A component of the substance"/>
      <xpath value="f:Substance/f:ingredient/f:substance"/>
    </searchParam>
    <searchParam>
      <name value="type"/>
      <type value="token"/>
      <documentation value="The type of the substance"/>
      <xpath value="f:Substance/f:type"/>
    </searchParam>
  </structure>
</Profile>