CGM Data Receiver Capability Statement - XML Representation

Continuous Glucose Monitoring, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cgm/ and changes regularly. See the Directory of published versions
: CGM Data Receiver Capability Statement - XML Representation

Active as of 2024-05-09
Raw xml | Download

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="cgm-data-receiver"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement cgm-data-receiver</b></p><a name="cgm-data-receiver"> </a><a name="hccgm-data-receiver"> </a><a name="cgm-data-receiver-en-US"> </a><h2 id="title">CGM Data Receiver Capability Statement</h2><ul><li>Implementation Guide Version: 0.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-05-09 </li><li>Published by: HL7 International / Orders and Observations </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><div class="lead"><em>Summary of System-wide Interactions</em></div></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#ServiceRequest1-1">ServiceRequest</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-cgm-data-submission-standing-order.html">CGM Data Submission Standing Order</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td>patient, code</td><td/><td/><td/></tr><tr><td><a href="#DiagnosticReport1-2">DiagnosticReport</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-cgm-summary-pdf.html">CGM Summary PDF Report</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Device1-3">Device</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-cgm-device.html">CGM Device</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Observation1-4">Observation</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-cgm-summary.html">CGM Summary Observation</a><br/>  <a href="StructureDefinition-cgm-summary-mean-glucose-mass-per-volume.html">Mean Glucose (Mass)</a><br/>  <a href="StructureDefinition-cgm-summary-mean-glucose-moles-per-volume.html">Mean Glucose (Molar)</a><br/>  <a href="StructureDefinition-cgm-summary-times-in-ranges.html">CGM Summary Times in Ranges</a><br/>  <a href="StructureDefinition-cgm-summary-gmi.html">Glucose Management Indicator (GMI)</a><br/>  <a href="StructureDefinition-cgm-summary-coefficient-of-variation.html">Coefficient of Variation (CV)</a><br/>  <a href="StructureDefinition-cgm-summary-days-of-wear.html">Days of Wear</a><br/>  <a href="StructureDefinition-cgm-summary-sensor-active-percentage.html">Sensor Active Percentage</a><br/>  <a href="StructureDefinition-cgm-sensor-reading-mass-per-volume.html">CGM Sensor Reading (Mass)</a><br/>  <a href="StructureDefinition-cgm-sensor-reading-moles-per-volume.html">CGM Sensor Reading (Molar)</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td>patient, category, code</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="ServiceRequest1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>ServiceRequest</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/servicerequest.html">ServiceRequest</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-cgm-data-submission-standing-order.html">CGM Data Submission Standing Order</a></p></div></div><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>code</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="DiagnosticReport1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>DiagnosticReport</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/diagnosticreport.html">DiagnosticReport</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>update</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-cgm-summary-pdf.html">CGM Summary PDF Report</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Device1-3" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Device</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/device.html">Device</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>update</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-cgm-device.html">CGM Device</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Observation1-4" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Observation</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/observation.html">Observation</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>update</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-cgm-summary.html">CGM Summary Observation</a><br/><a href="StructureDefinition-cgm-summary-mean-glucose-mass-per-volume.html">Mean Glucose (Mass)</a><br/><a href="StructureDefinition-cgm-summary-mean-glucose-moles-per-volume.html">Mean Glucose (Molar)</a><br/><a href="StructureDefinition-cgm-summary-times-in-ranges.html">CGM Summary Times in Ranges</a><br/><a href="StructureDefinition-cgm-summary-gmi.html">Glucose Management Indicator (GMI)</a><br/><a href="StructureDefinition-cgm-summary-coefficient-of-variation.html">Coefficient of Variation (CV)</a><br/><a href="StructureDefinition-cgm-summary-days-of-wear.html">Days of Wear</a><br/><a href="StructureDefinition-cgm-summary-sensor-active-percentage.html">Sensor Active Percentage</a><br/><a href="StructureDefinition-cgm-sensor-reading-mass-per-volume.html">CGM Sensor Reading (Mass)</a><br/><a href="StructureDefinition-cgm-sensor-reading-moles-per-volume.html">CGM Sensor Reading (Molar)</a></p></div></div><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>category</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>code</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><h3 id="operationsCap1">Operations</h3><h4 id="operationsSummary1">Use</h4></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="oo"/>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/cgm/CapabilityStatement/cgm-data-receiver"/>
  <version value="0.1.0"/>
  <title value="CGM Data Receiver Capability Statement"/>
  <status value="active"/>
  <date value="2024-05-09"/>
  <publisher value="HL7 International / Orders and Observations"/>
  <contact>
    <name value="HL7 International / Orders and Observations"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/orders"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="ord@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="This capability statement describes the requirements for systems receiving CGM data via the `$submit-cgm-bundle` operation.

Any CGM Data Receiver SHALL populate its `/metadata` response to ensure that `CapabilityStatement.instantiates` includes `&quot;http://hl7.org/fhir/uv/cgm/CapabilityStatement/cgm-data-receiver&quot;`."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="json"/>
  <rest>
    <mode value="server"/>
    <resource>
      <type value="ServiceRequest"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-data-submission-standing-order"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="patient"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <name value="code"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <resource>
      <type value="DiagnosticReport"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-summary-pdf"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
    </resource>
    <resource>
      <type value="Device"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-device"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
    </resource>
    <resource>
      <type value="Observation"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-summary"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-summary-mean-glucose-mass-per-volume"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-summary-mean-glucose-moles-per-volume"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-summary-times-in-ranges"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-summary-gmi"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-summary-coefficient-of-variation"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-summary-days-of-wear"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-summary-sensor-active-percentage"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-sensor-reading-mass-per-volume"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/cgm/StructureDefinition/cgm-sensor-reading-moles-per-volume"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <searchParam>
        <name value="patient"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <name value="category"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <name value="code"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <operation>
      <name value="submit-cgm-bundle"/>
      <definition
                  value="http://hl7.org/fhir/uv/cgm/OperationDefinition/submit-cgm-bundle"/>
    </operation>
  </rest>
</CapabilityStatement>