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
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
Raw JSON
(
canonical
form
canonical form
)
StructureDefinition
for
SampledData
)
StructureDefinition for SampledData
{
"resourceType": "StructureDefinition",
"id": "SampledData",
"meta": {
"lastUpdated": "2015-10-24T07:41:03.495+11:00"
"lastUpdated": "2016-03-31T08:01:25.570+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/SampledData",
"name": "SampledData",
"status": "draft",
"publisher": "HL7 FHIR Standard",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
}
],
"date": "2015-10-24T07:41:03+11:00",
"date": "2016-03-31T08:01:25+11:00",
"description": "Base StructureDefinition for SampledData Type",
"requirements": "There is a need for a concise way to handle the data produced by devices that sample a physical state at a high frequency.",
"fhirVersion": "1.0.2",
"fhirVersion": "1.4.0",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"kind": "datatype",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/Element",
"baseType": "Element",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
"derivation": "specialization",
"snapshot": {
"element": [
{
"path": "SampledData",
"short": "A series of measurements taken by a device",
"definition": "A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.",
"comments": "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\".",
"min": 0,
"max": "*",
"type": [
{
"code": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A (but see section 7.14 in v2.7)"
},
{
"identity": "rim",
"map": "SLIST + GLIST"
}
]
},
{
"path": "SampledData.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "SampledData.extension",
"short": "Additional Content defined by implementations",
"definition": "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.",
"comments": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "SampledData.origin",
"short": "Zero value and units",
"definition": "The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.",
"min": 1,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "SLIST.origin"
}
]
},
{
"path": "SampledData.period",
"short": "Number of milliseconds between samples",
"definition": "The length of time between sampling times, measured in milliseconds.",
"comments": "This is usually a whole number.",
"min": 1,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "GLIST.increment"
}
]
},
{
"path": "SampledData.factor",
"short": "Multiply data by this before adding to origin",
"definition": "A correction factor that is applied to the sampled data points before they are added to the origin.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"defaultValueDecimal": 1,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "SLIST.factor"
}
]
},
{
"path": "SampledData.lowerLimit",
"short": "Lower limit of detection",
"definition": "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).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (use SLIST.digits.nullFlavor)"
}
]
},
{
"path": "SampledData.upperLimit",
"short": "Upper limit of detection",
"definition": "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).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (use SLIST.digits.nullFlavor)"
}
]
},
{
"path": "SampledData.dimensions",
"short": "Number of sample points at each time point",
"definition": "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.",
"comments": "If there is more than one dimension, the code for the type of data will define the meaning of the dimensions (typically ECG data).",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (fixed to 1)"
}
]
},
{
"path": "SampledData.data",
"short": "Decimal values with spaces, or \"E\" | \"U\" | \"L\"",
"definition": "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.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "SLIST.digits"
}
]
}
]
},
"differential": {
"element": [
{
"path": "SampledData",
"short": "A series of measurements taken by a device",
"definition": "A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.",
"comments": "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\".",
"min": 0,
"max": "*",
"type": [
{
"code": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A (but see section 7.14 in v2.7)"
},
{
"identity": "rim",
"map": "SLIST + GLIST"
}
]
},
{
"path": "SampledData.origin",
"short": "Zero value and units",
"definition": "The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.",
"min": 1,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "SLIST.origin"
}
]
},
{
"path": "SampledData.period",
"short": "Number of milliseconds between samples",
"definition": "The length of time between sampling times, measured in milliseconds.",
"comments": "This is usually a whole number.",
"min": 1,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "GLIST.increment"
}
]
},
{
"path": "SampledData.factor",
"short": "Multiply data by this before adding to origin",
"definition": "A correction factor that is applied to the sampled data points before they are added to the origin.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"defaultValueDecimal": 1,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "SLIST.factor"
}
]
},
{
"path": "SampledData.lowerLimit",
"short": "Lower limit of detection",
"definition": "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).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (use SLIST.digits.nullFlavor)"
}
]
},
{
"path": "SampledData.upperLimit",
"short": "Upper limit of detection",
"definition": "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).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (use SLIST.digits.nullFlavor)"
}
]
},
{
"path": "SampledData.dimensions",
"short": "Number of sample points at each time point",
"definition": "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.",
"comments": "If there is more than one dimension, the code for the type of data will define the meaning of the dimensions (typically ECG data).",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (fixed to 1)"
}
]
},
{
"path": "SampledData.data",
"short": "Decimal values with spaces, or \"E\" | \"U\" | \"L\"",
"definition": "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.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "SLIST.digits"
}
]
}
]
}
}
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.
©
HL7.org
2011+.
FHIR
DSTU2
(v1.0.2-7202)
generated
on
Sat,
Oct
24,
2015
07:43+1100.
Links:
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.