This page is part of the FHIRcast (v3.0.0-ballot: STU3 (v3.0.0) Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

HeartBeat Event

Implementer feedback is requested for the need to support Heartbeat.htmls for WebSockets.

Event-name: Heartbeat event

Workflow

The Heartbeat.html event is sent regularly by the Hub to indicate that a connection should remain open. This event SHALL be sent at least every 10 second, or an order of magnitude lower than the subscription time-out.

Context

The context of the Heartbeat.html event described in the table below.

The period field indicates the repeat interval. If an event is not received within this time period, the connection may be assumed to be lost.

Example

An example Heartbeat.html event is indicated below.

{
  "timestamp":"2021-05-19T10:24:58.614989800Z",
  "id":"sdkasldkals;610101498614",
  "event":{
    "context":[
      { "key":"period",
        "decimal": "10"
      }
    ],
    "hub.topic":"Topic1",
    "hub.event":"Heartbeat.html"
  }
}

Change Log