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

BreastSpecimenModel


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="oncology-BreastSpecimen-model"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC BreastSpecimen Logical Model</b></p>
  <p>Specimen resulting from biopsy or excision of breast and surrounding tissue.</p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSpecimen-model"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/breastcancer"/>
    <value value="oncology.BreastSpecimen"/>
  </identifier>
  <version value="0.1.0"/>
  <name value="BreastSpecimenModel"/>
  <title value="BC BreastSpecimen 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="Specimen resulting from biopsy or excision of breast and surrounding tissue."/>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="oncology-BreastSpecimen-model"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="oncology-BreastSpecimen-model">
      <path value="oncology-BreastSpecimen-model"/>
      <definition
                  value="Specimen resulting from biopsy or excision of breast and surrounding tissue."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="oncology-BreastSpecimen-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.type">
      <path value="oncology-BreastSpecimen-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="oncology-BreastSpecimen-model.type"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-Type-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.type.value">
      <path value="oncology-BreastSpecimen-model.type.value"/>
      <short
             value="Code representing the most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <definition
                  value="Code representing the most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <alias value="codeableConcept"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-Type-model.value"/>
        <min value="1"/>
        <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/us/breastcancer/ValueSet/oncology-BreastSpecimenTypeVS"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="oncology-BreastSpecimen-model.sourceSpecimen">
      <path value="oncology-BreastSpecimen-model.sourceSpecimen"/>
      <short
             value="Identifier for the source specimen from which this specimen was derived."/>
      <definition
                  value="Identifier for the source specimen from which this specimen was derived.

CIMI Alignment: In CIMI V0.0.4, this attribute is called parentSpecimenIdentifier (datatype Identifier). The corresponding element in FHIR (Specimen.parent) is type ref(Specimen). It is impossible to map Idenfier to Specimen, so the datatype of this element has been changed to make the mapping feasible."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.sourceSpecimen"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="BackboneElement"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.sourceSpecimen.value">
      <path value="oncology-BreastSpecimen-model.sourceSpecimen.value"/>
      <short
             value="Specimen resulting from biopsy or excision of breast and surrounding tissue."/>
      <definition
                  value="Specimen resulting from biopsy or excision of breast and surrounding tissue."/>
      <alias value="specimen"/>
      <alias value="breastSpecimen"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.sourceSpecimen.value"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSpecimen-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.receivedTime">
      <path value="oncology-BreastSpecimen-model.receivedTime"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C2735124"/>
      </code>
      <short value="Time received by accepting facility or unit."/>
      <definition value="Time received by accepting facility or unit."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.receivedTime"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-ReceivedTime-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.collectionTime">
      <path value="oncology-BreastSpecimen-model.collectionTime"/>
      <short
             value="When the sample was obtained, as a specific time or time period."/>
      <definition
                  value="When the sample was obtained, as a specific time or time period.

CIMI Alignment: Specimen collection time seems to be missing in CIMI V0.0.4. The time may be in the CollectionProcedure, but if the specimen collection time is recorded in Performance.Attribution (a list of actions), it would be nearly impossible to create a mapping."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.collectionTime"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-CollectionTime-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.collectionMethod">
      <path value="oncology-BreastSpecimen-model.collectionMethod"/>
      <short value="How the specimen was obtained."/>
      <definition value="How the specimen was obtained."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.collectionMethod"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-CollectionMethod-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.collectionMethod.value">
      <path value="oncology-BreastSpecimen-model.collectionMethod.value"/>
      <short value="Code representing how the specimen was obtained."/>
      <definition value="Code representing how the specimen was obtained."/>
      <alias value="codeableConcept"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-CollectionMethod-model.value"/>
        <min value="1"/>
        <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/us/breastcancer/ValueSet/oncology-BreastSpecimenCollectionMethodVS"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="oncology-BreastSpecimen-model.collectionSite">
      <path value="oncology-BreastSpecimen-model.collectionSite"/>
      <short value="The body site where specimen was collected"/>
      <definition value="The body site where specimen was collected"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.collectionSite"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="BackboneElement"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.collectionSite.value">
      <path value="oncology-BreastSpecimen-model.collectionSite.value"/>
      <short value="A body site specific to the breast structure."/>
      <definition value="A body site specific to the breast structure."/>
      <alias value="anatomicalLocation"/>
      <alias value="breastSite"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.collectionSite.value"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSite-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.coldIschemiaTime">
      <path value="oncology-BreastSpecimen-model.coldIschemiaTime"/>
      <code>
        <system value="http://loinc.org"/>
        <code value="44778-9"/>
      </code>
      <short
             value="The time period between the chilling of a tissue or tissue sample and the time it is warmed."/>
      <definition
                  value="The time period between the chilling of a tissue or tissue sample and the time it is warmed.

CIMI Alignment: In CIMI Version 0.0.4, specimen processing is represented as a &#39;SpecimenProcessingPerformed&#39; clinical statement, mapped to FHIR Procedure. However, specimen processing should actually map to Specimen.processing, part of the Specimen resource. It would be a difficult mapping exercise (beyond the scope of this IG) to express the mapping rule that any CIMI SpecimenProcessingPerformed clinical statement needs to mapped to FHIR by (1) finding the corresponding Specimen entity, and (2) mapping the content of (possibly multiple) SpecimenProcessingPerformed into the FHIR Specimen resource. To avoid this complexity, the breast cancer model expresses the cold ischemia time as an attribute of the BreastSpecimen rather than a separate procedure."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.coldIschemiaTime"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-ColdIschemiaTime-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </snapshot>
  <differential>
    <element id="oncology-BreastSpecimen-model">
      <path value="oncology-BreastSpecimen-model"/>
      <definition
                  value="Specimen resulting from biopsy or excision of breast and surrounding tissue."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="oncology-BreastSpecimen-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.type">
      <path value="oncology-BreastSpecimen-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="oncology-BreastSpecimen-model.type"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-Type-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.type.value">
      <path value="oncology-BreastSpecimen-model.type.value"/>
      <short
             value="Code representing the most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <definition
                  value="Code representing the most specific code (lowest level term) describing the kind or sort of thing being represented."/>
      <alias value="codeableConcept"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-Type-model.value"/>
        <min value="1"/>
        <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/us/breastcancer/ValueSet/oncology-BreastSpecimenTypeVS"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="oncology-BreastSpecimen-model.sourceSpecimen">
      <path value="oncology-BreastSpecimen-model.sourceSpecimen"/>
      <short
             value="Identifier for the source specimen from which this specimen was derived."/>
      <definition
                  value="Identifier for the source specimen from which this specimen was derived.

CIMI Alignment: In CIMI V0.0.4, this attribute is called parentSpecimenIdentifier (datatype Identifier). The corresponding element in FHIR (Specimen.parent) is type ref(Specimen). It is impossible to map Idenfier to Specimen, so the datatype of this element has been changed to make the mapping feasible."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.sourceSpecimen"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="BackboneElement"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.sourceSpecimen.value">
      <path value="oncology-BreastSpecimen-model.sourceSpecimen.value"/>
      <short
             value="Specimen resulting from biopsy or excision of breast and surrounding tissue."/>
      <definition
                  value="Specimen resulting from biopsy or excision of breast and surrounding tissue."/>
      <alias value="specimen"/>
      <alias value="breastSpecimen"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.sourceSpecimen.value"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSpecimen-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.receivedTime">
      <path value="oncology-BreastSpecimen-model.receivedTime"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C2735124"/>
      </code>
      <short value="Time received by accepting facility or unit."/>
      <definition value="Time received by accepting facility or unit."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.receivedTime"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-ReceivedTime-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.collectionTime">
      <path value="oncology-BreastSpecimen-model.collectionTime"/>
      <short
             value="When the sample was obtained, as a specific time or time period."/>
      <definition
                  value="When the sample was obtained, as a specific time or time period.

CIMI Alignment: Specimen collection time seems to be missing in CIMI V0.0.4. The time may be in the CollectionProcedure, but if the specimen collection time is recorded in Performance.Attribution (a list of actions), it would be nearly impossible to create a mapping."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.collectionTime"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-CollectionTime-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.collectionMethod">
      <path value="oncology-BreastSpecimen-model.collectionMethod"/>
      <short value="How the specimen was obtained."/>
      <definition value="How the specimen was obtained."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.collectionMethod"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-CollectionMethod-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.collectionMethod.value">
      <path value="oncology-BreastSpecimen-model.collectionMethod.value"/>
      <short value="Code representing how the specimen was obtained."/>
      <definition value="Code representing how the specimen was obtained."/>
      <alias value="codeableConcept"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="cimi-CollectionMethod-model.value"/>
        <min value="1"/>
        <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/us/breastcancer/ValueSet/oncology-BreastSpecimenCollectionMethodVS"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="oncology-BreastSpecimen-model.collectionSite">
      <path value="oncology-BreastSpecimen-model.collectionSite"/>
      <short value="The body site where specimen was collected"/>
      <definition value="The body site where specimen was collected"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.collectionSite"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="BackboneElement"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.collectionSite.value">
      <path value="oncology-BreastSpecimen-model.collectionSite.value"/>
      <short value="A body site specific to the breast structure."/>
      <definition value="A body site specific to the breast structure."/>
      <alias value="anatomicalLocation"/>
      <alias value="breastSite"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.collectionSite.value"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastSite-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="oncology-BreastSpecimen-model.coldIschemiaTime">
      <path value="oncology-BreastSpecimen-model.coldIschemiaTime"/>
      <code>
        <system value="http://loinc.org"/>
        <code value="44778-9"/>
      </code>
      <short
             value="The time period between the chilling of a tissue or tissue sample and the time it is warmed."/>
      <definition
                  value="The time period between the chilling of a tissue or tissue sample and the time it is warmed.

CIMI Alignment: In CIMI Version 0.0.4, specimen processing is represented as a &#39;SpecimenProcessingPerformed&#39; clinical statement, mapped to FHIR Procedure. However, specimen processing should actually map to Specimen.processing, part of the Specimen resource. It would be a difficult mapping exercise (beyond the scope of this IG) to express the mapping rule that any CIMI SpecimenProcessingPerformed clinical statement needs to mapped to FHIR by (1) finding the corresponding Specimen entity, and (2) mapping the content of (possibly multiple) SpecimenProcessingPerformed into the FHIR Specimen resource. To avoid this complexity, the breast cancer model expresses the cold ischemia time as an attribute of the BreastSpecimen rather than a separate procedure."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="oncology-BreastSpecimen-model.coldIschemiaTime"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-ColdIschemiaTime-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </differential>
</StructureDefinition>