Clinical Document Architecture
2.0.1-sd - release

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.1-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions

Logical Model: PIVL_TS - XML Profile

Active as of 2024-12-18

XML representation of the PIVL-TS logical model.

Raw xml | Download


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="PIVL-TS"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>An interval of time that recurs periodically. Periodic intervals have two properties, phase and period. The phase specifies the &quot;interval prototype&quot; that is repeated every period.</p>
    </div>
  </text>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
    <valueBoolean>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
        <valueCode value="not-applicable"/>
      </extension>
    </valueBoolean>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-container">
    <valueUri
              value="http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"/>
  </extension>
  <url value="http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS"/>
  <version value="2.0.1-sd"/>
  <name value="PIVL_TS"/>
  <title value="PIVL_TS: PeriodicIntervalOfTime (V3 Data Type)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-12-18T02:39:25+00:00"/>
  <publisher value="Health Level 7"/>
  <contact>
    <name value="HL7 International - Structured Documents"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/structure"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="structdog@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="An interval of time that recurs periodically. Periodic intervals have two properties, phase and period. The phase specifies the &quot;interval prototype&quot; that is repeated every period."/>
  <fhirVersion value="5.0.0"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="http://hl7.org/cda/stds/core/StructureDefinition/PIVL_TS"/>
  <baseDefinition
                  value="http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="PIVL_TS">
      <path value="PIVL_TS"/>
      <short value="Base for all types and resources"/>
      <definition
                  value="A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression."/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="PIVL_TS.nullFlavor">
      <path value="PIVL_TS.nullFlavor"/>
      <representation value="xmlAttr"/>
      <label value="Exceptional Value Detail"/>
      <definition
                  value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ANY.nullFlavor"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
      </binding>
    </element>
    <element id="PIVL_TS.value">
      <extension
                 url="http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format">
        <valueString value="YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules">
        <valueString value="year-valid"/>
      </extension>
      <path value="PIVL_TS.value"/>
      <representation value="xmlAttr"/>
      <definition
                  value="A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression."/>
      <min value="0"/>
      <max value="0"/>
      <base>
        <path value="TS.value"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="dateTime"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/ts-simple"/>
      </type>
    </element>
    <element id="PIVL_TS.operator">
      <path value="PIVL_TS.operator"/>
      <representation value="xmlAttr"/>
      <definition
                  value="A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="SXCM_TS.operator"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <defaultValueCode value="I"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://hl7.org/cda/stds/core/ValueSet/CDASetOperator"/>
      </binding>
    </element>
    <element id="PIVL_TS.phase">
      <path value="PIVL_TS.phase"/>
      <label value="Phase"/>
      <definition
                  value="A prototype of the repeating interval, specifying the duration of each occurrence and anchors the periodic interval sequence at a certain point in time."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="PIVL_TS.phase"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"/>
      </type>
    </element>
    <element id="PIVL_TS.period">
      <path value="PIVL_TS.period"/>
      <label value="Period"/>
      <definition
                  value="A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="PIVL_TS.period"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/PQ"/>
      </type>
    </element>
    <element id="PIVL_TS.alignment">
      <path value="PIVL_TS.alignment"/>
      <representation value="xmlAttr"/>
      <label value="Alignment to the Calendar"/>
      <definition
                  value="Specifies if and how the repetitions are aligned to the cycles of the underlying calendar (e.g., to distinguish every 30 days from &quot;the 5th of every month&quot;.) A non-aligned periodic interval recurs independently from the calendar. An aligned periodic interval is synchronized with the calendar."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="PIVL_TS.alignment"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
    </element>
    <element id="PIVL_TS.institutionSpecified">
      <path value="PIVL_TS.institutionSpecified"/>
      <representation value="xmlAttr"/>
      <label value="Institution Specified Timing"/>
      <definition
                  value="Indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish &quot;every 8 hours&quot; from &quot;3 times a day&quot;.)"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="PIVL_TS.institutionSpecified"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="boolean"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="PIVL_TS">
      <path value="PIVL_TS"/>
      <min value="1"/>
      <max value="*"/>
    </element>
    <element id="PIVL_TS.value">
      <path value="PIVL_TS.value"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="0"/>
    </element>
    <element id="PIVL_TS.phase">
      <path value="PIVL_TS.phase"/>
      <label value="Phase"/>
      <definition
                  value="A prototype of the repeating interval, specifying the duration of each occurrence and anchors the periodic interval sequence at a certain point in time."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"/>
      </type>
    </element>
    <element id="PIVL_TS.period">
      <path value="PIVL_TS.period"/>
      <label value="Period"/>
      <definition
                  value="A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/PQ"/>
      </type>
    </element>
    <element id="PIVL_TS.alignment">
      <path value="PIVL_TS.alignment"/>
      <representation value="xmlAttr"/>
      <label value="Alignment to the Calendar"/>
      <definition
                  value="Specifies if and how the repetitions are aligned to the cycles of the underlying calendar (e.g., to distinguish every 30 days from &quot;the 5th of every month&quot;.) A non-aligned periodic interval recurs independently from the calendar. An aligned periodic interval is synchronized with the calendar."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
    </element>
    <element id="PIVL_TS.institutionSpecified">
      <path value="PIVL_TS.institutionSpecified"/>
      <representation value="xmlAttr"/>
      <label value="Institution Specified Timing"/>
      <definition
                  value="Indicates whether the exact timing is up to the party executing the schedule (e.g., to distinguish &quot;every 8 hours&quot; from &quot;3 times a day&quot;.)"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="boolean"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"/>
      </type>
    </element>
  </differential>
</StructureDefinition>