SampledData.xml 1 <?xml version="1.0" encoding="utf-8"?> 2 <StructureDefinition xmlns="http://hl7.org/fhir"> 3 <id value="SampledData" /> 4 <meta> 5 <lastUpdated value="2019-10-31T23:29:23.356+01:00" /> 6 </meta> 7 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 8 <valueCode value="trial-use" /> 9 </extension> 10 <url value="http://hl7.org/fhir/StructureDefinition/SampledData" /> 11 <version value="4.0.1" /> 12 <name value="SampledData" /> 13 <status value="draft" /> 14 <date value="2019-10-31T23:29:23.0000000+01:00" /> 15 <publisher value="HL7 FHIR Standard" /> 16 <contact> 17 <telecom> 18 <system value="url" /> 19 <value value="http://hl7.org/fhir" /> 20 </telecom> 21 </contact> 22 <description value="Base StructureDefinition for SampledData Type: A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data." /> 23 <purpose value="There is a need for a concise way to handle the data produced by devices that sample a physical state at a high frequency." /> 24 <fhirVersion value="4.0.1" /> 25 <mapping> 26 <identity value="v2" /> 27 <uri value="http://hl7.org/v2" /> 28 <name value="HL7 v2 Mapping" /> 29 </mapping> 30 <mapping> 31 <identity value="rim" /> 32 <uri value="http://hl7.org/v3" /> 33 <name value="RIM Mapping" /> 34 </mapping> 35 <kind value="complex-type" /> 36 <abstract value="false" /> 37 <type value="SampledData" /> 38 <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element" /> 39 <derivation value="specialization" /> 40 <snapshot> 41 <element id="SampledData"> 42 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 43 <valueCode value="trial-use" /> 44 </extension> 45 <path value="SampledData" /> 46 <short value="A series of measurements taken by a device" /> 47 <definition value="A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data." /> 48 <comment value="The data is not interpretable without at least origin, period, and dimensions, but these are optional to allow a separation between the template of measurement and the actual measurement, such as between DeviceCapabilities and DeviceLog. When providing a summary view (for example with Observation.value[x]) SampledData should be represented with a brief display text such as "Sampled Data"." /> 49 <min value="0" /> 50 <max value="*" /> 51 <base> 52 <path value="SampledData" /> 53 <min value="0" /> 54 <max value="*" /> 55 </base> 56 <condition value="ele-1" /> 57 <constraint> 58 <key value="ele-1" /> 59 <severity value="error" /> 60 <human value="All FHIR elements must have a @value or children" /> 61 <expression value="hasValue() or (children().count() > id.count())" /> 62 <xpath value="@value|f:*|h:div" /> 63 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 64 </constraint> 65 <isModifier value="false" /> 66 <mapping> 67 <identity value="rim" /> 68 <map value="n/a" /> 69 </mapping> 70 <mapping> 71 <identity value="v2" /> 72 <map value="N/A (but see section 7.14 in v2.7)" /> 73 </mapping> 74 <mapping> 75 <identity value="rim" /> 76 <map value="SLIST + GLIST" /> 77 </mapping> 78 </element> 79 <element id="SampledData.id"> 80 <path value="SampledData.id" /> 81 <representation value="xmlAttr" /> 82 <short value="Unique id for inter-element referencing" /> 83 <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> 84 <min value="0" /> 85 <max value="1" /> 86 <base> 87 <path value="Element.id" /> 88 <min value="0" /> 89 <max value="1" /> 90 </base> 91 <type> 92 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> 93 <valueUrl value="string" /> 94 </extension> 95 <code value="http://hl7.org/fhirpath/System.String" /> 96 </type> 97 <isModifier value="false" /> 98 <isSummary value="false" /> 99 <mapping> 100 <identity value="rim" /> 101 <map value="n/a" /> 102 </mapping> 103 </element> 104 <element id="SampledData.extension"> 105 <path value="SampledData.extension" /> 106 <slicing> 107 <discriminator> 108 <type value="value" /> 109 <path value="url" /> 110 </discriminator> 111 <description value="Extensions are always sliced by (at least) url" /> 112 <rules value="open" /> 113 </slicing> 114 <short value="Additional content defined by implementations" /> 115 <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 manageable, 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." /> 116 <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." /> 117 <alias value="extensions" /> 118 <alias value="user content" /> 119 <min value="0" /> 120 <max value="*" /> 121 <base> 122 <path value="Element.extension" /> 123 <min value="0" /> 124 <max value="*" /> 125 </base> 126 <type> 127 <code value="Extension" /> 128 </type> 129 <constraint> 130 <key value="ele-1" /> 131 <severity value="error" /> 132 <human value="All FHIR elements must have a @value or children" /> 133 <expression value="hasValue() or (children().count() > id.count())" /> 134 <xpath value="@value|f:*|h:div" /> 135 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 136 </constraint> 137 <constraint> 138 <key value="ext-1" /> 139 <severity value="error" /> 140 <human value="Must have either extensions or value[x], not both" /> 141 <expression value="extension.exists() != value.exists()" /> 142 <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> 143 <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> 144 </constraint> 145 <isModifier value="false" /> 146 <isSummary value="false" /> 147 <mapping> 148 <identity value="rim" /> 149 <map value="n/a" /> 150 </mapping> 151 </element> 152 <element id="SampledData.origin"> 153 <path value="SampledData.origin" /> 154 <short value="Zero value and units" /> 155 <definition value="The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series." /> 156 <min value="1" /> 157 <max value="1" /> 158 <base> 159 <path value="SampledData.origin" /> 160 <min value="1" /> 161 <max value="1" /> 162 </base> 163 <type> 164 <code value="Quantity" /> 165 <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity" /> 166 </type> 167 <constraint> 168 <key value="ele-1" /> 169 <severity value="error" /> 170 <human value="All FHIR elements must have a @value or children" /> 171 <expression value="hasValue() or (children().count() > id.count())" /> 172 <xpath value="@value|f:*|h:div" /> 173 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 174 </constraint> 175 <isModifier value="false" /> 176 <isSummary value="true" /> 177 <mapping> 178 <identity value="rim" /> 179 <map value="SLIST.origin" /> 180 </mapping> 181 </element> 182 <element id="SampledData.period"> 183 <path value="SampledData.period" /> 184 <short value="Number of milliseconds between samples" /> 185 <definition value="The length of time between sampling times, measured in milliseconds." /> 186 <comment value="This is usually a whole number." /> 187 <min value="1" /> 188 <max value="1" /> 189 <base> 190 <path value="SampledData.period" /> 191 <min value="1" /> 192 <max value="1" /> 193 </base> 194 <type> 195 <code value="decimal" /> 196 </type> 197 <constraint> 198 <key value="ele-1" /> 199 <severity value="error" /> 200 <human value="All FHIR elements must have a @value or children" /> 201 <expression value="hasValue() or (children().count() > id.count())" /> 202 <xpath value="@value|f:*|h:div" /> 203 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 204 </constraint> 205 <isModifier value="false" /> 206 <isSummary value="true" /> 207 <mapping> 208 <identity value="rim" /> 209 <map value="GLIST.increment" /> 210 </mapping> 211 </element> 212 <element id="SampledData.factor"> 213 <path value="SampledData.factor" /> 214 <short value="Multiply data by this before adding to origin" /> 215 <definition value="A correction factor that is applied to the sampled data points before they are added to the origin." /> 216 <min value="0" /> 217 <max value="1" /> 218 <base> 219 <path value="SampledData.factor" /> 220 <min value="0" /> 221 <max value="1" /> 222 </base> 223 <type> 224 <code value="decimal" /> 225 </type> 226 <meaningWhenMissing value="If no factor is assigned, the data is not adjusted before adding to the origin" /> 227 <constraint> 228 <key value="ele-1" /> 229 <severity value="error" /> 230 <human value="All FHIR elements must have a @value or children" /> 231 <expression value="hasValue() or (children().count() > id.count())" /> 232 <xpath value="@value|f:*|h:div" /> 233 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 234 </constraint> 235 <isModifier value="false" /> 236 <isSummary value="true" /> 237 <mapping> 238 <identity value="rim" /> 239 <map value="SLIST.factor" /> 240 </mapping> 241 </element> 242 <element id="SampledData.lowerLimit"> 243 <path value="SampledData.lowerLimit" /> 244 <short value="Lower limit of detection" /> 245 <definition value="The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit)." /> 246 <min value="0" /> 247 <max value="1" /> 248 <base> 249 <path value="SampledData.lowerLimit" /> 250 <min value="0" /> 251 <max value="1" /> 252 </base> 253 <type> 254 <code value="decimal" /> 255 </type> 256 <constraint> 257 <key value="ele-1" /> 258 <severity value="error" /> 259 <human value="All FHIR elements must have a @value or children" /> 260 <expression value="hasValue() or (children().count() > id.count())" /> 261 <xpath value="@value|f:*|h:div" /> 262 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 263 </constraint> 264 <isModifier value="false" /> 265 <isSummary value="true" /> 266 <mapping> 267 <identity value="rim" /> 268 <map value="N/A (use SLIST.digits.nullFlavor)" /> 269 </mapping> 270 </element> 271 <element id="SampledData.upperLimit"> 272 <path value="SampledData.upperLimit" /> 273 <short value="Upper limit of detection" /> 274 <definition value="The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit)." /> 275 <min value="0" /> 276 <max value="1" /> 277 <base> 278 <path value="SampledData.upperLimit" /> 279 <min value="0" /> 280 <max value="1" /> 281 </base> 282 <type> 283 <code value="decimal" /> 284 </type> 285 <constraint> 286 <key value="ele-1" /> 287 <severity value="error" /> 288 <human value="All FHIR elements must have a @value or children" /> 289 <expression value="hasValue() or (children().count() > id.count())" /> 290 <xpath value="@value|f:*|h:div" /> 291 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 292 </constraint> 293 <isModifier value="false" /> 294 <isSummary value="true" /> 295 <mapping> 296 <identity value="rim" /> 297 <map value="N/A (use SLIST.digits.nullFlavor)" /> 298 </mapping> 299 </element> 300 <element id="SampledData.dimensions"> 301 <path value="SampledData.dimensions" /> 302 <short value="Number of sample points at each time point" /> 303 <definition value="The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once." /> 304 <comment value="If there is more than one dimension, the code for the type of data will define the meaning of the dimensions (typically ECG data)." /> 305 <min value="1" /> 306 <max value="1" /> 307 <base> 308 <path value="SampledData.dimensions" /> 309 <min value="1" /> 310 <max value="1" /> 311 </base> 312 <type> 313 <code value="positiveInt" /> 314 </type> 315 <constraint> 316 <key value="ele-1" /> 317 <severity value="error" /> 318 <human value="All FHIR elements must have a @value or children" /> 319 <expression value="hasValue() or (children().count() > id.count())" /> 320 <xpath value="@value|f:*|h:div" /> 321 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 322 </constraint> 323 <isModifier value="false" /> 324 <isSummary value="true" /> 325 <mapping> 326 <identity value="rim" /> 327 <map value="N/A (fixed to 1)" /> 328 </mapping> 329 </element> 330 <element id="SampledData.data"> 331 <path value="SampledData.data" /> 332 <short value="Decimal values with spaces, or "E" | "U" | "L"" /> 333 <definition value="A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value." /> 334 <comment value="Data may be missing if it is omitted for summarization purposes. In general, data is required for any actual use of a SampledData." /> 335 <min value="0" /> 336 <max value="1" /> 337 <base> 338 <path value="SampledData.data" /> 339 <min value="0" /> 340 <max value="1" /> 341 </base> 342 <type> 343 <code value="string" /> 344 </type> 345 <constraint> 346 <key value="ele-1" /> 347 <severity value="error" /> 348 <human value="All FHIR elements must have a @value or children" /> 349 <expression value="hasValue() or (children().count() > id.count())" /> 350 <xpath value="@value|f:*|h:div" /> 351 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 352 </constraint> 353 <isModifier value="false" /> 354 <isSummary value="false" /> 355 <mapping> 356 <identity value="rim" /> 357 <map value="SLIST.digits" /> 358 </mapping> 359 </element> 360 </snapshot> 361 <differential> 362 <element id="SampledData"> 363 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 364 <valueCode value="trial-use" /> 365 </extension> 366 <path value="SampledData" /> 367 <short value="A series of measurements taken by a device" /> 368 <definition value="A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data." /> 369 <comment value="The data is not interpretable without at least origin, period, and dimensions, but these are optional to allow a separation between the template of measurement and the actual measurement, such as between DeviceCapabilities and DeviceLog. When providing a summary view (for example with Observation.value[x]) SampledData should be represented with a brief display text such as "Sampled Data"." /> 370 <min value="0" /> 371 <max value="*" /> 372 <mapping> 373 <identity value="v2" /> 374 <map value="N/A (but see section 7.14 in v2.7)" /> 375 </mapping> 376 <mapping> 377 <identity value="rim" /> 378 <map value="SLIST + GLIST" /> 379 </mapping> 380 </element> 381 <element id="SampledData.origin"> 382 <path value="SampledData.origin" /> 383 <short value="Zero value and units" /> 384 <definition value="The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series." /> 385 <min value="1" /> 386 <max value="1" /> 387 <type> 388 <code value="Quantity" /> 389 <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity" /> 390 </type> 391 <isSummary value="true" /> 392 <mapping> 393 <identity value="rim" /> 394 <map value="SLIST.origin" /> 395 </mapping> 396 </element> 397 <element id="SampledData.period"> 398 <path value="SampledData.period" /> 399 <short value="Number of milliseconds between samples" /> 400 <definition value="The length of time between sampling times, measured in milliseconds." /> 401 <comment value="This is usually a whole number." /> 402 <min value="1" /> 403 <max value="1" /> 404 <type> 405 <code value="decimal" /> 406 </type> 407 <isSummary value="true" /> 408 <mapping> 409 <identity value="rim" /> 410 <map value="GLIST.increment" /> 411 </mapping> 412 </element> 413 <element id="SampledData.factor"> 414 <path value="SampledData.factor" /> 415 <short value="Multiply data by this before adding to origin" /> 416 <definition value="A correction factor that is applied to the sampled data points before they are added to the origin." /> 417 <min value="0" /> 418 <max value="1" /> 419 <type> 420 <code value="decimal" /> 421 </type> 422 <meaningWhenMissing value="If no factor is assigned, the data is not adjusted before adding to the origin" /> 423 <isSummary value="true" /> 424 <mapping> 425 <identity value="rim" /> 426 <map value="SLIST.factor" /> 427 </mapping> 428 </element> 429 <element id="SampledData.lowerLimit"> 430 <path value="SampledData.lowerLimit" /> 431 <short value="Lower limit of detection" /> 432 <definition value="The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit)." /> 433 <min value="0" /> 434 <max value="1" /> 435 <type> 436 <code value="decimal" /> 437 </type> 438 <isSummary value="true" /> 439 <mapping> 440 <identity value="rim" /> 441 <map value="N/A (use SLIST.digits.nullFlavor)" /> 442 </mapping> 443 </element> 444 <element id="SampledData.upperLimit"> 445 <path value="SampledData.upperLimit" /> 446 <short value="Upper limit of detection" /> 447 <definition value="The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit)." /> 448 <min value="0" /> 449 <max value="1" /> 450 <type> 451 <code value="decimal" /> 452 </type> 453 <isSummary value="true" /> 454 <mapping> 455 <identity value="rim" /> 456 <map value="N/A (use SLIST.digits.nullFlavor)" /> 457 </mapping> 458 </element> 459 <element id="SampledData.dimensions"> 460 <path value="SampledData.dimensions" /> 461 <short value="Number of sample points at each time point" /> 462 <definition value="The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once." /> 463 <comment value="If there is more than one dimension, the code for the type of data will define the meaning of the dimensions (typically ECG data)." /> 464 <min value="1" /> 465 <max value="1" /> 466 <type> 467 <code value="positiveInt" /> 468 </type> 469 <isSummary value="true" /> 470 <mapping> 471 <identity value="rim" /> 472 <map value="N/A (fixed to 1)" /> 473 </mapping> 474 </element> 475 <element id="SampledData.data"> 476 <path value="SampledData.data" /> 477 <short value="Decimal values with spaces, or "E" | "U" | "L"" /> 478 <definition value="A series of data points which are decimal values separated by a single space (character u20). The special values "E" (error), "L" (below detection limit) and "U" (above detection limit) can also be used in place of a decimal value." /> 479 <comment value="Data may be missing if it is omitted for summarization purposes. In general, data is required for any actual use of a SampledData." /> 480 <min value="0" /> 481 <max value="1" /> 482 <type> 483 <code value="string" /> 484 </type> 485 <mapping> 486 <identity value="rim" /> 487 <map value="SLIST.digits" /> 488 </mapping> 489 </element> 490 </differential> 491 </StructureDefinition>