FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagede.gematik.hddt
Resource TypeStructureDefinition
IdStructureDefinition-hddt-lung-function-testing.json
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=de.gematik.hddt@1.0.0-rc&canonical=https://gematik.de/fhir/hddt/StructureDefinition/hddt-lung-function-testing
URLhttps://gematik.de/fhir/hddt/StructureDefinition/hddt-lung-function-testing
Version1.0.0-rc
Statusactive
Date2026-01-16
NameHddtLungFunctionTesting
TitleObservation – Lung Function Testing
DescriptionProfile for capturing lung function testings as FHIR Observation resources. This profile defines the exchange of a single measurement data for the Mandatory Interoperable Value (MIV) \"Lung Function Testing\" which is technically defined by the ValueSet _hddt-miv-lung-function-testing_. This MIV is e.g. implemented by peak flow meter that can connect to a Personal Health Gateway (e.g. a mobile app for tracking lung function values) through wireless or wired communication. **Obligations and Conventions:** Each Lung Function Testing MUST either hold a reference to a _Sensor Type And Calibration Status_ [DeviceMetric](https://hl7.org/fhir/R4/devicemetric.html) resource or to a _Personal Health Device_ [Device](https://hl7.org/fhir/R4/device.html) resource (eXclusive OR). Typically the reference will be to a [Device](https://hl7.org/fhir/R4/device.html) resource, but the option to reference a [DeviceMetric](https://hl7.org/fhir/R4/devicemetric.html) resource is provided for compatibility with the overarching HDDT specification. **Constraints applied:** - `status` is restricted to _final_ - `code` is constrained to a subset of the _MIV Lung Function Testing_ ValueSet, defined by the _HddtLungFunctionTestingValues_ ValueSet. - `effective[x]` is restricted to `effectiveDateTime` and constrained as mandatory. - `value[x]` is restricted to `valueQuantity`. The elements `valueQuantity.value`, `valueQuantity.system`, and `valueQuantity.code` are constrained in a way that a value MUST be provided and that UCUM MUST be used for encoding the unit of measurement. `Observation.valueQuantity` MAY only be omitted in case of an error that accured with the measurement. In this case, `Observation.dataAbsentReason` MUST be provided. - `device` is set to be mandatory in order to provide the DiGA with information about the sensor's calibration status and with information about the static and dynamic attributes of the Personal Health Device.
CopyrightCopyright (c) 2026 gematik GmbH
TypeObservation
Kindresource

Resources that use this resource

StructureDefinition
hddt-lung-function-testing-completeObservation – Complete Lung Function Testing

Resources that this resource uses

StructureDefinition
hddt-personal-health-deviceDevice – Personal Health Device
hddt-sensor-type-and-calibration-statusDeviceMetric – Sensor Type and Calibration Status
ValueSet
hddt-lung-function-testing-valuesLung Function Testing Values from LOINC

Narrative

No narrative content found in resource


Source1

{
  "resourceType": "StructureDefinition",
  "id": "hddt-lung-function-testing",
  "url": "https://gematik.de/fhir/hddt/StructureDefinition/hddt-lung-function-testing",
  "version": "1.0.0-rc",
  "name": "HddtLungFunctionTesting",
  "title": "Observation – Lung Function Testing",
  "status": "active",
  "date": "2026-01-16",
  "publisher": "gematik GmbH",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://www.gematik.de"
        }
      ]
    }
  ],
  "description": "Profile for capturing lung function testings as FHIR Observation resources.\n\nThis profile defines the exchange of a single measurement data for the Mandatory Interoperable Value (MIV) \\\"Lung Function Testing\\\" which is technically defined \nby the ValueSet _hddt-miv-lung-function-testing_. This MIV is e.g. implemented by peak flow meter that can connect to \na Personal Health Gateway (e.g. a mobile app for tracking lung function values) through wireless or wired communication.\n\n**Obligations and Conventions:**\n\nEach Lung Function Testing MUST either hold a reference to a _Sensor Type And Calibration Status_ [DeviceMetric](https://hl7.org/fhir/R4/devicemetric.html) resource or to a \n_Personal Health Device_ [Device](https://hl7.org/fhir/R4/device.html) resource (eXclusive OR). Typically the reference will be \nto a [Device](https://hl7.org/fhir/R4/device.html) resource, but the option to reference a [DeviceMetric](https://hl7.org/fhir/R4/devicemetric.html) \nresource is provided for compatibility with the overarching HDDT specification.\n\n**Constraints applied:**  \n- `status` is restricted to _final_\n- `code` is constrained to a subset of the _MIV Lung Function Testing_ ValueSet, defined by the _HddtLungFunctionTestingValues_ ValueSet.\n- `effective[x]` is restricted to `effectiveDateTime` and constrained as mandatory.\n- `value[x]` is restricted to `valueQuantity`. The elements `valueQuantity.value`, `valueQuantity.system`, and `valueQuantity.code` are constrained in a way that a value MUST be provided and that UCUM MUST be used for encoding the unit of measurement. `Observation.valueQuantity` MAY only be omitted in case of an error that accured with the measurement. In this case, `Observation.dataAbsentReason` MUST be provided.\n- `device` is set to be mandatory in order to provide the DiGA with information about the sensor's calibration status and with information about the static and dynamic attributes of the Personal Health Device.",
  "copyright": "Copyright (c) 2026 gematik GmbH",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Observation",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Observation.status",
        "path": "Observation.status",
        "short": "Measurement status",
        "definition": "The status of the measurements is fixed to 'final'. Only verified and complete measurements with a valid value are represented.",
        "fixedCode": "final"
      },
      {
        "id": "Observation.code",
        "path": "Observation.code",
        "short": "Raw measurement type for lung function",
        "binding": {
          "strength": "required",
          "valueSet": "https://gematik.de/fhir/hddt/ValueSet/hddt-lung-function-testing-values",
          "description": "Specifies the type of measurement using codes from the ValueSet for lung function testings. Constrained via invariant to either PEF or FEV1."
        }
      },
      {
        "id": "Observation.effective[x]",
        "path": "Observation.effective[x]",
        "short": "Time of measurement",
        "definition": "The time when the lung function testing was taken.",
        "min": 1,
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Observation.value[x]",
        "path": "Observation.value[x]",
        "short": "Measured lung function value",
        "definition": "The quantitative lung function value, measured either in liters (L) for FEV1 or liters per minute (L/min) for PEF, represented as a UCUM Quantity.",
        "type": [
          {
            "code": "Quantity"
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Observation.value[x].value",
        "path": "Observation.value[x].value",
        "min": 1
      },
      {
        "id": "Observation.value[x].system",
        "path": "Observation.value[x].system",
        "min": 1,
        "fixedUri": "http://unitsofmeasure.org"
      },
      {
        "id": "Observation.value[x].code",
        "path": "Observation.value[x].code",
        "definition": "The UCUM code representing the unit of the lung function testing. The UCUM code MUST be compliant with the example unit that is linked with the LOINC code given as `Observation.code`.",
        "min": 1,
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units",
          "description": "Defines the unit of measurement using codes from the UCUM units ValueSet. The UCUM code MUST be compliant with the unit that is linked with the LOINC code given as `Observation.code`."
        }
      },
      {
        "id": "Observation.device",
        "path": "Observation.device",
        "short": "Reference to personal health device",
        "definition": "References a Device resource that describes the personal health device.",
        "min": 1,
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://gematik.de/fhir/hddt/StructureDefinition/hddt-personal-health-device",
              "https://gematik.de/fhir/hddt/StructureDefinition/hddt-sensor-type-and-calibration-status"
            ]
          }
        ]
      }
    ]
  }
}