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

TimePeriodModel


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="shr-core-TimePeriod-model"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC TimePeriod Logical Model</b></p>
  <p>A period of time defined by a start and end time, date, or year.

If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May.</p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/breastcancer"/>
    <value value="shr.core.TimePeriod"/>
  </identifier>
  <version value="0.1.0"/>
  <name value="TimePeriodModel"/>
  <title value="BC TimePeriod 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 period of time defined by a start and end time, date, or year.

If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May."/>
  <keyword>
    <system value="http://ncimeta.nci.nih.gov"/>
    <code value="C1948053"/>
  </keyword>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="shr-core-TimePeriod-model"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="shr-core-TimePeriod-model">
      <path value="shr-core-TimePeriod-model"/>
      <definition
                  value="A period of time defined by a start and end time, date, or year.

If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="shr-core-TimePeriod-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-TimePeriod-model.timePeriodStart">
      <path value="shr-core-TimePeriod-model.timePeriodStart"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1301880"/>
      </code>
      <short
             value="The time at which something is to take effect, start, or did start. Boundary is considered inclusive."/>
      <definition
                  value="The time at which something is to take effect, start, or did start. Boundary is considered inclusive."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-TimePeriod-model.timePeriodStart"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriodStart-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-TimePeriod-model.timePeriodEnd">
      <path value="shr-core-TimePeriod-model.timePeriodEnd"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1522314"/>
      </code>
      <short
             value="The time at which something is to end or did end. Boundary is considered inclusive."/>
      <definition
                  value="The time at which something is to end or did end. Boundary is considered inclusive."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-TimePeriod-model.timePeriodEnd"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriodEnd-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </snapshot>
  <differential>
    <element id="shr-core-TimePeriod-model">
      <path value="shr-core-TimePeriod-model"/>
      <definition
                  value="A period of time defined by a start and end time, date, or year.

If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="shr-core-TimePeriod-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-TimePeriod-model.timePeriodStart">
      <path value="shr-core-TimePeriod-model.timePeriodStart"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1301880"/>
      </code>
      <short
             value="The time at which something is to take effect, start, or did start. Boundary is considered inclusive."/>
      <definition
                  value="The time at which something is to take effect, start, or did start. Boundary is considered inclusive."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-TimePeriod-model.timePeriodStart"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriodStart-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="shr-core-TimePeriod-model.timePeriodEnd">
      <path value="shr-core-TimePeriod-model.timePeriodEnd"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C1522314"/>
      </code>
      <short
             value="The time at which something is to end or did end. Boundary is considered inclusive."/>
      <definition
                  value="The time at which something is to end or did end. Boundary is considered inclusive."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="shr-core-TimePeriod-model.timePeriodEnd"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriodEnd-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </differential>
</StructureDefinition>