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

UserLogout Event

Event-name: UserLogout

Workflow

A Subscriber indicates that the User’s session has ended, perhaps by exiting the Subscriber through a logout, session time-out or other reason. Upon receiving a UserLogout event, the application SHOULD logout the user or respond with a SyncError.

Unlike most of FHIRcast events, UserLogout is a statically named event and therefore does not follow the regular FHIRcast syntax.

Implementers are encouraged to consider if and when their application should logout the user upon receiving an userLogout event, and if so, how to preserve application state.

If a Subscriber decides that it will not logout the current user it SHOULD send a SyncError with appropriate details indicating why the Subscriber chose not to logout the current user.

Context

The context SHOULD contain a Parameters resource according to the following profile Logout Context.

Examples

{
  "timestamp": "2019-11-25T13:16:00.00",
  "id": "35d0b1d4-de45-4b5b-a0e9-9c51b21ee71a",
  "event": {
    "hub.topic": "fdb2f928-5546-4f52-87a0-0648e9ded065", 
    "hub.event": "userLogout", 
    "context": [{
      "key": "parameters",
      "resource" : {
        "resourceType": "Parameters",
        "parameter":[{
          "name": "code",
          "valueCoding": {
            "system": "http://hl7.org/fhir/uv/fhircast/CodeSystem/fhircast-logout-codesystem",
            "code" : "user-initiated",
            "display": "The user initiated the logour and suggests all Subscribers should logout."
          }
        }]
      }
    }] 
  }
}

Change Log