This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Logical Model V3 Data type PIVL (PeriodicIntervalOfTime)
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="PIVL"/> <extension url="http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace"> <valueUri value="urn:hl7-org:v3"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/PIVL"/> <name value="V3 Data type PIVL (PeriodicIntervalOfTime)"/> <display value="V3 Data type PIVL (PeriodicIntervalOfTime)"/> <status value="active"/> <experimental value="false"/> <publisher value="HL7"/> <description value="An interval of time that recurs periodically. Periodic intervals have two properties, phase and period. The phase specifies the "interval prototype" that is repeated every period."/> <kind value="logical"/> <abstract value="false"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/SXCM_TS"/> <snapshot> <element> <path value="PIVL"/> <min value="1"/> <max value="*"/> <type> <code value="Element"/> </type> </element> <element> <path value="PIVL.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"/> <type> <code value="code"/> </type> <binding> <strength value="required"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/v3-NullFlavor"/> </valueSetReference> </binding> </element> <element> <path value="PIVL.value"/> <representation value="xmlAttr"/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> </element> <element> <path value="PIVL.inclusive"/> <representation value="xmlAttr"/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="PIVL.operator"/> <representation value="xmlAttr"/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> </element> <element> <path value="PIVL.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="IVL_TS"/> </type> </element> <element> <path value="PIVL.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="PQ"/> </type> </element> <element> <path value="PIVL.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 "the 5th of every month".) 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"/> </type> </element> <element> <path value="PIVL.institutionSpecifiedTime"/> <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 "every 8 hours" from "3 times a day".)"/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> </snapshot> <differential> <element> <path value="PIVL"/> <min value="1"/> <max value="*"/> <type> <code value="Element"/> </type> </element> <element> <path value="PIVL.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="IVL_TS"/> </type> </element> <element> <path value="PIVL.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="PQ"/> </type> </element> <element> <path value="PIVL.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 "the 5th of every month".) 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"/> </type> </element> <element> <path value="PIVL.institutionSpecifiedTime"/> <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 "every 8 hours" from "3 times a day".)"/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> </differential> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.