Database model
See https://github.com/Nebo15/ehealth.api/tree/master/specs/database_schema
JSON objects structure
documents
Array of document objects
[
{
"type":"PASSPORT",
"number":"120518",
"issue_date":"2015-04-07T00:00:00.000Z",
"expiration_date":"2015-04-07T00:00:00.000Z",
"issued_by":"DMSU"
}
]
Attribute | Type | Description |
---|
type | ENUM('DOCUMENT_TYPE') |
|
number | STRING |
|
issue_date | STRING | ISO 8601 |
expiration_date | STRING | ISO 8601 |
issued_by | STRING |
|
addresses
Array of address objects
[
{
"type": "RESIDENCE",
"country": "UA",
"area": "Житомирська",
"region": "Бердичівський",
"city": "Київ",
"street_type": "STREET",
"street": "Ніжинська",
"building": "15",
"apartment": "23",
"zip": "02090"
}
]
Attribute | Type | Description |
---|
type | STRING |
|
country | ENUM('COUNTRY_CODE') |
|
area | STRING |
|
region | STRING |
|
city | STRING |
|
city_type | ENUM('CITY_TYPE') |
|
street | STRING |
|
building | STRING |
|
apartment | STRING |
|
zip | STRING |
|
phones
Array of phone objects
[
{
"type": "MOBILE",
"number": "+380503410870"
}
]
Attribute | Type | Description |
---|
type | ENUM('PHONE_TYPE') |
|
number | STRING | ITU E.164 |
{
"first_name": "Петро",
"last_name": "Іванов",
"second_name": "Миколайович",
"phones": [
{
"type": "MOBILE",
"number": "+380503410870"
}
]
}
Attribute | Type | Description |
---|
first_name | STRING |
|
last_name | STRING |
|
second_name | STRING |
|
phones | PHONES[] |
|
confidant_person
{
"relation_type": "trustee",
"first_name": "Петро",
"last_name": "Іванов",
"second_name": "Миколайович",
"birth_date": "1991-08-19T00:00:00.000Z",
"birth_place": "Вінниця, Україна",
"gender": "MALE",
"email": "email@example.com",
"tax_id": "3126509816",
"national_id": "CC7150985243",
"death_date": "2015-04-07T00:00:00.000Z",
"documents": [
{
"type": "PASSPORT",
"number": "120518",
"issue_date": "2015-04-07T00:00:00.000Z",
"expiry_date": "2015-04-07T00:00:00.000Z",
"issued_by": "DMSU"
}
],
"addresses": [
{
"type": "RESIDENCE",
"country": "UA",
"area": "Житомирська",
"region": "Бердичівський",
"city": "Київ",
"city_type": "CITY",
"street": "вул. Ніжинська",
"building": "15",
"apartment": "23",
"zip": "02090"
}
],
"phones": [
{
"type": "MOBILE",
"number": "+380503410870"
}
]
}
Attribute | Type | Description |
---|
relation_type | ENUM('RELATION_TYPE') |
|
first_name | STRING |
|
last_name | STRING |
|
second_name | STRING |
|
birth_date | STRING | ISO 8601 |
birth_place | STRING |
|
gender | ENUMTYPE |
|
tax_id | STRING |
|
phones | PHONES[] |
|
documents | DOCUMENTS[] |
|
authentication_methods
{
"type":"SMS",
"phone_number":"+380953330099"
}
Attribute | Type | Description |
---|
type | ENUM('AUTHENTICATION_METHODS') |
|
authentication_details | AUTHENTICATION_DETAILS |
|
OTP
OFFLINE
API
API Specification