# Users
## Functions
### userNew
```solidity
function userNew(
address addr,
bytes32 IDHash,
Role role,
Attribute[] calldata attrs,
address signer,
uint deadline,
bytes calldata signature
) external onlyAllowed(msg.sender)
```
New user registration
**Parameters**
| Name | Type | Description |
|---|
| addr | address | New user address |
| IDHash | bytes32 | New user ID hash. Sha3(userID+systemID) |
| role | #role | New user role. |
| attrs | #attribute[] | New user attributes. |
| signer | address | Address of the signer of the request |
| deadline | uint | Expiration timestamp of the request |
| signature | bytes | Cryptographic signature of the request performed by the signer's key |
### getUser
function getUser(address addr) external view returns(User memory)
Getting ehrID for userID
#### **Parameters**
| Name | Type | Description |
|---|
| addr | address | User address |
#### Return Values:
| Name | Type | Description |
|---|
| user | #user | |
### getUserByCode
```solidity
function getUserByCode(uint64 code) external view returns(User memory)
```
Retrieving a user by unique code. Useful for searching for a doctor by numeric code.
#### **Parameters**
| Name | Type | Description |
|---|
| code | uint64 | User unique code |
#### Return Values:
| Name | Type | Description |
|---|
| user | #user | |
### userGroupCreate
```solidity
function userGroupCreate(
bytes32 groupIdHash,
Attribute[] calldata attrs,
address signer,
uint deadline,
bytes calldata signature
) external onlyAllowed(msg.sender)
```
Creating a user group
#### **Parameters**
| Name | Type | Description |
|---|
| groupIdHash | bytes32 | |
| attrs | #attribute[] | User group attributes |
| signer | address | Address of the signer of the request |
| deadline | uint | Expiration timestamp of the request |
| signature | bytes | Cryptographic signature of the request performed by the signer's key |
### groupAddUser
```solidity
function groupAddUser(GroupAddUserParams calldata p) external
```
Adding a user to a group
#### **Parameters**
### groupRemoveUser
```solidity
function groupRemoveUser(
bytes32 groupIDHash,
bytes32 userIDHash,
address signer,
uint deadline,
bytes calldata signature
) external
```
Removing a user from a group
#### **Parameters**
| Name | Type | Description |
|---|
| groupIDHash | bytes32 | |
| userIDHash | bytes32 | |
| signer | address | Address of the signer of the request |
| deadline | uint | Expiration timestamp of the request |
| signature | bytes | Cryptographic signature of the request performed by the signer's key |
### userGroupGetByID
```solidity
function userGroupGetByID(bytes32 groupIdHash) external view returns(UserGroup memory)
```
Getting a user group by ID
#### **Parameters**
| Name | Type | Description |
|---|
| groupIDHash | bytes32 | User group ID hash |
#### Return Values:
### setAccess
```solidity
function setAccess(
bytes32 accessID,
IAccessStore.Access memory a,
address signer,
uint deadline,
bytes calldata signature
) external
```
Sets the access level to the object
#### **Parameters**
| Name | Type | Description |
|---|
| accessID | bytes32 | |
| a | #iaccessstore.access | |
| signer | address | Address of the signer of the request |
| deadline | uint | Expiration timestamp of the request |
| signature | bytes | Cryptographic signature of the request performed by the signer's key |
## Models
### Role
```solidity
enum Role { Patient, Doctor }
```
### Attribute
```solidity
struct Attribute {
Code code;
bytes value;
}
```
### AccessLevel
```solidity
enum AccessLevel { NoAccess, Owner, Admin, Read }
```
### User
```solidity
struct User {
bytes32 IDHash;
Role role;
Attribute[] attrs;
}
```
### UserGroup
```solidity
struct UserGroup {
Attribute[] attrs;
GroupMember[] members;
}
```
#### **Parameters**
### GroupMember
```solidity
struct GroupMember {
bytes32 userIDHash;
bytes userIDEncr;
}
```
#### **Parameters**
| Name | Type | Description |
|---|
| userIDHash | bytes32 | User id hash |
| userIDEncr | bytes | User ID encrypted by group key |
### GroupAddUserParams
```solidity
struct GroupAddUserParams {
bytes32 groupIDHash;
bytes32 userIDHash;
AccessLevel level;
bytes userIDEncr;
bytes keyEncr;
address signer;
uint deadline;
bytes signature;
}
```
#### **Parameters:**
| Name | Type | Description |
|---|
| groupIDHash | bytes32 | |
| userIDHash | bytes32 | |
| level | #accesslevel | |
| userIDEncr | bytes | userID encrypted by group key |
| keyEncr | bytes | group key encrypted by adding user public key |
| signer | address | Address of the signer of the request |
| deadline | uint | Expiration timestamp of the request |
| signature | bytes | Cryptographic signature of the request performed by the signer's key |
### IAccessStore.Access
```solidity
struct Access {
AccessKind kind;
bytes32 idHash;
bytes idEncr; // id encrypted by access key
bytes keyEncr; // access key encrypted by user private key
AccessLevel level;
}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://ipehr.gitbook.io/docs/reference/contracts/users.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.