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 - JSON Representation

Active as of 2026-09-11

Raw json | Download

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