PIVL-TS
type: StructureDefinition
node role: treeRoot
id:
  v: PIVL-TS
text:
  status:
    v: generated
  div: 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.
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-target
  value: boolean
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/data-absent-reason
      value: code
        v: not-applicable
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
  value: uri
    v: urn:hl7-org:v3
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-container
  value: uri
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
url:
  v: http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS
version:
  v: 1.0.1
name:
  v: PIVL_TS
title:
  v: PIVL_TS: PeriodicIntervalOfTime (V3 Data Type)
status:
  v: active
experimental:
  v: false
date:
  v: 2025-10-10T09:58:30+10:00
publisher:
  v: HL7
description:
  v: 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.
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: http://hl7.org/cda/stds/core/StructureDefinition/PIVL_TS
base definition:
  v: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
  link: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    value: string
      v: 1.0.1
  element:
    id:
      v: PIVL_TS
    path:
      v: PIVL_TS
    short:
      v: Base for all types and resources
    definition:
      v: A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.
    min:
      v: 1
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: PIVL_TS.nullFlavor
    path:
      v: PIVL_TS.nullFlavor
    representation:
      v: xmlAttr
    label:
      v: Exceptional Value Detail
    definition:
      v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: ANY.nullFlavor
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: code
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
        link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    binding:
      strength:
        v: required
      value set:
        v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
        link: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
  element:
    id:
      v: PIVL_TS.value
    extension:
      url:
        v: http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format
      value: string
        v: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
    extension:
      url:
        v: http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules
      value: string
        v: year-valid
    path:
      v: PIVL_TS.value
    representation:
      v: xmlAttr
    definition:
      v: A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.
    min:
      v: 0
    max:
      v: 0
    base:
      path:
        v: TS.value
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: dateTime
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/ts-simple
        link: http://hl7.org/cda/stds/core/StructureDefinition/ts-simple
  element:
    id:
      v: PIVL_TS.operator
    path:
      v: PIVL_TS.operator
    representation:
      v: xmlAttr
    definition:
      v: 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:
      v: 0
    max:
      v: 1
    base:
      path:
        v: SXCM_TS.operator
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: code
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
        link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    default value: code
      v: I
    binding:
      strength:
        v: required
      value set:
        v: http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
        link: http://hl7.org/cda/stds/core/ValueSet/CDASetOperator

id:
  v: PIVL_TS.phase
path:
  v: PIVL_TS.phase
label:
  v: Phase
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: PIVL_TS.phase
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS

id:
  v: PIVL_TS.period
path:
  v: PIVL_TS.period
label:
  v: Period
definition:
  v: A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: PIVL_TS.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/PQ

id:
  v: PIVL_TS.alignment
path:
  v: PIVL_TS.alignment
representation:
  v: xmlAttr
label:
  v: Alignment to the Calendar
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: PIVL_TS.alignment
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple

id:
  v: PIVL_TS.institutionSpecified
path:
  v: PIVL_TS.institutionSpecified
representation:
  v: xmlAttr
label:
  v: Institution Specified Timing
definition:
  v: 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:
  v: 0
max:
  v: 1
base:
  path:
    v: PIVL_TS.institutionSpecified
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple

element:
  id:
    v: PIVL_TS
  path:
    v: PIVL_TS
  min:
    v: 1
  max:
    v: *
element:
  id:
    v: PIVL_TS.value
  path:
    v: PIVL_TS.value
  representation:
    v: xmlAttr
  min:
    v: 0
  max:
    v: 0
element:
  id:
    v: PIVL_TS.phase
  path:
    v: PIVL_TS.phase
  label:
    v: Phase
  definition:
    v: 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:
    v: 0
  max:
    v: 1
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
element:
  id:
    v: PIVL_TS.period
  path:
    v: PIVL_TS.period
  label:
    v: Period
  definition:
    v: A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/PQ
element:
  id:
    v: PIVL_TS.alignment
  path:
    v: PIVL_TS.alignment
  representation:
    v: xmlAttr
  label:
    v: Alignment to the Calendar
  definition:
    v: 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:
    v: 0
  max:
    v: 1
  type:
    code:
      v: code
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
element:
  id:
    v: PIVL_TS.institutionSpecified
  path:
    v: PIVL_TS.institutionSpecified
  representation:
    v: xmlAttr
  label:
    v: Institution Specified Timing
  definition:
    v: 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:
    v: 0
  max:
    v: 1
  type:
    code:
      v: boolean
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple