hddt-cgm-summary-operation
type: OperationDefinition
node role: treeRoot
id:
  v: hddt-cgm-summary-operation
text:
  status:
    v: generated
  div:
    v: Generated Narrative: OperationDefinition hddt-cgm-summary-operation Parameters Use Name Scope Cardinality Type Binding Documentation IN effectivePeriodStart 0..1 dateTime Start of effective period IN effectivePeriodEnd 0..1 dateTime End of effective period IN related 0..1 boolean If true, include related Device and DeviceMetric in the result bundle OUT result 1..1 Reference (Bundle – HDDT CGM Summary Report) Result bundle (HTTP 200 OK) containing summary data of measurements and optionally related resources
url:
  v: https://gematik.de/fhir/hddt/OperationDefinition/hddt-cgm-summary-operation
  l: hddt-cgm-summary-operation
version:
  v: 1.0.0-rc2
name:
  v: HddtCgmSummaryOperation
title:
  v: Search Operation for summary data measurement
status:
  v: active
kind:
  v: operation
experimental:
  v: false
date:
  v: 2026-03-04
publisher:
  v: gematik GmbH
contact:
  name:
    v: gematik GmbH
  telecom:
    system:
      v: url
    value:
      v: https://www.gematik.de
description:
  v: The `$hddt-cgm-summary` operation is defined on the *Observation* resource type. It allows clients to request CGM summary data filtered by effective period, and optionally include related device context (Device, DeviceMetric). **Use cases supported by this operation include:** - Retrieving CGM summary statistics (mean glucose, time-in-range, GMI, etc.) for a patient over a specified interval **Input Parameters:** - `effectivePeriodStart` *(dateTime, optional)*: Lower bound of the observation effective period. - `effectivePeriodEnd` *(dateTime, optional)*: Upper bound of the observation effective period. - `related` *(boolean, optional)*: If true, the response bundle also contains related Device and DeviceMetric resources. **Output Parameter:** - `result` *(Reference, required)*: A Bundle conforming to profile `HddtCgmSummary` profile containing all matching CGM Observations and, if requested, their related devices. **Error handling (OperationOutcome):** - `MSG_PARAM_UNKNOWN`: Returned when an unsupported input parameter is used. - `MSG_PARAM_INVALID`: Returned when a parameter value is invalid (e.g., bad date format). - `MSG_NO_MATCH`: Returned when no matching observations are found. - `MSG_BAD_SYNTAX`: Returned when the request is malformed.
affects state:
  v: false
code:
  v: hddt-cgm-summary
system:
  v: false
type:
  v: true
instance:
  v: false
parameter:
  name:
    v: effectivePeriodStart
  use:
    v: in
  min:
    v: 0
  max:
    v: 1
  documentation:
    v: Start of effective period
  type:
    v: dateTime
parameter:
  name:
    v: effectivePeriodEnd
  use:
    v: in
  min:
    v: 0
  max:
    v: 1
  documentation:
    v: End of effective period
  type:
    v: dateTime
parameter:
  name:
    v: related
  use:
    v: in
  min:
    v: 0
  max:
    v: 1
  documentation:
    v: If true, include related Device and DeviceMetric in the result bundle
  type:
    v: boolean
parameter:
  name:
    v: result
  use:
    v: out
  min:
    v: 1
  max:
    v: 1
  documentation:
    v: Result bundle (HTTP 200 OK) containing summary data of measurements and optionally related resources
  type:
    v: Reference
  target profile:
    v: https://gematik.de/fhir/hddt/StructureDefinition/hddt-cgm-summary
    l: hddt-cgm-summary