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

SpecimenModel


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="cimi-Specimen-model"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC Specimen Logical Model</b></p>
  <p>A specimen is a substance, physical object, or collection of objects, that the laboratory considers a single discrete, uniquely identified unit that is the subject of one or more steps in the laboratory workflow. A specimen may include multiple physical pieces as long as they are considered a single unit within the laboratory workflow. A specimen results from one to many specimen collection procedures, and may be contained in multiple specimen containers. Specimen may have one or more processing activities.

CIMI Alignment: This class has been cut down to parts relevant to the current oncology ballot. The attribute parentSpecimenIdentifier has been changed from an Identifier to a reference to a Specimen, to make it possible to map to FHIR.</p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-Specimen-model"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/breastcancer"/>
    <value value="cimi.Specimen"/>
  </identifier>
  <version value="0.1.0"/>
  <name value="SpecimenModel"/>
  <title value="BC Specimen 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 specimen is a substance, physical object, or collection of objects, that the laboratory considers a single discrete, uniquely identified unit that is the subject of one or more steps in the laboratory workflow. A specimen may include multiple physical pieces as long as they are considered a single unit within the laboratory workflow. A specimen results from one to many specimen collection procedures, and may be contained in multiple specimen containers. Specimen may have one or more processing activities.

CIMI Alignment: This class has been cut down to parts relevant to the current oncology ballot. The attribute parentSpecimenIdentifier has been changed from an Identifier to a reference to a Specimen, to make it possible to map to FHIR."/>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="cimi-Specimen-model"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="cimi-Specimen-model">
      <path value="cimi-Specimen-model"/>
      <definition
                  value="A specimen is a substance, physical object, or collection of objects, that the laboratory considers a single discrete, uniquely identified unit that is the subject of one or more steps in the laboratory workflow. A specimen may include multiple physical pieces as long as they are considered a single unit within the laboratory workflow. A specimen results from one to many specimen collection procedures, and may be contained in multiple specimen containers. Specimen may have one or more processing activities.

CIMI Alignment: This class has been cut down to parts relevant to the current oncology ballot. The attribute parentSpecimenIdentifier has been changed from an Identifier to a reference to a Specimen, to make it possible to map to FHIR."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-Specimen-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-Specimen-model.type">
      <path value="cimi-Specimen-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-Specimen-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="cimi-Specimen-model.sourceSpecimen">
      <path value="cimi-Specimen-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="cimi-Specimen-model.sourceSpecimen"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-SourceSpecimen-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-Specimen-model.receivedTime">
      <path value="cimi-Specimen-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="cimi-Specimen-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="cimi-Specimen-model.collectionTime">
      <path value="cimi-Specimen-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="cimi-Specimen-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="cimi-Specimen-model.collectionMethod">
      <path value="cimi-Specimen-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="cimi-Specimen-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="cimi-Specimen-model.collectionSite">
      <path value="cimi-Specimen-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="cimi-Specimen-model.collectionSite"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-CollectionSite-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </snapshot>
  <differential>
    <element id="cimi-Specimen-model">
      <path value="cimi-Specimen-model"/>
      <definition
                  value="A specimen is a substance, physical object, or collection of objects, that the laboratory considers a single discrete, uniquely identified unit that is the subject of one or more steps in the laboratory workflow. A specimen may include multiple physical pieces as long as they are considered a single unit within the laboratory workflow. A specimen results from one to many specimen collection procedures, and may be contained in multiple specimen containers. Specimen may have one or more processing activities.

CIMI Alignment: This class has been cut down to parts relevant to the current oncology ballot. The attribute parentSpecimenIdentifier has been changed from an Identifier to a reference to a Specimen, to make it possible to map to FHIR."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-Specimen-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-Specimen-model.type">
      <path value="cimi-Specimen-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-Specimen-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="cimi-Specimen-model.sourceSpecimen">
      <path value="cimi-Specimen-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="cimi-Specimen-model.sourceSpecimen"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-SourceSpecimen-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-Specimen-model.receivedTime">
      <path value="cimi-Specimen-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="cimi-Specimen-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="cimi-Specimen-model.collectionTime">
      <path value="cimi-Specimen-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="cimi-Specimen-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="cimi-Specimen-model.collectionMethod">
      <path value="cimi-Specimen-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="cimi-Specimen-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="cimi-Specimen-model.collectionSite">
      <path value="cimi-Specimen-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="cimi-Specimen-model.collectionSite"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-CollectionSite-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </differential>
</StructureDefinition>