org.hl7.fhir.r4.model

Class UserSession

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.UserSession

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class UserSession
extends DomainResource

Information about a user's current session.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserSession.UserSessionContextComponent
static class	UserSession.UserSessionStatus
static class	UserSession.UserSessionStatusComponent
static class	UserSession.UserSessionStatusEnumFactory
static class	UserSession.UserSessionStatusSource
static class	UserSession.UserSessionStatusSourceEnumFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected List<UserSession.UserSessionContextComponent>	context Provides additional information associated with the context.
protected InstantType	created Indicates the timestamp when the user session was first created.
protected InstantType	expires Indicates the timestamp when the user session will expire (i.e.
protected List<Reference>	focus The current focus of the user's session.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	FOCUS Fluent Client search parameter constant for focus
protected List<Resource>	focusTarget The actual objects that are the target of the reference (The current focus of the user's session.
protected Identifier	identifier Allows a service to provide a unique, business identifier for the session.
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static ca.uhn.fhir.model.api.Include	INCLUDE_FOCUS Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_USER Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT Fluent Client search parameter constant for patient
static String	SP_FOCUS Search parameter: focus
static String	SP_IDENTIFIER Search parameter: identifier
static String	SP_PATIENT Search parameter: patient
static String	SP_STATUS Search parameter: status
static String	SP_USER Search parameter: user
static String	SP_WORKSTATION Search parameter: workstation
protected UserSession.UserSessionStatusComponent	status Status of the session.
static ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS Fluent Client search parameter constant for status
protected Reference	user A practitioner, patient, device, or related person engaged in the session.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	USER Fluent Client search parameter constant for user
protected Resource	userTarget The actual object that is the target of the reference (A practitioner, patient, device, or related person engaged in the session.)
protected Identifier	workstation Location that identifies the physical place at which the user's session is occurring.
static ca.uhn.fhir.rest.gclient.TokenClientParam	WORKSTATION Fluent Client search parameter constant for workstation

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor and Description
UserSession() Constructor
UserSession(Reference user) Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
UserSession.UserSessionContextComponent	addContext()
UserSession	addContext(UserSession.UserSessionContextComponent t)
Reference	addFocus()
UserSession	addFocus(Reference t)
UserSession	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<UserSession.UserSessionContextComponent>	getContext()
UserSession.UserSessionContextComponent	getContextFirstRep()
Date	getCreated()
InstantType	getCreatedElement()
Date	getExpires()
InstantType	getExpiresElement()
List<Reference>	getFocus()
Reference	getFocusFirstRep()
List<Resource>	getFocusTarget() Deprecated. Use Reference#setResource(IBaseResource) instead
Identifier	getIdentifier()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
UserSession.UserSessionStatusComponent	getStatus()
String[]	getTypesForProperty(int hash, String name)
Reference	getUser()
Resource	getUserTarget()
Identifier	getWorkstation()
boolean	hasContext()
boolean	hasCreated()
boolean	hasCreatedElement()
boolean	hasExpires()
boolean	hasExpiresElement()
boolean	hasFocus()
boolean	hasIdentifier()
boolean	hasStatus()
boolean	hasUser()
boolean	hasWorkstation()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
UserSession	setContext(List<UserSession.UserSessionContextComponent> theContext)
UserSession	setCreated(Date value)
UserSession	setCreatedElement(InstantType value)
UserSession	setExpires(Date value)
UserSession	setExpiresElement(InstantType value)
UserSession	setFocus(List<Reference> theFocus)
UserSession	setIdentifier(Identifier value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
UserSession	setStatus(UserSession.UserSessionStatusComponent value)
UserSession	setUser(Reference value)
UserSession	setUserTarget(Resource value)
UserSession	setWorkstation(Identifier value)
protected UserSession	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Field Detail

identifier

protected Identifier identifier

Allows a service to provide a unique, business identifier for the session.

user

protected Reference user

A practitioner, patient, device, or related person engaged in the session.

userTarget

protected Resource userTarget

The actual object that is the target of the reference (A practitioner, patient, device, or related person engaged in the session.)

status

protected UserSession.UserSessionStatusComponent status

Status of the session.

workstation

protected Identifier workstation

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.

focus

protected List<Reference> focus

The current focus of the user's session. Common values are a reference to a Patient, Encounter, ImagingStudy, etc.

focusTarget

protected List<Resource> focusTarget

The actual objects that are the target of the reference (The current focus of the user's session. Common values are a reference to a Patient, Encounter, ImagingStudy, etc.)

created

protected InstantType created

Indicates the timestamp when the user session was first created.

expires

protected InstantType expires

Indicates the timestamp when the user session will expire (i.e. no longer be valid).

context

protected List<UserSession.UserSessionContextComponent> context

Provides additional information associated with the context.

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: External identifiers for the user session
Type: token
Path: UserSession.identifier

See Also:

Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: External identifiers for the user session
Type: token
Path: UserSession.identifier

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: The identity of a patient to search for user sessions
Type: reference
Path: UserSession.focus

See Also:

Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: The identity of a patient to search for user sessions
Type: reference
Path: UserSession.focus

INCLUDE_PATIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "UserSession:patient".

SP_FOCUS

public static final String SP_FOCUS

Search parameter: focus

Description: The focus of the user session
Type: reference
Path: UserSession.focus

See Also:

Constant Field Values

FOCUS

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam FOCUS

Fluent Client search parameter constant for focus

Description: The focus of the user session
Type: reference
Path: UserSession.focus

INCLUDE_FOCUS

public static final ca.uhn.fhir.model.api.Include INCLUDE_FOCUS

Constant for fluent queries to be used to add include statements. Specifies the path value of "UserSession:focus".

SP_WORKSTATION

public static final String SP_WORKSTATION

Search parameter: workstation

Description: The workstation of the session
Type: token
Path: UserSession.workstation

See Also:

Constant Field Values

WORKSTATION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam WORKSTATION

Fluent Client search parameter constant for workstation

Description: The workstation of the session
Type: token
Path: UserSession.workstation

SP_USER

public static final String SP_USER

Search parameter: user

Description: The user of the session
Type: reference
Path: UserSession.user

See Also:

Constant Field Values

USER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam USER

Fluent Client search parameter constant for user

Description: The user of the session
Type: reference
Path: UserSession.user

INCLUDE_USER

public static final ca.uhn.fhir.model.api.Include INCLUDE_USER

Constant for fluent queries to be used to add include statements. Specifies the path value of "UserSession:user".

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The status of the user session
Type: token
Path: UserSession.status.code

See Also:

Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: The status of the user session
Type: token
Path: UserSession.status.code

Constructor Detail

UserSession

public UserSession()

Constructor

UserSession

public UserSession(Reference user)

Constructor

Method Detail

getIdentifier

public Identifier getIdentifier()

Returns:

identifier (Allows a service to provide a unique, business identifier for the session.)

hasIdentifier

public boolean hasIdentifier()

setIdentifier

public UserSession setIdentifier(Identifier value)

Parameters:

value - identifier (Allows a service to provide a unique, business identifier for the session.)

getUser

public Reference getUser()

Returns:

user (A practitioner, patient, device, or related person engaged in the session.)

hasUser

public boolean hasUser()

setUser

public UserSession setUser(Reference value)

Parameters:

value - user (A practitioner, patient, device, or related person engaged in the session.)

getUserTarget

public Resource getUserTarget()

Returns:

user The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A practitioner, patient, device, or related person engaged in the session.)

setUserTarget

public UserSession setUserTarget(Resource value)

Parameters:

value - user The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A practitioner, patient, device, or related person engaged in the session.)

getStatus

public UserSession.UserSessionStatusComponent getStatus()

Returns:

status (Status of the session.)

hasStatus

public boolean hasStatus()

setStatus

public UserSession setStatus(UserSession.UserSessionStatusComponent value)

Parameters:

value - status (Status of the session.)

getWorkstation

public Identifier getWorkstation()

Returns:

workstation (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.)

hasWorkstation

public boolean hasWorkstation()

setWorkstation

public UserSession setWorkstation(Identifier value)

Parameters:

value - workstation (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.)

getFocus

public List<Reference> getFocus()

Returns:

focus (The current focus of the user's session. Common values are a reference to a Patient, Encounter, ImagingStudy, etc.)

setFocus

public UserSession setFocus(List<Reference> theFocus)

Returns:

Returns a reference to this for easy method chaining

hasFocus

public boolean hasFocus()

addFocus

public Reference addFocus()

addFocus

public UserSession addFocus(Reference t)

getFocusFirstRep

public Reference getFocusFirstRep()

Returns:

The first repetition of repeating field focus, creating it if it does not already exist

getFocusTarget

@Deprecated
public List<Resource> getFocusTarget()

Deprecated. Use Reference#setResource(IBaseResource) instead

getCreatedElement

public InstantType getCreatedElement()

Returns:

created (Indicates the timestamp when the user session was first created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

hasCreatedElement

public boolean hasCreatedElement()

hasCreated

public boolean hasCreated()

setCreatedElement

public UserSession setCreatedElement(InstantType value)

Parameters:

value - created (Indicates the timestamp when the user session was first created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

getCreated

public Date getCreated()

Returns:

Indicates the timestamp when the user session was first created.

setCreated

public UserSession setCreated(Date value)

Parameters:

value - Indicates the timestamp when the user session was first created.

getExpiresElement

public InstantType getExpiresElement()

Returns:

expires (Indicates the timestamp when the user session will expire (i.e. no longer be valid).). This is the underlying object with id, value and extensions. The accessor "getExpires" gives direct access to the value

hasExpiresElement

public boolean hasExpiresElement()

hasExpires

public boolean hasExpires()

setExpiresElement

public UserSession setExpiresElement(InstantType value)

Parameters:

value - expires (Indicates the timestamp when the user session will expire (i.e. no longer be valid).). This is the underlying object with id, value and extensions. The accessor "getExpires" gives direct access to the value

getExpires

public Date getExpires()

Returns:

Indicates the timestamp when the user session will expire (i.e. no longer be valid).

setExpires

public UserSession setExpires(Date value)

Parameters:

value - Indicates the timestamp when the user session will expire (i.e. no longer be valid).

getContext

public List<UserSession.UserSessionContextComponent> getContext()

Returns:

context (Provides additional information associated with the context.)

setContext

public UserSession setContext(List<UserSession.UserSessionContextComponent> theContext)

Returns:

Returns a reference to this for easy method chaining

hasContext

public boolean hasContext()

addContext

public UserSession.UserSessionContextComponent addContext()

addContext

public UserSession addContext(UserSession.UserSessionContextComponent t)

getContextFirstRep

public UserSession.UserSessionContextComponent getContextFirstRep()

Returns:

The first repetition of repeating field context, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Overrides:

fhirType in class DomainResource

copy

public UserSession copy()

Specified by:

copy in class DomainResource

typedCopy

protected UserSession typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource