FQL is a query language that allows you to retrieve, filter and project data from any data source containing FHIR Resources. It brings the power of three existing languages together: SQL, JSON and FhirPath. It allows you to create tables and is useful for gaining insight and perform quality control.
Organization
gematik
Package
de.gematik.hddt 1.0.0-rc2
Query
-
Default
What is FQL?
-
FQL Query resources
FQL Playground
Try Firely Query Language in our playground by using this scope as data source.
- FQL Documentation
-
FQL Language
Syntax specification
To learn more about FQL syntax choose this menu item.
-
YamlGen Generate resources
YamlGen Playground
Try YamlGen in our playground by using this scope as data source.
-
YamlGen Language
YamlGen Syntax specification
To learn more about YamlGen syntax choose this.
-
FHIRPath Inspect resource
FHIRPath Playground
Try out the FHIRPath playground and navigate inside this resource.
-
FHIRPath Documentation
FHIRPath Documentation
Find out what FHIRPath is or learn how to write FHIRPath scripts.
API
-
Embed
Embed this resource in your own website. How?
HddtCgmSummaryOperation
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 profileHddtCgmSummaryprofile 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 OperationDefinition
- FHIR R4
- status Active
-
version1.0.0-rc2
Valid canonical
This resource matches a canonical claim from this package.
Claim: https://gematik.de/fhir/hddt/
Canonical claims are used to verify ownership of your canonical URLs.
Canonical
File:
package/OperationDefinition-hddt-cgm-summary-operation.json