User (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.User

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class User
extends BaseResource
implements IResource
```
HAPI/FHIR User Resource (A user authorized to use the system)
Definition:

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/User

Field Summary

Fields
Modifier and Type	Field and Description
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static TokenClientParam`	`LEVEL` Fluent Client search parameter constant for level
`static StringClientParam`	`LOGIN` Fluent Client search parameter constant for login
`static StringClientParam`	`NAME` Fluent Client search parameter constant for name
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static TokenClientParam`	`PROVIDER` Fluent Client search parameter constant for provider
`static String`	`SP_LEVEL` Search parameter constant for level
`static String`	`SP_LOGIN` Search parameter constant for login
`static String`	`SP_NAME` Search parameter constant for name
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_PROVIDER` Search parameter constant for provider

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

User()

Constructors
Constructor and Description
`User()`

Method Summary

Methods
Modifier and Type	Method and Description
`ContactDt`	`addContact()` Adds and returns a new value for contact (Contact details for the user)
`User`	`addContact(ContactUseEnum theContactUse, String theValue)` Adds a new value for contact (Contact details for the user)
`User`	`addContact(String theValue)` Adds a new value for contact (Contact details for the user)
`ResourceReferenceDt`	`addPatient()` Adds and returns a new value for patient (Patient compartments the user has access to (if level is patient/family))
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`List<ContactDt>`	`getContact()` Gets the value(s) for contact (Contact details for the user).
`ContactDt`	`getContactFirstRep()` Gets the first repetition for contact (Contact details for the user), creating it if it does not already exist.
`CodeDt`	`getLevel()` Gets the value(s) for level (The level access for this user).
`StringDt`	`getLogin()` Gets the value(s) for login (The login by which this user is known).
`HumanNameDt`	`getName()` Gets the value(s) for name (The name of this user).
`StringDt`	`getPassword()` Gets the value(s) for password (If internal login, the password hash (SHA 256, Hex, lowercase)).
`List<ResourceReferenceDt>`	`getPatient()` Gets the value(s) for patient (Patient compartments the user has access to (if level is patient/family)).
`UriDt`	`getProvider()` Gets the value(s) for provider (Which system authenticates the user.
`IntegerDt`	`getSessionLength()` Gets the value(s) for sessionLength (How long a session lasts for).
`boolean`	`isEmpty()`
`User`	`setContact(List<ContactDt> theValue)` Sets the value(s) for contact (Contact details for the user)
`User`	`setLevel(CodeDt theValue)` Sets the value(s) for level (The level access for this user)
`User`	`setLevel(String theCode)` Sets the value for level (The level access for this user)
`User`	`setLogin(String theString)` Sets the value for login (The login by which this user is known)
`User`	`setLogin(StringDt theValue)` Sets the value(s) for login (The login by which this user is known)
`User`	`setName(HumanNameDt theValue)` Sets the value(s) for name (The name of this user)
`User`	`setPassword(String theString)` Sets the value for password (If internal login, the password hash (SHA 256, Hex, lowercase))
`User`	`setPassword(StringDt theValue)` Sets the value(s) for password (If internal login, the password hash (SHA 256, Hex, lowercase))
`User`	`setPatient(List<ResourceReferenceDt> theValue)` Sets the value(s) for patient (Patient compartments the user has access to (if level is patient/family))
`User`	`setProvider(String theUri)` Sets the value for provider (Which system authenticates the user.
`User`	`setProvider(UriDt theValue)` Sets the value(s) for provider (Which system authenticates the user.
`User`	`setSessionLength(int theInteger)` Sets the value for sessionLength (How long a session lasts for)
`User`	`setSessionLength(IntegerDt theValue)` Sets the value(s) for sessionLength (How long a session lasts for)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

- Field Detail
  - SP_NAME
```
public static final String SP_NAME
```
    Search parameter constant for name
    Description:
    Type: string
    Path: User.name
    
    See Also:
    Constant Field Values
  - NAME
```
public static final StringClientParam NAME
```
    Fluent Client search parameter constant for name
    Description:
    Type: string
    Path: User.name
  - SP_PROVIDER
```
public static final String SP_PROVIDER
```
    Search parameter constant for provider
    Description:
    Type: token
    Path: User.provider
    
    See Also:
    Constant Field Values
  - PROVIDER
```
public static final TokenClientParam PROVIDER
```
    Fluent Client search parameter constant for provider
    Description:
    Type: token
    Path: User.provider
  - SP_LOGIN
```
public static final String SP_LOGIN
```
    Search parameter constant for login
    Description:
    Type: string
    Path: User.login
    
    See Also:
    Constant Field Values
  - LOGIN
```
public static final StringClientParam LOGIN
```
    Fluent Client search parameter constant for login
    Description:
    Type: string
    Path: User.login
  - SP_LEVEL
```
public static final String SP_LEVEL
```
    Search parameter constant for level
    Description:
    Type: token
    Path: User.level
    
    See Also:
    Constant Field Values
  - LEVEL
```
public static final TokenClientParam LEVEL
```
    Fluent Client search parameter constant for level
    Description:
    Type: token
    Path: User.level
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description:
    Type: reference
    Path: User.patient
    
    See Also:
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description:
    Type: reference
    Path: User.patient
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "User.patient".
- Constructor Detail
  - User
```
public User()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getName
```
public HumanNameDt getName()
```
    Gets the value(s) for name (The name of this user). creating it if it does not exist. Will not return null.
    Definition:
  - setName
```
public User setName(HumanNameDt theValue)
```
    Sets the value(s) for name (The name of this user)
    Definition:
  - getProvider
```
public UriDt getProvider()
```
    Gets the value(s) for provider (Which system authenticates the user. Blanks = internally authenticated). creating it if it does not exist. Will not return null.
    Definition:
  - setProvider
```
public User setProvider(UriDt theValue)
```
    Sets the value(s) for provider (Which system authenticates the user. Blanks = internally authenticated)
    Definition:
  - setProvider
```
public User setProvider(String theUri)
```
    Sets the value for provider (Which system authenticates the user. Blanks = internally authenticated)
    Definition:
  - getLogin
```
public StringDt getLogin()
```
    Gets the value(s) for login (The login by which this user is known). creating it if it does not exist. Will not return null.
    Definition:
  - setLogin
```
public User setLogin(StringDt theValue)
```
    Sets the value(s) for login (The login by which this user is known)
    Definition:
  - setLogin
```
public User setLogin(String theString)
```
    Sets the value for login (The login by which this user is known)
    Definition:
  - getPassword
```
public StringDt getPassword()
```
    Gets the value(s) for password (If internal login, the password hash (SHA 256, Hex, lowercase)). creating it if it does not exist. Will not return null.
    Definition:
  - setPassword
```
public User setPassword(StringDt theValue)
```
    Sets the value(s) for password (If internal login, the password hash (SHA 256, Hex, lowercase))
    Definition:
  - setPassword
```
public User setPassword(String theString)
```
    Sets the value for password (If internal login, the password hash (SHA 256, Hex, lowercase))
    Definition:
  - getLevel
```
public CodeDt getLevel()
```
    Gets the value(s) for level (The level access for this user). creating it if it does not exist. Will not return null.
    Definition:
  - setLevel
```
public User setLevel(CodeDt theValue)
```
    Sets the value(s) for level (The level access for this user)
    Definition:
  - setLevel
```
public User setLevel(String theCode)
```
    Sets the value for level (The level access for this user)
    Definition:
  - getSessionLength
```
public IntegerDt getSessionLength()
```
    Gets the value(s) for sessionLength (How long a session lasts for). creating it if it does not exist. Will not return null.
    Definition:
  - setSessionLength
```
public User setSessionLength(IntegerDt theValue)
```
    Sets the value(s) for sessionLength (How long a session lasts for)
    Definition:
  - setSessionLength
```
public User setSessionLength(int theInteger)
```
    Sets the value for sessionLength (How long a session lasts for)
    Definition:
  - getContact
```
public List<ContactDt> getContact()
```
    Gets the value(s) for contact (Contact details for the user). creating it if it does not exist. Will not return null.
    Definition:
  - setContact
```
public User setContact(List<ContactDt> theValue)
```
    Sets the value(s) for contact (Contact details for the user)
    Definition:
  - addContact
```
public ContactDt addContact()
```
    Adds and returns a new value for contact (Contact details for the user)
    Definition:
  - getContactFirstRep
```
public ContactDt getContactFirstRep()
```
    Gets the first repetition for contact (Contact details for the user), creating it if it does not already exist.
    Definition:
  - addContact
```
public User addContact(ContactUseEnum theContactUse,
              String theValue)
```
    Adds a new value for contact (Contact details for the user)
    Definition:
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addContact
```
public User addContact(String theValue)
```
    Adds a new value for contact (Contact details for the user)
    Definition:
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getPatient
```
public List<ResourceReferenceDt> getPatient()
```
    Gets the value(s) for patient (Patient compartments the user has access to (if level is patient/family)). creating it if it does not exist. Will not return null.
    Definition:
  - setPatient
```
public User setPatient(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for patient (Patient compartments the user has access to (if level is patient/family))
    Definition:
  - addPatient
```
public ResourceReferenceDt addPatient()
```
    Adds and returns a new value for patient (Patient compartments the user has access to (if level is patient/family))
    Definition:

Class User

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Field Detail

SP_NAME

NAME

SP_PROVIDER

PROVIDER

SP_LOGIN

LOGIN

SP_LEVEL

LEVEL

SP_PATIENT

PATIENT

INCLUDE_PATIENT

Constructor Detail

User

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getName

setName

getProvider

setProvider

setProvider

getLogin

setLogin

setLogin

getPassword

setPassword

setPassword

getLevel

setLevel

setLevel

getSessionLength

setSessionLength

setSessionLength

getContact

setContact

addContact

getContactFirstRep

addContact

addContact

getPatient

setPatient

addPatient