• Narrative Content
• XML
• JSON
• TTL

: Search Operation for summary data measurement - TTL Representation

Raw ttl | Download

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

 a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "hddt-cgm-summary-operation"] ; # 
  fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div [ fhir:v "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition hddt-cgm-summary-operation</b></p><a name=\"hddt-cgm-summary-operation\"> </a><a name=\"hchddt-cgm-summary-operation\"> </a><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>effectivePeriodStart</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>Start of effective period</p>\n</div></td></tr><tr><td>IN</td><td>effectivePeriodEnd</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>End of effective period</p>\n</div></td></tr><tr><td>IN</td><td>related</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>If true, include related Device and DeviceMetric in the result bundle</p>\n</div></td></tr><tr><td>OUT</td><td>result</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-hddt-cgm-summary.html\" title=\"https://gematik.de/fhir/hddt/StructureDefinition/hddt-cgm-summary\">Bundle – HDDT CGM Summary Report</a>)</td><td/><td><div><p>Result bundle (HTTP 200 OK) containing summary data of measurements and optionally related resources</p>\n</div></td></tr></table></div>"^^rdf:XMLLiteral ]
  ] ; # 
  fhir:url [
fhir:v "https://gematik.de/fhir/hddt/OperationDefinition/hddt-cgm-summary-operation"^^xsd:anyURI ;
fhir:l <https://gematik.de/fhir/hddt/OperationDefinition/hddt-cgm-summary-operation>
  ] ; # 
  fhir:version [ fhir:v "0.1.0"] ; # 
  fhir:name [ fhir:v "HddtCgmSummaryOperation"] ; # 
  fhir:title [ fhir:v "Search Operation for summary data measurement"] ; # 
  fhir:status [ fhir:v "draft"] ; # 
  fhir:kind [ fhir:v "operation"] ; # 
  fhir:experimental [ fhir:v false] ; # 
  fhir:date [ fhir:v "2025-10-27"^^xsd:date] ; # 
  fhir:publisher [ fhir:v "gematik GmbH"] ; # 
  fhir:description [ fhir:v "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.  \n"] ; # 
  fhir:affectsState [ fhir:v false] ; # 
  fhir:code [ fhir:v "hddt-cgm-summary"] ; # 
  fhir:system [ fhir:v false] ; # 
  fhir:type [ fhir:v true] ; # 
  fhir:instance [ fhir:v false] ; # 
  fhir:parameter ( [
fhir:name [ fhir:v "effectivePeriodStart" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Start of effective period" ] ;
fhir:type [ fhir:v "dateTime" ]
  ] [
fhir:name [ fhir:v "effectivePeriodEnd" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "End of effective period" ] ;
fhir:type [ fhir:v "dateTime" ]
  ] [
fhir:name [ fhir:v "related" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "If true, include related Device and DeviceMetric in the result bundle" ] ;
fhir:type [ fhir:v "boolean" ]
  ] [
fhir:name [ fhir:v "result" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Result bundle (HTTP 200 OK) containing summary data of measurements and optionally related resources" ] ;
fhir:type [ fhir:v "Reference" ] ;
    ( fhir:targetProfile [
fhir:v "https://gematik.de/fhir/hddt/StructureDefinition/hddt-cgm-summary"^^xsd:anyURI ;
fhir:l <https://gematik.de/fhir/hddt/StructureDefinition/hddt-cgm-summary>     ] )
  ] ) . #