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)
{
"resourceType": "StructureDefinition",
"id": "PIVL",
"extension": [
{
"url": "http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace",
"valueUri": "urn:hl7-org:v3"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/PIVL",
"name": "V3 Data type PIVL (PeriodicIntervalOfTime)",
"display": "V3 Data type PIVL (PeriodicIntervalOfTime)",
"status": "active",
"experimental": false,
"publisher": "HL7",
"description": "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": "logical",
"abstract": false,
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/SXCM_TS",
"snapshot": {
"element": [
{
"path": "PIVL",
"min": 1,
"max": "*",
"type": [
{
"code": "Element"
}
]
},
{
"path": "PIVL.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-NullFlavor"
}
}
},
{
"path": "PIVL.value",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "PIVL.inclusive",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "PIVL.operator",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "PIVL.phase",
"label": "Phase",
"definition": "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": 0,
"max": "1",
"type": [
{
"code": "IVL_TS"
}
]
},
{
"path": "PIVL.period",
"label": "Period",
"definition": "A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.",
"min": 0,
"max": "1",
"type": [
{
"code": "PQ"
}
]
},
{
"path": "PIVL.alignment",
"representation": [
"xmlAttr"
],
"label": "Alignment to the Calendar",
"definition": "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": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "PIVL.institutionSpecifiedTime",
"representation": [
"xmlAttr"
],
"label": "Institution Specified Timing",
"definition": "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": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
}
]
},
"differential": {
"element": [
{
"path": "PIVL",
"min": 1,
"max": "*",
"type": [
{
"code": "Element"
}
]
},
{
"path": "PIVL.phase",
"label": "Phase",
"definition": "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": 0,
"max": "1",
"type": [
{
"code": "IVL_TS"
}
]
},
{
"path": "PIVL.period",
"label": "Period",
"definition": "A time duration specifying as a reciprocal measure of the frequency at which the periodic interval repeats.",
"min": 0,
"max": "1",
"type": [
{
"code": "PQ"
}
]
},
{
"path": "PIVL.alignment",
"representation": [
"xmlAttr"
],
"label": "Alignment to the Calendar",
"definition": "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": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "PIVL.institutionSpecifiedTime",
"representation": [
"xmlAttr"
],
"label": "Institution Specified Timing",
"definition": "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": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
}
]
}
}
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.