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

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

EvaluationComponentModel


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="cimi-EvaluationComponent-model"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC EvaluationComponent Logical Model</b></p>
  <p>A simplified, non-separable evaluation consisting of a finding code (represented by the Concept), value (or exception value), reference range, and interpretation.

The subject of the evaluation component is the same as in the parent evaluation.</p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-EvaluationComponent-model"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/breastcancer"/>
    <value value="cimi.EvaluationComponent"/>
  </identifier>
  <version value="0.1.0"/>
  <name value="EvaluationComponentModel"/>
  <title value="BC EvaluationComponent Logical Model"/>
  <status value="draft"/>
  <date value="2018-04-01T00:00:00+11:00"/>
  <publisher
             value="The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://standardhealthrecord.org"/>
    </telecom>
  </contact>
  <description
               value="A simplified, non-separable evaluation consisting of a finding code (represented by the Concept), value (or exception value), reference range, and interpretation.

The subject of the evaluation component is the same as in the parent evaluation."/>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="cimi-EvaluationComponent-model"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="cimi-EvaluationComponent-model">
      <path value="cimi-EvaluationComponent-model"/>
      <definition
                  value="A simplified, non-separable evaluation consisting of a finding code (represented by the Concept), value (or exception value), reference range, and interpretation.

The subject of the evaluation component is the same as in the parent evaluation."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-EvaluationComponent-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-EvaluationComponent-model.value[x]">
      <path value="cimi-EvaluationComponent-model.value[x]"/>
      <short
             value="Choice of types representing a simplified, non-separable evaluation consisting of a finding code (represented by the Concept), value (or exception value), reference range, and interpretation."/>
      <definition
                  value="Choice of types representing a simplified, non-separable evaluation consisting of a finding code (represented by the Concept), value (or exception value), reference range, and interpretation.

The subject of the evaluation component is the same as in the parent evaluation."/>
      <alias value="quantity"/>
      <alias value="codeableConcept"/>
      <alias value="string"/>
      <alias value="range"/>
      <alias value="ratio"/>
      <alias value="time"/>
      <alias value="dateTime"/>
      <alias value="timePeriod"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-EvaluationComponent-model.value[x]"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Quantity-model"/>
      </type>
      <type>
        <code value="Coding"/>
      </type>
      <type>
        <code value="string"/>
      </type>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Range-model"/>
      </type>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Ratio-model"/>
      </type>
      <type>
        <code value="time"/>
      </type>
      <type>
        <code value="dateTime"/>
      </type>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-EvaluationComponent-model.exceptionValue">
      <path value="cimi-EvaluationComponent-model.exceptionValue"/>
      <short
             value="Reason that a value associated with a test or other finding is missing."/>
      <definition
                  value="Reason that a value associated with a test or other finding is missing.

CIMI Alignment: This attribute corresponds to EvaluationResultTopic.exceptionValue, but has been moved from topic to context because missing values are only relevant when they should be recorded, but are not. The value set binding extends the set of FHIR&#39;s required data absent values, with additional concepts from CIMI."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-EvaluationComponent-model.exceptionValue"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-ExceptionValue-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-EvaluationComponent-model.interpretation">
      <path value="cimi-EvaluationComponent-model.interpretation"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0420833"/>
      </code>
      <short value="A clinical interpretation of a finding."/>
      <definition
                  value="A clinical interpretation of a finding.

CIMI Alignment: The value set binding has been chosen to align with FHIR. (Note: it is not clear if Interpretation belongs in FindingTopic, rather than a context class, but that is how CIMI has modeled it.)"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-EvaluationComponent-model.interpretation"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-Interpretation-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-EvaluationComponent-model.referenceRange">
      <path value="cimi-EvaluationComponent-model.referenceRange"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0883335"/>
      </code>
      <short value="The usual or acceptable range for a test result."/>
      <definition value="The usual or acceptable range for a test result."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-EvaluationComponent-model.referenceRange"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-ReferenceRange-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </snapshot>
  <differential>
    <element id="cimi-EvaluationComponent-model">
      <path value="cimi-EvaluationComponent-model"/>
      <definition
                  value="A simplified, non-separable evaluation consisting of a finding code (represented by the Concept), value (or exception value), reference range, and interpretation.

The subject of the evaluation component is the same as in the parent evaluation."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-EvaluationComponent-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-EvaluationComponent-model.value[x]">
      <path value="cimi-EvaluationComponent-model.value[x]"/>
      <short
             value="Choice of types representing a simplified, non-separable evaluation consisting of a finding code (represented by the Concept), value (or exception value), reference range, and interpretation."/>
      <definition
                  value="Choice of types representing a simplified, non-separable evaluation consisting of a finding code (represented by the Concept), value (or exception value), reference range, and interpretation.

The subject of the evaluation component is the same as in the parent evaluation."/>
      <alias value="quantity"/>
      <alias value="codeableConcept"/>
      <alias value="string"/>
      <alias value="range"/>
      <alias value="ratio"/>
      <alias value="time"/>
      <alias value="dateTime"/>
      <alias value="timePeriod"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-EvaluationComponent-model.value[x]"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Quantity-model"/>
      </type>
      <type>
        <code value="Coding"/>
      </type>
      <type>
        <code value="string"/>
      </type>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Range-model"/>
      </type>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Ratio-model"/>
      </type>
      <type>
        <code value="time"/>
      </type>
      <type>
        <code value="dateTime"/>
      </type>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-EvaluationComponent-model.exceptionValue">
      <path value="cimi-EvaluationComponent-model.exceptionValue"/>
      <short
             value="Reason that a value associated with a test or other finding is missing."/>
      <definition
                  value="Reason that a value associated with a test or other finding is missing.

CIMI Alignment: This attribute corresponds to EvaluationResultTopic.exceptionValue, but has been moved from topic to context because missing values are only relevant when they should be recorded, but are not. The value set binding extends the set of FHIR&#39;s required data absent values, with additional concepts from CIMI."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-EvaluationComponent-model.exceptionValue"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-ExceptionValue-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-EvaluationComponent-model.interpretation">
      <path value="cimi-EvaluationComponent-model.interpretation"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0420833"/>
      </code>
      <short value="A clinical interpretation of a finding."/>
      <definition
                  value="A clinical interpretation of a finding.

CIMI Alignment: The value set binding has been chosen to align with FHIR. (Note: it is not clear if Interpretation belongs in FindingTopic, rather than a context class, but that is how CIMI has modeled it.)"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-EvaluationComponent-model.interpretation"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-Interpretation-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-EvaluationComponent-model.referenceRange">
      <path value="cimi-EvaluationComponent-model.referenceRange"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0883335"/>
      </code>
      <short value="The usual or acceptable range for a test result."/>
      <definition value="The usual or acceptable range for a test result."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-EvaluationComponent-model.referenceRange"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-ReferenceRange-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </differential>
</StructureDefinition>