Current Build

2.49 Resource UserSession - Content

FHIR Infrastructure Work GroupMaturity Level: 0 Draft Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Information about a user's current session.

The UserSession resource is used to represent a user's session with a server.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. UserSession DDomainResourceInformation about a user's current session
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..1IdentifierBusiness identifier
... user Σ1..1Reference(Device | Practitioner | Patient | RelatedPerson)User engaged in the session
... status 0..1BackboneElementStatus of the session
.... code Σ1..1codeactivating | active | suspended | closing | closed
UserSessionStatus (Required)
.... source Σ1..1codeuser | system
UserSessionStatusSource (Required)
... workstation 0..1IdentifierWhere is the session
... focus 0..*Reference(Any)What is the user's current focus
... created 0..1instantWhen was the session created
... expires Σ0..1instantWhen does the session expire
... context 0..*BackboneElementAdditional information about the session
.... type 1..1stringWhat type of context value
.... value[x] 0..1Value of the context
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity

doco Documentation for this format

XML Template

<UserSession xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Business identifier --></identifier>
 <user><!-- 1..1 Reference(Device|Practitioner|Patient|RelatedPerson) User engaged in the session --></user>
 <status>  <!-- 0..1 Status of the session -->
  <code value="[code]"/><!-- 1..1 activating | active | suspended | closing | closed -->
  <source value="[code]"/><!-- 1..1 user | system -->
 </status>
 <workstation><!-- 0..1 Identifier Where is the session --></workstation>
 <focus><!-- 0..* Reference(Any) What is the user's current focus --></focus>
 <created value="[instant]"/><!-- 0..1 When was the session created -->
 <expires value="[instant]"/><!-- 0..1 When does the session expire -->
 <context>  <!-- 0..* Additional information about the session -->
  <type value="[string]"/><!-- 1..1 What type of context value -->
  <value[x]><!-- 0..1 CodeableConcept|Quantity Value of the context --></value[x]>
 </context>
</UserSession>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:UserSession;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:UserSession.identifier [ Identifier ]; # 0..1 Business identifier
  fhir:UserSession.user [ Reference(Device|Practitioner|Patient|RelatedPerson) ]; # 1..1 User engaged in the session
  fhir:UserSession.status [ # 0..1 Status of the session
    fhir:UserSession.status.code [ code ]; # 1..1 activating | active | suspended | closing | closed
    fhir:UserSession.status.source [ code ]; # 1..1 user | system
  ];
  fhir:UserSession.workstation [ Identifier ]; # 0..1 Where is the session
  fhir:UserSession.focus [ Reference(Any) ], ... ; # 0..* What is the user's current focus
  fhir:UserSession.created [ instant ]; # 0..1 When was the session created
  fhir:UserSession.expires [ instant ]; # 0..1 When does the session expire
  fhir:UserSession.context [ # 0..* Additional information about the session
    fhir:UserSession.context.type [ string ]; # 1..1 What type of context value
    # UserSession.context.value[x] : 0..1 Value of the context. One of these 2
      fhir:UserSession.context.valueCodeableConcept [ CodeableConcept ]
      fhir:UserSession.context.valueQuantity [ Quantity ]
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. UserSession DDomainResourceInformation about a user's current session
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..1IdentifierBusiness identifier
... user Σ1..1Reference(Device | Practitioner | Patient | RelatedPerson)User engaged in the session
... status 0..1BackboneElementStatus of the session
.... code Σ1..1codeactivating | active | suspended | closing | closed
UserSessionStatus (Required)
.... source Σ1..1codeuser | system
UserSessionStatusSource (Required)
... workstation 0..1IdentifierWhere is the session
... focus 0..*Reference(Any)What is the user's current focus
... created 0..1instantWhen was the session created
... expires Σ0..1instantWhen does the session expire
... context 0..*BackboneElementAdditional information about the session
.... type 1..1stringWhat type of context value
.... value[x] 0..1Value of the context
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity

doco Documentation for this format

XML Template

<UserSession xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..1 Identifier Business identifier --></identifier>
 <user><!-- 1..1 Reference(Device|Practitioner|Patient|RelatedPerson) User engaged in the session --></user>
 <status>  <!-- 0..1 Status of the session -->
  <code value="[code]"/><!-- 1..1 activating | active | suspended | closing | closed -->
  <source value="[code]"/><!-- 1..1 user | system -->
 </status>
 <workstation><!-- 0..1 Identifier Where is the session --></workstation>
 <focus><!-- 0..* Reference(Any) What is the user's current focus --></focus>
 <created value="[instant]"/><!-- 0..1 When was the session created -->
 <expires value="[instant]"/><!-- 0..1 When does the session expire -->
 <context>  <!-- 0..* Additional information about the session -->
  <type value="[string]"/><!-- 1..1 What type of context value -->
  <value[x]><!-- 0..1 CodeableConcept|Quantity Value of the context --></value[x]>
 </context>
</UserSession>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:UserSession;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:UserSession.identifier [ Identifier ]; # 0..1 Business identifier
  fhir:UserSession.user [ Reference(Device|Practitioner|Patient|RelatedPerson) ]; # 1..1 User engaged in the session
  fhir:UserSession.status [ # 0..1 Status of the session
    fhir:UserSession.status.code [ code ]; # 1..1 activating | active | suspended | closing | closed
    fhir:UserSession.status.source [ code ]; # 1..1 user | system
  ];
  fhir:UserSession.workstation [ Identifier ]; # 0..1 Where is the session
  fhir:UserSession.focus [ Reference(Any) ], ... ; # 0..* What is the user's current focus
  fhir:UserSession.created [ instant ]; # 0..1 When was the session created
  fhir:UserSession.expires [ instant ]; # 0..1 When does the session expire
  fhir:UserSession.context [ # 0..* Additional information about the session
    fhir:UserSession.context.type [ string ]; # 1..1 What type of context value
    # UserSession.context.value[x] : 0..1 Value of the context. One of these 2
      fhir:UserSession.context.valueCodeableConcept [ CodeableConcept ]
      fhir:UserSession.context.valueQuantity [ Quantity ]
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

PathDefinitionTypeReference
UserSession.status.code The status of the user sessionRequiredUserSessionStatus
UserSession.status.source The source of the status of the user sessionRequiredUserSessionStatusSource

The UserSession resource is used to represent the information involved in a user's session. In particular, the resource supports context synchronization use cases between systems.

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
focusreferenceThe focus of the user sessionUserSession.focus
(Any)
identifiertokenExternal identifiers for the user sessionUserSession.identifier
patientreferenceThe identity of a patient to search for user sessionsUserSession.focus
(Patient)
statustokenThe status of the user sessionUserSession.status.code
userreferenceThe user of the sessionUserSession.user
(Practitioner, Device, Patient, RelatedPerson)
workstationtokenThe workstation of the sessionUserSession.workstation