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

SubstanceModel


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="cimi-entity-Substance-model"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC Substance Logical Model</b></p>
  <p>Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical.</p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Substance-model"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/breastcancer"/>
    <value value="cimi.entity.Substance"/>
  </identifier>
  <version value="0.2.0"/>
  <name value="SubstanceModel"/>
  <title value="BC Substance Logical Model"/>
  <status value="draft"/>
  <date value="2018-08-17T00:00:00+10:00"/>
  <publisher
             value="The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cic/index.cfm"/>
    </telecom>
  </contact>
  <description
               value="Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical."/>
  <keyword>
    <system value="http://ncimeta.nci.nih.gov"/>
    <code value="C0439861"/>
  </keyword>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="cimi-entity-Substance-model"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="cimi-entity-Substance-model">
      <path value="cimi-entity-Substance-model"/>
      <definition
                  value="Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Substance-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Substance-model.type">
      <path value="cimi-entity-Substance-model.type"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0332307"/>
      </code>
      <short
             value="The most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <definition
                  value="The most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Substance-model.type"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="preferred"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/substance-code"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-entity-Substance-model.category">
      <path value="cimi-entity-Substance-model.category"/>
      <short
             value="A class or division of people or things having particular shared characteristics"/>
      <definition
                  value="A class or division of people or things having particular shared characteristics"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Substance-model.category"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="extensible"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/substance-category"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-entity-Substance-model.activeFlagAsaCodeableConcept">
      <path value="cimi-entity-Substance-model.activeFlagAsaCodeableConcept"/>
      <short
             value="If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI."/>
      <definition
                  value="If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Substance-model.activeFlagAsaCodeableConcept"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/substance-status"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-entity-Substance-model.details">
      <path value="cimi-entity-Substance-model.details"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0947611"/>
      </code>
      <short
             value="A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information."/>
      <definition
                  value="A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Substance-model.details"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Substance-model.ingredient">
      <path value="cimi-entity-Substance-model.ingredient"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C3176062"/>
      </code>
      <short
             value="Specifies an material component in a non-medication substance."/>
      <definition
                  value="Specifies an material component in a non-medication substance."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Substance-model.ingredient"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Ingredient-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </snapshot>
  <differential>
    <element id="cimi-entity-Substance-model">
      <path value="cimi-entity-Substance-model"/>
      <definition
                  value="Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Substance-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Substance-model.type">
      <path value="cimi-entity-Substance-model.type"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0332307"/>
      </code>
      <short
             value="The most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <definition
                  value="The most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Substance-model.type"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="preferred"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/substance-code"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-entity-Substance-model.category">
      <path value="cimi-entity-Substance-model.category"/>
      <short
             value="A class or division of people or things having particular shared characteristics"/>
      <definition
                  value="A class or division of people or things having particular shared characteristics"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Substance-model.category"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="extensible"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/substance-category"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-entity-Substance-model.activeFlagAsaCodeableConcept">
      <path value="cimi-entity-Substance-model.activeFlagAsaCodeableConcept"/>
      <short
             value="If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI."/>
      <definition
                  value="If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Substance-model.activeFlagAsaCodeableConcept"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/substance-status"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-entity-Substance-model.details">
      <path value="cimi-entity-Substance-model.details"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0947611"/>
      </code>
      <short
             value="A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information."/>
      <definition
                  value="A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-entity-Substance-model.details"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-entity-Substance-model.ingredient">
      <path value="cimi-entity-Substance-model.ingredient"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C3176062"/>
      </code>
      <short
             value="Specifies an material component in a non-medication substance."/>
      <definition
                  value="Specifies an material component in a non-medication substance."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-entity-Substance-model.ingredient"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Ingredient-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </differential>
</StructureDefinition>