FHIR IG analytics| Package | de.gematik.hddt |
| Resource Type | OperationDefinition |
| Id | OperationDefinition-hddt-cgm-summary-operation.json |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=de.gematik.hddt@1.0.0-rc2&canonical=https://gematik.de/fhir/hddt/OperationDefinition/hddt-cgm-summary-operation |
| URL | https://gematik.de/fhir/hddt/OperationDefinition/hddt-cgm-summary-operation |
| Version | 1.0.0-rc2 |
| Status | active |
| Date | 2026-03-04 |
| Name | HddtCgmSummaryOperation |
| Title | Search Operation for summary data measurement |
| Description | 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. |
| Type | true |
| Kind | operation |
No resources found
No resources found
No narrative content found in resource
{
"resourceType": "OperationDefinition",
"id": "hddt-cgm-summary-operation",
"url": "https://gematik.de/fhir/hddt/OperationDefinition/hddt-cgm-summary-operation",
"title": "Search Operation for summary data measurement",
"description": "The `$hddt-cgm-summary` operation is defined on the *Observation* resource type. \nIt allows clients to request CGM summary data filtered by effective period, and optionally include related device context (Device, DeviceMetric). \n\n**Use cases supported by this operation include:** \n- Retrieving CGM summary statistics (mean glucose, time-in-range, GMI, etc.) for a patient over a specified interval \n\n**Input Parameters:** \n- `effectivePeriodStart` *(dateTime, optional)*: Lower bound of the observation effective period. \n- `effectivePeriodEnd` *(dateTime, optional)*: Upper bound of the observation effective period. \n- `related` *(boolean, optional)*: If true, the response bundle also contains related Device and DeviceMetric resources. \n\n**Output Parameter:** \n- `result` *(Reference, required)*: A Bundle conforming to profile `HddtCgmSummary` profile containing all matching CGM Observations and, if requested, their related devices. \n\n**Error handling (OperationOutcome):** \n- `MSG_PARAM_UNKNOWN`: Returned when an unsupported input parameter is used. \n- `MSG_PARAM_INVALID`: Returned when a parameter value is invalid (e.g., bad date format). \n- `MSG_NO_MATCH`: Returned when no matching observations are found. \n- `MSG_BAD_SYNTAX`: Returned when the request is malformed. ",
"name": "HddtCgmSummaryOperation",
"status": "active",
"version": "1.0.0-rc2",
"experimental": false,
"kind": "operation",
"publisher": "gematik GmbH",
"date": "2026-03-04",
"affectsState": false,
"code": "hddt-cgm-summary",
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "effectivePeriodStart",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Start of effective period",
"type": "dateTime"
},
{
"name": "effectivePeriodEnd",
"use": "in",
"min": 0,
"max": "1",
"documentation": "End of effective period",
"type": "dateTime"
},
{
"name": "related",
"use": "in",
"min": 0,
"max": "1",
"documentation": "If true, include related Device and DeviceMetric in the result bundle",
"type": "boolean"
},
{
"name": "result",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Result bundle (HTTP 200 OK) containing summary data of measurements and optionally related resources",
"type": "Reference",
"targetProfile": [
"https://gematik.de/fhir/hddt/StructureDefinition/hddt-cgm-summary"
]
}
]
}