ЕСОЗ - публічна документація

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 25 Current »

Database model

See https://github.com/Nebo15/ehealth.api/tree/master/specs/database_schema

JSON objects structure

documents

Array of document objects

Documents sample
[
   {
      "type":"PASSPORT",
      "number":"120518",
      "issue_date":"2015-04-07T00:00:00.000Z",
      "expiration_date":"2015-04-07T00:00:00.000Z",
      "issued_by":"DMSU"
   }
]
AttributeTypeDescription
typeENUM('DOCUMENT_TYPE')
numberSTRING
issue_dateSTRINGISO 8601
expiration_dateSTRINGISO 8601
issued_bySTRING

addresses

Array of address objects

Addresses sample
[
      {
        "type": "RESIDENCE",
        "country": "UA",
        "area": "Житомирська",
        "region": "Бердичівський",
        "city": "Київ",
        "street_type": "STREET",
        "street": "Ніжинська",
        "building": "15",
        "apartment": "23",
        "zip": "02090"
      }
    ]
AttributeTypeDescription
typeSTRING
countryENUM('COUNTRY_CODE')
areaSTRING
regionSTRING
citySTRING
city_typeENUM('CITY_TYPE')
streetSTRING
buildingSTRING
apartmentSTRING
zipSTRING

phones

Array of phone objects

Phones sample
[
      {
        "type": "MOBILE",
        "number": "+380503410870"
      }
    ]
AttributeTypeDescription
typeENUM('PHONE_TYPE')
numberSTRINGITU E.164

emergency_contact

Emergency contact sample
{
      "first_name": "Петро",
      "last_name": "Іванов",
      "second_name": "Миколайович",
      "phones": [
        {
          "type": "MOBILE",
          "number": "+380503410870"
        }
      ]
    }
AttributeTypeDescription

first_name

STRING

last_name

STRING

second_name

STRING
phonesPHONES[]

confidant_person

Confidant person sample
{
      "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"
        }
      ]
    }
AttributeTypeDescription

relation_type

ENUM('RELATION_TYPE')

first_name

STRING

last_name

STRING

second_name

STRING

birth_date

STRINGISO 8601

birth_place

STRING

gender

ENUMTYPE

tax_id

STRING
phonesPHONES[]
documentsDOCUMENTS[]

authentication_methods

Authentication methods sample
{
   "type":"SMS",
   "phone_number":"+380953330099"
}
AttributeTypeDescription
typeENUM('AUTHENTICATION_METHODS')
authentication_detailsAUTHENTICATION_DETAILS

OTP

  • phone_number

OFFLINE

API

API Specification

  • No labels