FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/SampledBeatsPerMinute

Packagedk.4s-online.raplito
Resource TypeStructureDefinition
IdSampledBeatsPerMinute
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=dk.4s-online.raplito@0.1.2&canonical=https://4s-online.dk/raplito/StructureDefinition/SampledBeatsPerMinute
URLhttps://4s-online.dk/raplito/StructureDefinition/SampledBeatsPerMinute
Version0.1.0
Statusactive
Date2021-03-01
NameSampledBeatsPerMinute
TitleSampledData of type beats-per-minute
DescriptionSampledData containing data with the unit beats-per-minute
TypeSampledData
Kindcomplex-type

Resources that use this resource

StructureDefinition
HeartRateObservationRaplito Heart Rate Monitoring Observation

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

NameFlagsCard.TypeDescription & Constraintsdoco
.. SampledData 0..*SampledDataA series of measurements taken by a device
... origin
.... system S1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S1..1codeCoded form of the unit
Fixed Value: /min
... dimensions S1..1positiveIntNumber of sample points at each time point
Fixed Value: 1

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "SampledBeatsPerMinute",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://4s-online.dk/raplito/StructureDefinition/SampledBeatsPerMinute",
  "version": "0.1.0",
  "name": "SampledBeatsPerMinute",
  "title": "SampledData of type beats-per-minute",
  "status": "active",
  "experimental": true,
  "date": "2021-03-01",
  "publisher": "Alexandra Instituttet",
  "contact": [
    {
      "name": "Jacob Andersen",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:jacob.andersen@alexandra.dk"
        }
      ]
    }
  ],
  "description": "SampledData containing data with the unit beats-per-minute",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2 Mapping"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "type": "SampledData",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/SampledData",
  "derivation": "constraint",
  "snapshot": {
    "element": [
      {
        "id": "SampledData",
        "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.",
        "comment": "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": "*",
        "base": {
          "path": "SampledData",
          "min": 0,
          "max": "*"
        },
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "v2",
            "map": "N/A (but see section 7.14 in v2.7)"
          },
          {
            "identity": "rim",
            "map": "SLIST + GLIST"
          }
        ]
      },
      {
        "id": "SampledData.id",
        "path": "SampledData.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "string"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "SampledData.extension",
        "path": "SampledData.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "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. 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.",
        "comment": "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"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "SampledData.origin",
        "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",
        "base": {
          "path": "SampledData.origin",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Quantity",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
            ]
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "SLIST.origin"
          }
        ]
      },
      {
        "id": "SampledData.origin.id",
        "path": "SampledData.origin.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "string"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "SampledData.origin.extension",
        "path": "SampledData.origin.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "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. 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.",
        "comment": "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"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "SampledData.origin.value",
        "path": "SampledData.origin.value",
        "short": "Numerical value (with implicit precision)",
        "definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
        "comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).",
        "requirements": "Precision is handled implicitly in almost all cases of measurement.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Quantity.value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "decimal"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "SN.2  / CQ - N/A"
          },
          {
            "identity": "rim",
            "map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"
          }
        ]
      },
      {
        "id": "SampledData.origin.comparator",
        "path": "SampledData.origin.comparator",
        "short": "< | <= | >= | > - how to understand the value",
        "definition": "Not allowed to be used in this context",
        "requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
        "min": 0,
        "max": "0",
        "base": {
          "path": "Quantity.comparator",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": true,
        "isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "QuantityComparator"
            }
          ],
          "strength": "required",
          "description": "How the Quantity should be understood and represented.",
          "valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1"
        },
        "mapping": [
          {
            "identity": "v2",
            "map": "SN.1  / CQ.1"
          },
          {
            "identity": "rim",
            "map": "IVL properties"
          }
        ]
      },
      {
        "id": "SampledData.origin.unit",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean": true
          }
        ],
        "path": "SampledData.origin.unit",
        "short": "Unit representation",
        "definition": "A human-readable form of the unit.",
        "requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Quantity.unit",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "(see OBX.6 etc.) / CQ.2"
          },
          {
            "identity": "rim",
            "map": "PQ.unit"
          }
        ]
      },
      {
        "id": "SampledData.origin.system",
        "path": "SampledData.origin.system",
        "short": "System that defines coded unit form",
        "definition": "The identification of the system that provides the coded form of the unit.",
        "requirements": "Need to know the system that defines the coded form of the unit.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Quantity.system",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "uri"
          }
        ],
        "fixedUri": "http://unitsofmeasure.org",
        "condition": [
          "qty-3"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mustSupport": true,
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "(see OBX.6 etc.) / CQ.2"
          },
          {
            "identity": "rim",
            "map": "CO.codeSystem, PQ.translation.codeSystem"
          }
        ]
      },
      {
        "id": "SampledData.origin.code",
        "path": "SampledData.origin.code",
        "short": "Coded form of the unit",
        "definition": "A computer processable form of the unit in some unit representation system.",
        "comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency.  The context of use may additionally require a code from a particular system.",
        "requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Quantity.code",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "fixedCode": "/min",
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mustSupport": true,
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "v2",
            "map": "(see OBX.6 etc.) / CQ.2"
          },
          {
            "identity": "rim",
            "map": "PQ.code, MO.currency, PQ.translation.code"
          }
        ]
      },
      {
        "id": "SampledData.period",
        "path": "SampledData.period",
        "short": "Number of milliseconds between samples",
        "definition": "The length of time between sampling times, measured in milliseconds.",
        "comment": "This is usually a whole number.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "SampledData.period",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "decimal"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "GLIST.increment"
          }
        ]
      },
      {
        "id": "SampledData.factor",
        "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",
        "base": {
          "path": "SampledData.factor",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "decimal"
          }
        ],
        "meaningWhenMissing": "If no factor is assigned, the data is not adjusted before adding to the origin",
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "SLIST.factor"
          }
        ]
      },
      {
        "id": "SampledData.lowerLimit",
        "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",
        "base": {
          "path": "SampledData.lowerLimit",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "decimal"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A (use SLIST.digits.nullFlavor)"
          }
        ]
      },
      {
        "id": "SampledData.upperLimit",
        "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",
        "base": {
          "path": "SampledData.upperLimit",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "decimal"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A (use SLIST.digits.nullFlavor)"
          }
        ]
      },
      {
        "id": "SampledData.dimensions",
        "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.",
        "comment": "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",
        "base": {
          "path": "SampledData.dimensions",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "positiveInt"
          }
        ],
        "fixedPositiveInt": 1,
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mustSupport": true,
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A (fixed to 1)"
          }
        ]
      },
      {
        "id": "SampledData.data",
        "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.",
        "comment": "Data may be missing if it is omitted for summarization purposes. In general, data is required for any actual use of a SampledData.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "SampledData.data",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "SLIST.digits"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "SampledData",
        "path": "SampledData"
      },
      {
        "id": "SampledData.origin.system",
        "path": "SampledData.origin.system",
        "min": 1,
        "fixedUri": "http://unitsofmeasure.org",
        "mustSupport": true
      },
      {
        "id": "SampledData.origin.code",
        "path": "SampledData.origin.code",
        "min": 1,
        "fixedCode": "/min",
        "mustSupport": true
      },
      {
        "id": "SampledData.dimensions",
        "path": "SampledData.dimensions",
        "fixedPositiveInt": 1,
        "mustSupport": true
      }
    ]
  }
}