User (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

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

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class User
extends BaseResource
implements IResource
```
HAPI/FHIR User Resource ()
Definition:

Requirements:

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

See Also:

Serialized Form

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.dstu2.resource.BaseResource
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

User()

Constructors
Constructor and Description
`User()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ContactPointDt`	`addContact()` Adds and returns a new value for contact ()
`User`	`addContact(ContactPointDt theValue)` Adds a given new value for contact ()
`ResourceReferenceDt`	`addPatient()` Adds and returns a new value for patient ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`List<ContactPointDt>`	`getContact()` Gets the value(s) for contact ().
`ContactPointDt`	`getContactFirstRep()` Gets the first repetition for contact (), creating it if it does not already exist.
`String`	`getLevel()` Gets the value(s) for level ().
`CodeDt`	`getLevelElement()` Gets the value(s) for level ().
`String`	`getLogin()` Gets the value(s) for login ().
`StringDt`	`getLoginElement()` Gets the value(s) for login ().
`HumanNameDt`	`getName()` Gets the value(s) for name ().
`String`	`getPassword()` Gets the value(s) for password ().
`StringDt`	`getPasswordElement()` Gets the value(s) for password ().
`List<ResourceReferenceDt>`	`getPatient()` Gets the value(s) for patient ().
`String`	`getProvider()` Gets the value(s) for provider ().
`UriDt`	`getProviderElement()` Gets the value(s) for provider ().
`String`	`getResourceName()`
`Integer`	`getSessionLength()` Gets the value(s) for sessionLength ().
`IntegerDt`	`getSessionLengthElement()` Gets the value(s) for sessionLength ().
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`boolean`	`isEmpty()`
`User`	`setContact(List<ContactPointDt> theValue)` Sets the value(s) for contact ()
`User`	`setLevel(CodeDt theValue)` Sets the value(s) for level ()
`User`	`setLevel(String theCode)` Sets the value for level ()
`User`	`setLogin(String theString)` Sets the value for login ()
`User`	`setLogin(StringDt theValue)` Sets the value(s) for login ()
`User`	`setName(HumanNameDt theValue)` Sets the value(s) for name ()
`User`	`setPassword(String theString)` Sets the value for password ()
`User`	`setPassword(StringDt theValue)` Sets the value(s) for password ()
`User`	`setPatient(List<ResourceReferenceDt> theValue)` Sets the value(s) for patient ()
`User`	`setProvider(String theUri)` Sets the value for provider ()
`User`	`setProvider(UriDt theValue)` Sets the value(s) for provider ()
`User`	`setSessionLength(int theInteger)` Sets the value for sessionLength ()
`User`	`setSessionLength(IntegerDt theValue)` Sets the value(s) for sessionLength ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, 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

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

- 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 IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getName
```
public HumanNameDt getName()
```
    Gets the value(s) for name (). creating it if it does not exist. Will not return null.
    Definition:
  - setName
```
public User setName(HumanNameDt theValue)
```
    Sets the value(s) for name ()
    Definition:
  - getProviderElement
```
public UriDt getProviderElement()
```
    Gets the value(s) for provider (). creating it if it does not exist. Will not return null.
    Definition:
  - getProvider
```
public String getProvider()
```
    Gets the value(s) for provider (). creating it if it does not exist. Will not return null.
    Definition:
  - setProvider
```
public User setProvider(UriDt theValue)
```
    Sets the value(s) for provider ()
    Definition:
  - setProvider
```
public User setProvider(String theUri)
```
    Sets the value for provider ()
    Definition:
  - getLoginElement
```
public StringDt getLoginElement()
```
    Gets the value(s) for login (). creating it if it does not exist. Will not return null.
    Definition:
  - getLogin
```
public String getLogin()
```
    Gets the value(s) for login (). creating it if it does not exist. Will not return null.
    Definition:
  - setLogin
```
public User setLogin(StringDt theValue)
```
    Sets the value(s) for login ()
    Definition:
  - setLogin
```
public User setLogin(String theString)
```
    Sets the value for login ()
    Definition:
  - getPasswordElement
```
public StringDt getPasswordElement()
```
    Gets the value(s) for password (). creating it if it does not exist. Will not return null.
    Definition:
  - getPassword
```
public String getPassword()
```
    Gets the value(s) for password (). creating it if it does not exist. Will not return null.
    Definition:
  - setPassword
```
public User setPassword(StringDt theValue)
```
    Sets the value(s) for password ()
    Definition:
  - setPassword
```
public User setPassword(String theString)
```
    Sets the value for password ()
    Definition:
  - getLevelElement
```
public CodeDt getLevelElement()
```
    Gets the value(s) for level (). creating it if it does not exist. Will not return null.
    Definition:
  - getLevel
```
public String getLevel()
```
    Gets the value(s) for level (). creating it if it does not exist. Will not return null.
    Definition:
  - setLevel
```
public User setLevel(CodeDt theValue)
```
    Sets the value(s) for level ()
    Definition:
  - setLevel
```
public User setLevel(String theCode)
```
    Sets the value for level ()
    Definition:
  - getSessionLengthElement
```
public IntegerDt getSessionLengthElement()
```
    Gets the value(s) for sessionLength (). creating it if it does not exist. Will not return null.
    Definition:
  - getSessionLength
```
public Integer getSessionLength()
```
    Gets the value(s) for sessionLength (). creating it if it does not exist. Will not return null.
    Definition:
  - setSessionLength
```
public User setSessionLength(IntegerDt theValue)
```
    Sets the value(s) for sessionLength ()
    Definition:
  - setSessionLength
```
public User setSessionLength(int theInteger)
```
    Sets the value for sessionLength ()
    Definition:
  - getContact
```
public List<ContactPointDt> getContact()
```
    Gets the value(s) for contact (). creating it if it does not exist. Will not return null.
    Definition:
  - setContact
```
public User setContact(List<ContactPointDt> theValue)
```
    Sets the value(s) for contact ()
    Definition:
  - addContact
```
public ContactPointDt addContact()
```
    Adds and returns a new value for contact ()
    Definition:
  - addContact
```
public User addContact(ContactPointDt theValue)
```
    Adds a given new value for contact ()
    Definition:
    
    Parameters:
    
    theValue - The contact to add (must not be null)
  - getContactFirstRep
```
public ContactPointDt getContactFirstRep()
```
    Gets the first repetition for contact (), creating it if it does not already exist.
    Definition:
  - getPatient
```
public List<ResourceReferenceDt> getPatient()
```
    Gets the value(s) for patient (). 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 ()
    Definition:
  - addPatient
```
public ResourceReferenceDt addPatient()
```
    Adds and returns a new value for patient ()
    Definition:
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class User

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.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

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

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

getProviderElement

getProvider

setProvider

setProvider

getLoginElement

getLogin

setLogin

setLogin

getPasswordElement

getPassword

setPassword

setPassword

getLevelElement

getLevel

setLevel

setLevel

getSessionLengthElement

getSessionLength

setSessionLength

setSessionLength

getContact

setContact

addContact

addContact

getContactFirstRep

getPatient

setPatient

addPatient

getResourceName

getStructureFhirVersionEnum