Period.xml 1 <?xml version="1.0" encoding="utf-8"?> 2 <StructureDefinition xmlns="http://hl7.org/fhir"> 3 <id value="Period" /> 4 <meta> 5 <lastUpdated value="2023-03-26T06:21:02.749+02:00" /> 6 </meta> 7 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 8 <valueCode value="normative" /> 9 </extension> 10 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> 11 <valueCode value="4.0.0" /> 12 </extension> 13 <url value="http://hl7.org/fhir/StructureDefinition/Period" /> 14 <version value="5.0.0" /> 15 <name value="Period" /> 16 <status value="active" /> 17 <experimental value="false" /> 18 <date value="2023-03-26T06:21:02.0000000+02:00" /> 19 <publisher value="HL7 FHIR Standard" /> 20 <contact> 21 <telecom> 22 <system value="url" /> 23 <value value="http://hl7.org/fhir" /> 24 </telecom> 25 </contact> 26 <description value="Period Type: A time period defined by a start and end date and optionally time." /> 27 <jurisdiction> 28 <coding> 29 <system value="http://unstats.un.org/unsd/methods/m49/m49.htm" /> 30 <code value="001" /> 31 <display value="World" /> 32 </coding> 33 </jurisdiction> 34 <fhirVersion value="5.0.0" /> 35 <mapping> 36 <identity value="v2" /> 37 <uri value="http://hl7.org/v2" /> 38 <name value="HL7 V2 Mapping" /> 39 </mapping> 40 <mapping> 41 <identity value="rim" /> 42 <uri value="http://hl7.org/v3" /> 43 <name value="RIM Mapping" /> 44 </mapping> 45 <kind value="complex-type" /> 46 <abstract value="false" /> 47 <type value="Period" /> 48 <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DataType" /> 49 <derivation value="specialization" /> 50 <snapshot> 51 <element id="Period"> 52 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 53 <valueCode value="normative" /> 54 </extension> 55 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> 56 <valueCode value="4.0.0" /> 57 </extension> 58 <path value="Period" /> 59 <short value="Time range defined by start and end date/time" /> 60 <definition value="A time period defined by a start and end date and optionally time." /> 61 <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)." /> 62 <min value="0" /> 63 <max value="*" /> 64 <base> 65 <path value="Period" /> 66 <min value="0" /> 67 <max value="*" /> 68 </base> 69 <constraint> 70 <key value="ele-1" /> 71 <severity value="error" /> 72 <human value="All FHIR elements must have a @value or children" /> 73 <expression value="hasValue() or (children().count() > id.count())" /> 74 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 75 </constraint> 76 <constraint> 77 <key value="per-1" /> 78 <severity value="error" /> 79 <human value="If present, start SHALL have a lower or equal value than end" /> 80 <expression value="start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())" /> 81 <source value="http://hl7.org/fhir/StructureDefinition/Period" /> 82 </constraint> 83 <isModifier value="false" /> 84 <mapping> 85 <identity value="rim" /> 86 <map value="n/a,IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]" /> 87 </mapping> 88 <mapping> 89 <identity value="v2" /> 90 <map value="DR" /> 91 </mapping> 92 </element> 93 <element id="Period.id"> 94 <path value="Period.id" /> 95 <representation value="xmlAttr" /> 96 <short value="Unique id for inter-element referencing" /> 97 <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> 98 <min value="0" /> 99 <max value="1" /> 100 <base> 101 <path value="Element.id" /> 102 <min value="0" /> 103 <max value="1" /> 104 </base> 105 <type> 106 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> 107 <valueUrl value="id" /> 108 </extension> 109 <code value="http://hl7.org/fhirpath/System.String" /> 110 </type> 111 <condition value="ele-1" /> 112 <isModifier value="false" /> 113 <isSummary value="false" /> 114 <mapping> 115 <identity value="rim" /> 116 <map value="n/a" /> 117 </mapping> 118 </element> 119 <element id="Period.extension"> 120 <path value="Period.extension" /> 121 <slicing> 122 <discriminator> 123 <type value="value" /> 124 <path value="url" /> 125 </discriminator> 126 <description value="Extensions are always sliced by (at least) url" /> 127 <rules value="open" /> 128 </slicing> 129 <short value="Additional content defined by implementations" /> 130 <definition value="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." /> 131 <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." /> 132 <alias value="extensions" /> 133 <alias value="user content" /> 134 <min value="0" /> 135 <max value="*" /> 136 <base> 137 <path value="Element.extension" /> 138 <min value="0" /> 139 <max value="*" /> 140 </base> 141 <type> 142 <code value="Extension" /> 143 </type> 144 <constraint> 145 <key value="ele-1" /> 146 <severity value="error" /> 147 <human value="All FHIR elements must have a @value or children" /> 148 <expression value="hasValue() or (children().count() > id.count())" /> 149 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 150 </constraint> 151 <constraint> 152 <key value="ext-1" /> 153 <severity value="error" /> 154 <human value="Must have either extensions or value[x], not both" /> 155 <expression value="extension.exists() != value.exists()" /> 156 <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> 157 </constraint> 158 <isModifier value="false" /> 159 <isSummary value="false" /> 160 <mapping> 161 <identity value="rim" /> 162 <map value="n/a" /> 163 </mapping> 164 </element> 165 <element id="Period.start"> 166 <path value="Period.start" /> 167 <short value="Starting time with inclusive boundary" /> 168 <definition value="The start of the period. The boundary is inclusive." /> 169 <comment value="If the low element is missing, the meaning is that the low boundary is not known." /> 170 <min value="0" /> 171 <max value="1" /> 172 <base> 173 <path value="Period.start" /> 174 <min value="0" /> 175 <max value="1" /> 176 </base> 177 <type> 178 <code value="dateTime" /> 179 </type> 180 <condition value="per-1" /> 181 <constraint> 182 <key value="ele-1" /> 183 <severity value="error" /> 184 <human value="All FHIR elements must have a @value or children" /> 185 <expression value="hasValue() or (children().count() > id.count())" /> 186 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 187 </constraint> 188 <isModifier value="false" /> 189 <isSummary value="true" /> 190 <mapping> 191 <identity value="v2" /> 192 <map value="DR.1" /> 193 </mapping> 194 <mapping> 195 <identity value="rim" /> 196 <map value="./low" /> 197 </mapping> 198 </element> 199 <element id="Period.end"> 200 <path value="Period.end" /> 201 <short value="End time with inclusive boundary, if not ongoing" /> 202 <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." /> 203 <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." /> 204 <min value="0" /> 205 <max value="1" /> 206 <base> 207 <path value="Period.end" /> 208 <min value="0" /> 209 <max value="1" /> 210 </base> 211 <type> 212 <code value="dateTime" /> 213 </type> 214 <meaningWhenMissing value="If the end of the period is missing, it means that the period is ongoing" /> 215 <condition value="per-1" /> 216 <constraint> 217 <key value="ele-1" /> 218 <severity value="error" /> 219 <human value="All FHIR elements must have a @value or children" /> 220 <expression value="hasValue() or (children().count() > id.count())" /> 221 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 222 </constraint> 223 <isModifier value="false" /> 224 <isSummary value="true" /> 225 <mapping> 226 <identity value="v2" /> 227 <map value="DR.2" /> 228 </mapping> 229 <mapping> 230 <identity value="rim" /> 231 <map value="./high" /> 232 </mapping> 233 </element> 234 </snapshot> 235 <differential> 236 <element id="Period"> 237 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 238 <valueCode value="normative" /> 239 </extension> 240 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> 241 <valueCode value="4.0.0" /> 242 </extension> 243 <path value="Period" /> 244 <short value="Time range defined by start and end date/time" /> 245 <definition value="A time period defined by a start and end date and optionally time." /> 246 <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)." /> 247 <min value="0" /> 248 <max value="*" /> 249 <constraint> 250 <key value="per-1" /> 251 <severity value="error" /> 252 <human value="If present, start SHALL have a lower or equal value than end" /> 253 <expression value="start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())" /> 254 <source value="http://hl7.org/fhir/StructureDefinition/Period" /> 255 </constraint> 256 <mapping> 257 <identity value="v2" /> 258 <map value="DR" /> 259 </mapping> 260 <mapping> 261 <identity value="rim" /> 262 <map value="IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]" /> 263 </mapping> 264 </element> 265 <element id="Period.start"> 266 <path value="Period.start" /> 267 <short value="Starting time with inclusive boundary" /> 268 <definition value="The start of the period. The boundary is inclusive." /> 269 <comment value="If the low element is missing, the meaning is that the low boundary is not known." /> 270 <min value="0" /> 271 <max value="1" /> 272 <type> 273 <code value="dateTime" /> 274 </type> 275 <condition value="per-1" /> 276 <isSummary value="true" /> 277 <mapping> 278 <identity value="v2" /> 279 <map value="DR.1" /> 280 </mapping> 281 <mapping> 282 <identity value="rim" /> 283 <map value="./low" /> 284 </mapping> 285 </element> 286 <element id="Period.end"> 287 <path value="Period.end" /> 288 <short value="End time with inclusive boundary, if not ongoing" /> 289 <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." /> 290 <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." /> 291 <min value="0" /> 292 <max value="1" /> 293 <type> 294 <code value="dateTime" /> 295 </type> 296 <meaningWhenMissing value="If the end of the period is missing, it means that the period is ongoing" /> 297 <condition value="per-1" /> 298 <isSummary value="true" /> 299 <mapping> 300 <identity value="v2" /> 301 <map value="DR.2" /> 302 </mapping> 303 <mapping> 304 <identity value="rim" /> 305 <map value="./high" /> 306 </mapping> 307 </element> 308 </differential> 309 </StructureDefinition>