UserSession - FHIR v3.5.0

R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

2.48.6 Resource UserSession - Detailed Descriptions

FHIR Infrastructure

Work Group

Maturity Level: 0

Trial Use

Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Detailed Descriptions for the elements in the UserSession resource.

UserSession
Element Id	UserSession
Definition	Information about a user's current session.
Control	1..1
Type	DomainResource
UserSession.identifier
Element Id	UserSession.identifier
Definition	Allows a service to provide a unique, business identifier for the session.
Note	This is a business identifer, not a resource identifier (see discussion)
Control	0..1
Type	Identifier
Requirements	Allows identification of the session as it is known by various participating systems.
Summary	true
UserSession.user
Element Id	UserSession.user
Definition	A practitioner, patient, device, or related person engaged in the session.
Control	1..1
Type	Reference(Device \| Practitioner \| Patient \| RelatedPerson)
Summary	true
UserSession.status
Element Id	UserSession.status
Definition	Status of the session.
Control	0..1
UserSession.status.code
Element Id	UserSession.status.code
Definition	The current status of the user session.
Control	1..1
Terminology Binding	UserSessionStatus (Required)
Type	code
Summary	true
To Do	Why is this a backbone element? Why not just have a status and source?
UserSession.status.source
Element Id	UserSession.status.source
Definition	The source of the status code.
Control	1..1
Terminology Binding	UserSessionStatusSource (Required)
Type	code
Summary	true
Comments	This element is intended to be used to prevent infinite loops in bi-directional context synchronization scenarios.
UserSession.workstation
Element Id	UserSession.workstation
Definition	Location that identifies the physical place at which the user's session is occurring. For the purposes of context synchronization, this is intended to represent the user's workstation.
Control	0..1
Type	Identifier
To Do	The name workstation seems somewhat specific, could this be generalized, is it device? is it location?
UserSession.focus
Element Id	UserSession.focus
Definition	The current focus of the user's session. Common values are a reference to a Patient, Encounter, ImagingStudy, etc.
Control	0..*
Type	Reference(Any)
UserSession.created
Element Id	UserSession.created
Definition	Indicates the timestamp when the user session was first created.
Control	0..1
Type	instant
UserSession.expires
Element Id	UserSession.expires
Definition	Indicates the timestamp when the user session will expire (i.e. no longer be valid).
Control	0..1
Type	instant
Meaning if Missing	If missing, the user session does not expire
Summary	true
UserSession.context
Element Id	UserSession.context
Definition	Provides additional information associated with the context.
Control	0..*
UserSession.context.type
Element Id	UserSession.context.type
Definition	Indicates which type of context is being provided.
Control	1..1
Type	string
To Do	Why isn't this a CodeableConcept?
UserSession.context.value[x]
Element Id	UserSession.context.value[x]
Definition	Provides the context value.
Control	0..1
Type	CodeableConcept\|Quantity
[x] Note	See Choice of Data Types for further information about how to use [x]