StructureDefinition
for
Period
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KG
goAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgC
sPVYVAgIJrA/sAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,R0lGODlhEAAQAMQfAOvGUf7ztuvPMf/78/fkl/Pbg+u8Rvjqteu2Pf3zxPz36Pz0z+vTmPzurPvuw
/npofbjquvNefHVduuyN+uuMu3Oafbgjfnqvf/3zv/3xevPi+vRjP/20/bmsP///////yH5BAEAAB8ALAAAAAAQABAAAAV24CeOZG
mepqeqqOgxjBZFa+19r4ftWQUAgqDgltthMshMIJAZ4jYDHsBARSAmFOJvq+g6HIdEFgcYmBWNxoNAsDjGHgBnmV5bCoUDHLBIq9s
FEhIdcAYJdYASFRUQhQkLCwkOFwcdEBAXhVabE52ecDahKy0oIQA7
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4pxTime range defined by start and end date/time
Elements defined in Ancestors:
unique id for the element within a resource (for internal references). This may be any
string value that does not contain spaces.,
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.
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KG
goAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgC
sPVYVAgIJrA/sAAAAASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW
XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i
8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KG
goAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAI0lEQVR42u3QIQEAAAACIL/6/4MvTAQOkLYBAAB4kAAAANwMad9AqkRjgNAAAA
AASUVORK5CYII=)
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
3RJTUUH3wYeFzME+lXFigAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+3OsRUAIAjEUO
L+O8cJABttJM11/x1qZAGqRBEVcNIqdWj1efDqQbb3HwwwwEfABmQUHSPM9dtDAAAAAElFTkSuQmCC
data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW
XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i
8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC
Period.end : The end of the period. If the end of the period is missing, it means that
the period is ongoing. The start may be in the past, and the end date in the future, which
means that period is expected/planned to end at that time.
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
padding:0px 4px 0px 4px
<?xml version="1.0" encoding="UTF-8"?>
Documentation for this format
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. "the patient was an inpatient
of the hospital for this time range") or one value from the range applies (e.g. "give
to the patient between these two times"). If duration is required, specify the type
as Interval|Duration.
IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed
="true" and highClosed="true"]
unique id for the element within a resource (for internal references). This may be any
string value that does not contain spaces.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Period"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align:
top;">
<tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align:
top">
<th class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom:
3px">
<a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom:
3px">
<a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom:
3px">
<a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom:
3px; width: 100px">
<a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom:
3px">
<a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a> <span style="float: right"> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"> <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/> </a> </span> </th> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAg
DsHd9/w4EQIOamFnaBgAA4MMKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Element"/> <a href="datatypes-definitions.html#Period" title="Period : A time period defined by a start and end date and optionally time.">Period</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
<a href="versions.html#std-process" style="padding-left: 3px; padding-right: 3px; border: 1px grey solid; font-weight: bold;
color: black; background-color: #e6ffe6; padding-left: 3px; padding-right: 3px;
border: 1px grey solid; font-weight: bold; color: black; background-color: #e6ffe6" title="Standards Status = Normative">N</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px"/>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="types.html#Element">Element</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Time range defined by start and end date/time
<br/> <span style="font-style: italic" title="per-1">+ Rule: If present, start SHALL have a lower or equal value than end</span> <br/> <br/> Elements defined in Ancestors: <a href="types.html#Element" title="Unique id for the element within a resource (for internal references). This may
be any string value that does not contain spaces.">id</a> ,
<a href="types.html#Element" title="May be used to represent additional information that is not part of the basic definition
of the element. To make the use of extensions safe and managable, there is a strict
set of governance applied to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL be met as part
of the definition of the extension.">extension</a>
</td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
#F7F7F7">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#Period.start" title="Period.start : The start of the period. The boundary is inclusive.">start</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
<a href="conformance-rules.html#constraints" style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold;
color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px;
border: 1px maroon solid; font-weight: bold; color: #301212; background-color:
#fdf4f4;" title="This element has or is affected by some invariants">C</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#dateTime">dateTime</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">Starting time with inclusive boundary
<br/> </td> </tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
white">
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAg
DsHd9/w4EQIOamFnaBgAA4MMKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)">
<img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#Period.end" title="Period.end : The end of the period. If the end of the period is missing, it means
no end was known or planned at the time the instance was created. The start may
be in the past, and the end date in the future, which means that period is expected/planned
to end at that time.">end</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null; padding-left: 3px; padding-right:
3px; color: black; null" title="This element is included in summaries">Σ</a>
<a href="conformance-rules.html#constraints" style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold;
color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px;
border: 1px maroon solid; font-weight: bold; color: #301212; background-color:
#fdf4f4;" title="This element has or is affected by some invariants">C</a>
</td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td>
<td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">
<a href="datatypes.html#dateTime">dateTime</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : var(--ig-left,left); background-color: white;
border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px">End time with inclusive boundary, if not ongoing
<br/> </td> </tr> <tr> <td class="hierarchy" colspan="5"> <br/> <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"> <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/> Documentation for this format </a> </td> </tr> </table> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="fhir"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/Period"/> <version value="6.0.0-ballot3"/> <name value="Period"/> <status value="active"/> <experimental value="false"/> <date value="2025-12-17T09:50:17+00:00"/> <publisher value="HL7 International / FHIR Infrastructure"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fiwg"/> </telecom> </contact> <description value="Period Type: A time period defined by a start and end date and optionally time."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <fhirVersion value="6.0.0-ballot3"/> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 V2 Mapping"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <kind value="complex-type"/> <abstract value="false"/> <type value="Period"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DataType"/> <derivation value="specialization"/> <snapshot> <element id="Period"> <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."/> <comment value="A Period specifies a range of time; the context of use will specify whether the
entire range applies (e.g. "the patient was an inpatient of the hospital for
this time range") or one value from the range applies (e.g. "give to
the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#
Duration)."/>
<min value="0"/> <max value="*"/> <base> <path value="Period"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <constraint> <key value="per-1"/> <severity value="error"/> <human value="If present, start SHALL have a lower or equal value than end"/> <expression value="start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary
())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Period"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a,IVL<TS>[lowClosed="true" and highClosed="true"] or
URG<TS>[lowClosed="true" and highClosed="true"]"/>
</mapping> <mapping> <identity value="v2"/> <map value="DR"/> </mapping> </element> <element id="Period.id"> <path value="Period.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <definition value="Unique id for the element within a resource (for internal references). This may
be any string value that does not contain spaces."/>
<min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base>
<type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <condition value="ele-1"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Period.extension"> <path value="Period.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <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.
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.
The end of the period. If the end of the period is missing, it means that the period is
ongoing. The start may be in the past, and the end date in the future, which means that
period is expected/planned to end at that time.
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.
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. "the patient was an inpatient
of the hospital for this time range") or one value from the range applies (e.g. "give
to the patient between these two times"). If duration is required, specify the type
as Interval|Duration.
IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed
="true" and highClosed="true"]
The end of the period. If the end of the period is missing, it means that the period is
ongoing. The start may be in the past, and the end date in the future, which means that
period is expected/planned to end at that time.
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.
of the element. To make the use of extensions safe and managable, there is a strict
set of governance applied to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL be met as part
of the definition of the extension."/>
<comment 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="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Period.start"> <path value="Period.start"/> <short value="Starting time with inclusive boundary"/> <definition value="The start of the period. The boundary is inclusive."/> <comment value="If the low element is missing, the meaning is that the low boundary is not known."/> <min value="0"/> <max value="1"/> <base> <path value="Period.start"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <condition value="per-1"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="DR.1"/> </mapping> <mapping> <identity value="rim"/> <map value="./low"/> </mapping> </element> <element id="Period.end"> <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 no end was
known or planned at the time the instance was created. The start may be in the
past, and the end date in the future, which means that period is expected/planned
to end at that time."/>
<comment value="The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a
period that has an end value of 2012-02-03."/>
<min value="0"/> <max value="1"/> <base> <path value="Period.end"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <meaningWhenMissing value="If the end of the period is missing, it means that the period is ongoing"/> <condition value="per-1"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="DR.2"/> </mapping> <mapping> <identity value="rim"/> <map value="./high"/> </mapping> </element> </snapshot> <differential> <element id="Period"> <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."/> <comment value="A Period specifies a range of time; the context of use will specify whether the
entire range applies (e.g. "the patient was an inpatient of the hospital for
this time range") or one value from the range applies (e.g. "give to
the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#
Duration)."/>
<min value="0"/> <max value="*"/> <constraint> <key value="per-1"/> <severity value="error"/> <human value="If present, start SHALL have a lower or equal value than end"/> <expression value="start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary
())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Period"/> </constraint> <mapping> <identity value="v2"/> <map value="DR"/> </mapping> <mapping> <identity value="rim"/> <map value="IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lo
wClosed="true" and highClosed="true"]"/>
</mapping> </element> <element id="Period.start"> <path value="Period.start"/> <short value="Starting time with inclusive boundary"/> <definition value="The start of the period. The boundary is inclusive."/> <comment 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"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="DR.1"/> </mapping> <mapping> <identity value="rim"/> <map value="./low"/> </mapping> </element> <element id="Period.end"> <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 no end was
known or planned at the time the instance was created. The start may be in the
past, and the end date in the future, which means that period is expected/planned
to end at that time."/>
<comment value="The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a
period that has an end value of 2012-02-03."/>
<min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <meaningWhenMissing value="If the end of the period is missing, it means that the period is ongoing"/> <condition value="per-1"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="DR.2"/> </mapping> <mapping> <identity value="rim"/> <map value="./high"/> </mapping> </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.