Event Messages

eHealth Infrastructure
9.0.2-SNAPSHOT - release Denmark flag

eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 9.0.2-SNAPSHOT built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fut-infrastructure/implementation-guide/ and changes regularly. See the Directory of published versions

Event messages

This document describes the types of event messages that are published to destinations (topic/queue) on the message broker for the eHealth Infrastructure. Each message consists of a JSON body and additionally some message properties.

The JSON body contains the event details, while the message properties enable the use of message selectors when consuming messages from a destination.

For each message type is documented:

naming of destination (topic/queue)
JSON schema for the message body
table of message selector properties

EHealthContextEvent

Messages of EHealthContextEvent message type are issued when a resource is created, updated or deleted AND the context criteria is met. Eg. if the criteria is that a specific element of the resource has changed, the context would be the name of the element.

Destination

topic: Topic is named: [FHIR profile of the resource].[context]

Message

{
  "type" : "object",
  "id" : "urn:jsonschema:com:systematic:ehealth:event:event:EHealthContextEvent",
  "properties" : {
    "messageType" : {
      "type" : "string",
      "description" : "EHealthContextEvent"
    },
    "messageVersion" : {
      "type" : "string",
      "description" : "1.0"
    },
    "eventType" : {
      "type" : "string",
      "description" : "{ enum : [ created, updated, deleted ] }"
    },
    "resourceReference" : {
      "type" : "string",
      "description" : "The reference (absolute URL) of the resource for which the event message is issued"
    },
    "resourceVersion" : {
      "type" : "string",
      "description" : "The version of the resource after change"
    },
    "context" : {
      "type" : "string",
      "description" : "The name of the context"
    },
    "status" : {
      "type" : "string",
      "description" : "The status of the event"
    }
  }
}

Properties

context: The context of the resource event. Context can be an element, or a special event type
eventType: The type of event
messageType: The name of the message type
messageVersion: The version of the message type, eg. "1.0"
resourceReference: The reference (absolute URL) of the resource for which the event message is issued
messageClass: The Java class path of the event message. For internal use (serializing/deserializing from/to Java objects))
patientReference: The reference (absolute URL) to the patient resource, if the resource, for which the event message is issued, is related to a patient
resourceProfile: The FHIR profile of the resource for which the event message is issued

EHealthReferenceEvent

Messages of EHealthReferenceEvent message type are issued when a resource element containing references is updated. Separate messages are issued for references added, and references removed

Destination

topic: Topic is named: [FHIR profile of the resource].[name of resource element]

Message

{
  "type" : "object",
  "id" : "urn:jsonschema:com:systematic:ehealth:event:event:EHealthReferenceEvent",
  "properties" : {
    "messageType" : {
      "type" : "string",
      "description" : "EHealthReferenceEvent"
    },
    "messageVersion" : {
      "type" : "string",
      "description" : "1.0"
    },
    "eventType" : {
      "type" : "string",
      "description" : "{ enum : [ reference_added, reference_removed ] }"
    },
    "resourceReference" : {
      "type" : "string",
      "description" : "The reference (absolute URL) of the resource for which the event message is issued"
    },
    "resourceVersion" : {
      "type" : "string",
      "description" : "The version of the resource after change"
    },
    "resourceElement" : {
      "type" : "string",
      "description" : "The reference resource element that has changed"
    },
    "references" : {
      "type" : "array",
      "description" : "The resource element references (absolute URLs) that were added or removed",
      "items" : {
        "type" : "string"
      }
    }
  }
}

Properties

eventType: The type of event
messageType: The name of the message type
messageVersion: The version of the message type, eg. "1.0"
resourceElement: The reference resource element that has changed
resourceReference: The reference (absolute URL) of the resource for which the event message is issued
messageClass: The Java class path of the event message. For internal use (serializing/deserializing from/to Java objects))
patientReference: The reference (absolute URL) to the patient resource, if the resource, for which the event message is issued, is related to a patient
resourceProfile: The FHIR profile of the resource for which the event message is issued

EHealthApplicationEvent

Messages of EHealthApplicationEvent message type are issued when a citizen has opted in to receive push notifications (via a CommunicationRequest with medium=application-event and doNotPerform=false) and a relevant event occurs, such as receiving a new eHealth message, a measurement reminder, a missing measurement notification, or an appointment reminder. These events enable client applications to deliver push notifications independently of the NemSMS notification flow.

Destination

topic: ehealth-application-event

Message

{
  "$schema" : "http://json-schema.org/draft-07/schema#",
  "type" : "object",
  "id" : "urn:jsonschema:dk:sundhed:ehealth:event:models:EHealthApplicationEvent",
  "required" : [ "eventType", "resourceReference" ],
  "properties" : {
    "messageType" : {
      "type" : "string",
      "description" : "EHealthApplicationEvent"
    },
    "messageVersion" : {
      "type" : "string",
      "description" : "1.0"
    },
    "ehealth.system" : {
      "type" : "string",
      "description" : "The coexistence system tag"
    },
    "eventType" : {
      "type" : "string",
      "enum" : [ "AppointmentReminder", "VideoAppointmentReminder", "ReminderSubmitMeasurement", "NewEHealthMessage", "MissingMeasurement" ]
    },
    "payload" : {
      "type" : "string",
      "description" : "Notification text content from the CommunicationRequest"
    },
    "userReference" : {
      "type" : "string",
      "description" : "The reference (absolute URL) of the Patient resource"
    },
    "resourceReference" : {
      "type" : "array",
      "minItems" : 1,
      "description" : "References to related resources. At least one entry is required; the obligatory label per eventType is listed in the Event Types table below.",
      "items" : {
        "type" : "object",
        "required" : [ "label", "reference" ],
        "properties" : {
          "label" : {
            "type" : "string",
            "description" : "The type/label of the referenced resource"
          },
          "reference" : {
            "type" : "string",
            "description" : "The reference (absolute URL) of the resource"
          }
        }
      }
    }
  },
  "allOf" : [
    { "if" : { "required" : [ "eventType" ], "properties" : { "eventType" : { "const" : "AppointmentReminder" } } },
      "then" : { "properties" : { "resourceReference" : { "contains" : { "properties" : { "label" : { "const" : "Appointment" } } } } } } },
    { "if" : { "required" : [ "eventType" ], "properties" : { "eventType" : { "const" : "VideoAppointmentReminder" } } },
      "then" : { "properties" : { "resourceReference" : { "contains" : { "properties" : { "label" : { "const" : "Appointment" } } } } } } },
    { "if" : { "required" : [ "eventType" ], "properties" : { "eventType" : { "const" : "ReminderSubmitMeasurement" } } },
      "then" : { "properties" : { "resourceReference" : { "contains" : { "properties" : { "label" : { "const" : "ServiceRequest" } } } } } } },
    { "if" : { "required" : [ "eventType" ], "properties" : { "eventType" : { "const" : "MissingMeasurement" } } },
      "then" : { "properties" : { "resourceReference" : { "contains" : { "properties" : { "label" : { "const" : "ServiceRequest" } } } } } } },
    { "if" : { "required" : [ "eventType" ], "properties" : { "eventType" : { "const" : "NewEHealthMessage" } } },
      "then" : { "properties" : { "resourceReference" : { "contains" : { "properties" : { "label" : { "const" : "EhealthMessage" } } } } } } }
  ]
}

Properties

ehealth.system: The coexistence system tag (also present in the JSON body)
eventType: The type of application event (see Event Types table below)
messageType: The name of the message type
messageVersion: The version of the message type, eg. "1.0"
payload: Notification text content from the CommunicationRequest
userReference: The reference (absolute URL) of the Patient resource representing the citizen
resourceReference: Non-empty array of references to related resources. Each entry has a label (resource type) and reference (absolute URL). The obligatory entries per eventType are listed in the Event Types table.

Event Types

Each eventType guarantees at least one resourceReference entry with the indicated label. This is enforced by the JSON schema's allOf / if-then / contains block above.

eventType	Description	Obligatory resourceReference label	Source
AppointmentReminder	Appointment reminder	Appointment	fut-appointment-notification-job
VideoAppointmentReminder	Video appointment reminder	Appointment	fut-appointment-notification-job
ReminderSubmitMeasurement	Reminder to submit measurement	ServiceRequest	fut-patient
NewEHealthMessage	New eHealth message	EhealthMessage	fut-patient
MissingMeasurement	Missing measurement notification	ServiceRequest	fut-patient

EHealthSimpleEvent

Messages of EHealthSimpleEvent message type are issued when a resource is created, updated or deleted.

Destination

topic: Topic is named: [FHIR profile of the resource]

Message

{
  "type" : "object",
  "id" : "urn:jsonschema:com:systematic:ehealth:event:event:EHealthSimpleEvent",
  "properties" : {
    "messageType" : {
      "type" : "string",
      "description" : "EHealthSimpleEvent"
    },
    "messageVersion" : {
      "type" : "string",
      "description" : "1.0"
    },
    "eventType" : {
      "type" : "string",
      "description" : "{ enum : [ created, updated, deleted ] }"
    },
    "resourceReference" : {
      "type" : "string",
      "description" : "The reference (absolute URL) of the resource for which the event message is issued"
    },
    "resourceVersion" : {
      "type" : "string",
      "description" : "The version of the resource (version after: created, updated, version before: deleted)"
    }
  }
}

Properties

eventType: The type of event
messageType: The name of the message type
messageVersion: The version of the message type, eg. "1.0"
resourceReference: The reference (absolute URL) of the resource for which the event message is issued
messageClass: The Java class path of the event message. For internal use (serializing/deserializing from/to Java objects))
patientReference: The reference (absolute URL) to the patient resource, if the resource, for which the event message is issued, is related to a patient
resourceProfile: The FHIR profile of the resource for which the event message is issued

Links: Table of Contents | QA Report | Change log