Huli FHIR Core Implementation Guide (R4) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Subscription $stats - XML Representation

Active as of 2026-09-11

Raw xml | Download

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Subscription-stats"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition Subscription-stats</b></p><a name="Subscription-stats"> </a><a name="hcSubscription-stats"> </a><p>URL: [base]/Subscription/[id]/$stats</p><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>OUT</td><td>delivered</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></td><td/><td><div><p>Deliveries in a terminal delivered state.</p>
</div></td></tr><tr><td>OUT</td><td>failed</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></td><td/><td><div><p>Deliveries currently in a retryable failed state.</p>
</div></td></tr><tr><td>OUT</td><td>pending</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></td><td/><td><div><p>Deliveries awaiting a first attempt.</p>
</div></td></tr><tr><td>OUT</td><td>dead</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></td><td/><td><div><p>Deliveries dead-lettered after exhausting retries.</p>
</div></td></tr><tr><td>OUT</td><td>deadLetterDepth</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></td><td/><td><div><p>Current dead-letter queue depth.</p>
</div></td></tr><tr><td>OUT</td><td>totalAttempts</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></td><td/><td><div><p>Total delivery attempts across all events.</p>
</div></td></tr><tr><td>OUT</td><td>successRate</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#decimal">decimal</a></td><td/><td><div><p>delivered / (delivered + dead), 0..1.</p>
</div></td></tr><tr><td>OUT</td><td>latencyP50Seconds</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#decimal">decimal</a></td><td/><td><div><p>Median enqueue-to-delivered latency, seconds.</p>
</div></td></tr><tr><td>OUT</td><td>latencyP95Seconds</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#decimal">decimal</a></td><td/><td><div><p>95th-percentile enqueue-to-delivered latency, seconds.</p>
</div></td></tr></table></div>
  </text>
  <url
       value="https://fhir.huli.ai/r4/OperationDefinition/Subscription-stats"/>
  <version value="0.1.0"/>
  <name value="SubscriptionStats"/>
  <title value="Subscription $stats"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2026-09-11T01:20:01+00:00"/>
  <publisher value="Huli"/>
  <contact>
    <name value="Huli"/>
    <telecom>
      <system value="url"/>
      <value value="https://huli.ai"/>
    </telecom>
  </contact>
  <description
               value="Aggregate delivery metrics for a subscription. Read-only; requires system/Subscription.rs."/>
  <affectsState value="false"/>
  <code value="stats"/>
  <resource value="Subscription"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="delivered"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Deliveries in a terminal delivered state."/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="failed"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Deliveries currently in a retryable failed state."/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="pending"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Deliveries awaiting a first attempt."/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="dead"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Deliveries dead-lettered after exhausting retries."/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="deadLetterDepth"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Current dead-letter queue depth."/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="totalAttempts"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Total delivery attempts across all events."/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="successRate"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="delivered / (delivered + dead), 0..1."/>
    <type value="decimal"/>
  </parameter>
  <parameter>
    <name value="latencyP50Seconds"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Median enqueue-to-delivered latency, seconds."/>
    <type value="decimal"/>
  </parameter>
  <parameter>
    <name value="latencyP95Seconds"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="95th-percentile enqueue-to-delivered latency, seconds."/>
    <type value="decimal"/>
  </parameter>
</OperationDefinition>