Period.profile.xml

StructureDefinition for Period

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Period"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/Period"/>
  <name value="Period"/>
  <publisher value="HL7 FHIR Standard"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <description value="Base StructureDefinition for Period Resource"/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2"/>
  </mapping>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <type value="type"/>
  <abstract value="false"/>
  <base value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <snapshot>
    <element>
      <path value="Period"/>
      <short value="Time range defined by start and end date/time"/>
      <definition value="A time period defined by a start and end date and optionally time."/>
      <comments value="This is not a duration - that's a measure of time (a separate type), but a duration that
       occurs at a fixed value of time. A Period specifies a range of time; the context of use
       will specify whether the entire range applies (e.g. &quot;the patient was an inpatient
       of the hospital for this time range&quot;) or one value from the range applies (e.g. &quot;give
       to the patient between these two times&quot;). If a duration might be required, specify
       the type as Interval|Duration."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Period"/>
      </type>
      <constraint>
        <key value="per-1"/>
        <name value="Start &lt;= End"/>
        <severity value="error"/>
        <human value="If present, start SHALL have a lower value than end"/>
        <xpath value="not(exists(f:start)) or not(exists(f:end)) or (f:start/@value &lt;= f:end/@value)"/>
      </constraint>
      <mapping>
        <identity value="v2"/>
        <map value="DR"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="IVL&lt;TS&gt;[lowClosed=&quot;true&quot; and highClosed=&quot;true&quot;] or URG&lt;TS&gt;[lowClosed
        =&quot;true&quot; and highClosed=&quot;true&quot;]"/>
      </mapping>
    </element>
    <element>
      <path value="Period.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Period.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element. In order to make the use of extensions safe and manageable, there is a
       strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Period.start"/>
      <short value="Starting time with inclusive boundary"/>
      <definition value="The start of the period. The boundary is inclusive."/>
      <comments value="If the low element is missing, the meaning is that the low boundary is not known."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <condition value="per-1"/>
      <mapping>
        <identity value="v2"/>
        <map value="DR.1"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./low"/>
      </mapping>
    </element>
    <element>
      <path value="Period.end"/>
      <short value="End time with inclusive boundary, if not ongoing"/>
      <definition value="The end of the period. If the end of the period is missing, it means that the period is
       ongoing."/>
      <comments value="The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period
       that has a end value of 2012-02-03."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <condition value="per-1"/>
      <mapping>
        <identity value="v2"/>
        <map value="DR.2"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./high"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="Period"/>
      <short value="Time range defined by start and end date/time"/>
      <definition value="A time period defined by a start and end date and optionally time."/>
      <comments value="This is not a duration - that's a measure of time (a separate type), but a duration that
       occurs at a fixed value of time. A Period specifies a range of time; the context of use
       will specify whether the entire range applies (e.g. &quot;the patient was an inpatient
       of the hospital for this time range&quot;) or one value from the range applies (e.g. &quot;give
       to the patient between these two times&quot;). If a duration might be required, specify
       the type as Interval|Duration."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Element"/>
      </type>
      <constraint>
        <key value="per-1"/>
        <name value="Start &lt;= End"/>
        <severity value="error"/>
        <human value="If present, start SHALL have a lower value than end"/>
        <xpath value="not(exists(f:start)) or not(exists(f:end)) or (f:start/@value &lt;= f:end/@value)"/>
      </constraint>
      <mapping>
        <identity value="v2"/>
        <map value="DR"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="IVL&lt;TS&gt;[lowClosed=&quot;true&quot; and highClosed=&quot;true&quot;] or URG&lt;TS&gt;[lowClosed
        =&quot;true&quot; and highClosed=&quot;true&quot;]"/>
      </mapping>
    </element>
    <element>
      <path value="Period.start"/>
      <short value="Starting time with inclusive boundary"/>
      <definition value="The start of the period. The boundary is inclusive."/>
      <comments value="If the low element is missing, the meaning is that the low boundary is not known."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <condition value="per-1"/>
      <mapping>
        <identity value="v2"/>
        <map value="DR.1"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./low"/>
      </mapping>
    </element>
    <element>
      <path value="Period.end"/>
      <short value="End time with inclusive boundary, if not ongoing"/>
      <definition value="The end of the period. If the end of the period is missing, it means that the period is
       ongoing."/>
      <comments value="The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period
       that has a end value of 2012-02-03."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="dateTime"/>
      </type>
      <condition value="per-1"/>
      <mapping>
        <identity value="v2"/>
        <map value="DR.2"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./high"/>
      </mapping>
    </element>
  </differential>
</StructureDefinition>