This page is part of the FHIRcast (v2.1.0-ballot: STU3 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Heartbeat event

!!! important Implementator feedback is requested for the need to support heartbeats for websockets.

Event-name: Heartbeat event

eventMaturity

1 - Submitted

Workflow

The heartbeat 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 event described in the table below.

Key	Optionality	#	type	Description
period	REQUIRED	1	decimal	The maximum resend period in seconds

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 event is indicated below.

````json { “timestamp”:”2021-05-19T10:24:58.614989800Z”, “id”:”sdkasldkals;610101498614”, “event”:{ “context”:[ { “key”:”period”, “decimal”: “10” } ], “hub.topic”:”Topic1”, “hub.event”:”heartbeat” } }

Change Log

Version	Description
1.0	Initial Release