Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B

Notification-heartbeat.json

FHIR Infrastructure Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Not linked to any defined compartments

Raw JSON (canonical form + also see JSON Format Specification)

Example of a Subscription Heartbeat message (message with no event)

{
  "resourceType": "Bundle",
  "id": "3d20ea4b-90dc-4d0d-b15a-c7a893389401",
  "type": "subscription-notification",
  "timestamp": "2020-04-17T10:24:13.1882432-05:00",
  "entry": [
    {
      "fullUrl": "urn:uuid:a5b053d4-2603-446f-ae86-f5853ac09334",
      "resource": {
        "resourceType": "SubscriptionStatus",
        "id": "a5b053d4-2603-446f-ae86-f5853ac09334",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><p><b>status</b>: active</p><p><b>type</b>: heartbeat</p><p><b>eventsSinceSubscriptionStart</b>: 310</p><p><b>eventsInNotification</b>: 0</p><p><b>subscription</b>: <a>http://example.org/FHIR/R5/Subscription/123</a></p><p><b>topic</b>: <a>http://example.org/FHIR/R5/SubscriptionTopic/admission</a></p></div>"
        },
        "status": "active",
        "type": "heartbeat",
        "eventsSinceSubscriptionStart": "310",
        "eventsInNotification": 0,
        "subscription": {
          "reference": "http://example.org/FHIR/R5/Subscription/123"
        },
        "topic": "http://example.org/FHIR/R5/SubscriptionTopic/admission"
      }
    }
  ]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.