Page Properties

id	ENT-005-011-002

ID метода

API-005-011-002-0192

Автор

Viacheslav Tybin (SoE eHealth)

Версія документа

1.0

Статус документа

Status

title	draft

Назва метода (укр.)

Затвердити запит декларації через Кабмін

Назва метода (eng.)

Approve declaration request via Cabinet

Короткий опис метода

Для затвердження запиту на декларацію пацієнтом в кабінеті.

...

Note
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] Approve declaration request via Cabinet [API-005-010-002-0195]
Guideline ID	GUI-0011
Author	Viacheslav Tybin (SoE eHealth)
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-005-010-002-0195
Microservices (namespace)	IL
Component	Patient Cabinet
Component ID	COM-005-010
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-patient-cabinet/cabinet/approve-declaration-request-via-cabinet
Resource	{{host}}/api/cabinet/declaration_requests/{{id}}/actions/approve
Scope	declaration_request:write
Protocol type	REST
Request type	PATCH
Sync/Async	Sync
Public/Private	Public

Purpose

This WS is created to approve declaration request online via Cabinet by patient.

After /wiki/spaces/PCAB/pages/583401903 it has to be approved. Declaration request that was created online could be approved only online by a patient. Declaration request that was created offline in Clinic by Doctor could be apporoved offline by employees of a Clinic only. While the patient in cabinet always has auth method otp, sms is not checked on online approve. Each patient could approve only their own declaration request.

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the systemN/A

Configuration parameters

N/A

Dictionaries

PHONE_TYPE
CONFIDANT_PERSON_TYPE
GENDER
PREFERRED_WAY_COMMUNICATION
DOCUMENT_TYPE
DOCUMENT_RELATIONSHIP_TYPE
POSITION
EMPLOYEE_TYPE
EMPLOYEE_STATUS
COUNTRY
EDUCATION_DEGREE
QUALIFICATION_TYPE
SPECIALITY_TYPE
SPECIALITY_LEVEL
SPEC_QUALIFICATION_TYPE
SCIENCE_DEGREE
ADDRESS_TYPE
SETTLEMENT_TYPE
STREET_TYPE
LEGAL_FORM

Input parameters

Description of input parameters

	Input parameter	Mandatory	Type	Description	Example
1	id		String	Declaration request id. Required.	b075f148-7f93-4fc2-b2ec-2d81b19a9b7b
2

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

...

title	Example

...

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

Request structure

See on API-specification

Expand

title	Example

Code Block

Headers

Request data validation

Authorize

Verify the validity of access token
1. Return 401 in case validation fails
Check user scopes in order to perform this action (scope = 'declaration_request:write')
1. Return 403 in case invalid scope(s)

Validate request

check $.id exists in il.declaration_requests.id

in case error return 404 "Declaration request was not found"

Check channel

if channel = CABINET do not check authentication method and do not check sms
if channel = MIS return error 403 "Declaration request should be approved by Doctor"

Validate user

get user_id from token

check if users.person_id=$.declaration_request.mpi_id
- in case error return 409 - "Declaration request could not be approved for another person"

Check doctor's limit

Get employee.id from declaration request

...

If amount of declaration for party >= parties.declaration_limit and declaration.overlimit is not true
- return error 422 - This doctor reaches his limit and could not sign more declarations

Declaration request status

Check declaration status = 'NEW'

in case error return 409 "Wrong declaration request status"

Processing

Change declaration request status

Change entity status in IL_DB.declaration_request to APPROVED

Response structure examples

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API response structure, example

Expand

title	Example

Code Block

language	json

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
    "declaration_number": "0000-12H4-245D",
    "start_date": "2017-03-02",
    "end_date": "2017-03-02",
    "person": {
      "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "first_name": "Петро",
      "last_name": "Іванов",
      "second_name": "Миколайович",
      "birth_date": "1991-08-19",
      "gender": "FEMALE",
      "tax_id": "3126509816",
      "phones": [
        {
          "type": "MOBILE",
          "number": "+380503410870"
        }
      ],
      "birth_settlement": "Вінниця",
      "birth_country": "Україна",
      "unzr": "19910819-00011",
      "emergency_contact": {
        "first_name": "Петро",
        "last_name": "Іванов",
        "second_name": "Миколайович",
        "phones": [
          {
            "type": "MOBILE",
            "number": "+380503410870"
          }
        ]
      },
      "confidant_person": [
        {
          "relation_type": "PRIMARY",
          "first_name": "Петро",
          "last_name": "Іванов",
          "second_name": "Миколайович",
          "birth_date": "1991-08-19",
          "birth_country": "Україна",
          "birth_settlement": "Вінниця",
          "gender": "MALE",
          "email": "confidant_person@example.com",
          "tax_id": "3126509816",
          "secret": "secret",
          "unzr": "19900101-00099",
          "preferred_way_communication": "email",
          "documents_person": [
            {
              "type": "PASSPORT",
              "number": "АА120518",
              "expiration_date": "2021-02-28",
              "issued_by": "Рокитнянським РВ ГУ МВС Київської області",
              "issued_at": "2017-02-28"
            }
          ],
          "documents_relationship": [
            {
              "type": "BIRTH_CERTIFICATE",
              "number": "АА120518",
              "issued_by": "Рокитнянським РВ ГУ МВС Київської області",
              "issued_at": "2017-02-28"
            }
          ],
          "phones": [
            {
              "type": "MOBILE",
              "number": "+380503410870"
            }
          ]
        }
      ]
    },
    "employee": {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "position": "P1",
      "employee_type": "DOCTOR",
      "status": "APPROVED",
      "start_date": "2017-03-02T10:45:16.000Z",
      "end_date": "2018-03-02T10:45:16.000Z",
      "party": {
        "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
        "first_name": "Петро",
        "last_name": "Іванов",
        "second_name": "Миколайович"
      },
      "division_id": "4cffa825-8b5b-4cba-9a38-fb57733e14b2",
      "legal_entity_id": "be3a154c-3e07-496d-9680-f22c443f5d0c",
      "doctor": {
        "educations": [
          {
            "country": "UA",
            "city": "Київ",
            "institution_name": "Академія Богомольця",
            "issued_date": "2017-02-28",
            "diploma_number": "DD123543",
            "degree": "MASTER",
            "speciality": "Педіатр"
          }
        ],
        "qualifications": [
          {
            "type": "SPECIALIZATION",
            "institution_name": "Академія Богомольця",
            "speciality": "Педіатр",
            "issued_date": "2017",
            "certificate_number": "2017",
            "valid_to": "2017",
            "additional_info": "додаткова інофрмація"
          }
        ],
        "specialities": [
          {
            "speciality": "THERAPIST",
            "speciality_officio": true,
            "level": "FIRST",
            "qualification_type": "AWARDING",
            "attestation_name": "Академія Богомольця",
            "attestation_date": "2017-02-28",
            "valid_to_date": "2020-02-28",
            "certificate_number": "AB/21331"
          }
        ],
        "science_degree": {
          "country": "UA",
          "city": "Київ",
          "degree": "",
          "institution_name": "Академія Богомольця",
          "diploma_number": "DD123543",
          "speciality": "Педіатр",
          "issued_date": "2017"
        }
      }
    },
    "division": {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "name": "Бориспільське відділення Клініки Ноунейм",
      "addresses": [
        {
          "type": "RESIDENCE",
          "country": "UA",
          "area": "Житомирська",
          "region": "Бердичівський",
          "settlement": "Київ",
          "settlement_type": "CITY",
          "settlement_id": "b075f148",
          "street_type": "STREET",
          "street": "вул. Ніжинська",
          "building": "15",
          "apartment": "23",
          "zip": "02090"
        }
      ],
      "phones": [
        {
          "type": "MOBILE",
          "number": "+380503410870"
        }
      ],
      "email": "email@example.com",
      "location": {
        "latitude": 30.1233,
        "longitude": 50.32423
      }
    },
    "legal_entity": {
      "id": "d290f1ee",
      "name": "Клініка ЦПМСД №1",
      "short_name": "ЦПМСД №1",
      "legal_form": "140",
      "public_name": "ЦПМСД №1",
      "edrpou": "5432345432",
      "status": "ACTIVE",
      "email": "email@example.com",
      "phones": [
        {
          "type": "MOBILE",
          "number": "+380503410870"
        }
      ],
      "addresses": [
        {
          "type": "RESIDENCE",
          "country": "UA",
          "area": "Житомирська",
          "region": "Бердичівський",
          "settlement": "Київ",
          "settlement_type": "CITY",
          "settlement_id": "b075f148",
          "street_type": "STREET",
          "street": "вул. Ніжинська",
          "building": "15",
          "apartment": "23",
          "zip": "02090"
        }
      ]
    },
    "status": "active",
    "scope": "family_doctor",
    "declaration_request_id": "74a6fae6-4207-4e03-a136-f2e70c6b0c02",
    "content": "Declaration content",
    "inserted_at": "2017-03-02T10:45:16.000Z",
    "updated_at": "2017-03-02T10:45:16.000Z"
  },
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

6

	Response code	HTTP Status code	Message	Internal name	Description	Response code	HTTP Status code	Internal name
1	Базові
2		200	Response
3		401		Validation failed
4		403	Declaration request should be approved by Doctor	Invalid scope(s)
5	1000	404	Composition not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок
Doctor	Invalid scope(s)
5		404	Declaration request was not found	Validation failed	7	401	Unauthorized	Помилка підтвердження
86		409	Declaration request could not be approved for another person	Validation failed
97		409	Wrong declaration request status
108		422	This doctor reaches his limit and could not sign more declarations	Validation failed
119	Специфічні
1210						422	Only for active MPI record can be created medication request!

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical N/A

Technical modules where the method is used

Название	ID ТМ	Статус
/wiki/spaces/ESOZ/pages/17378181218	TM0112
/wiki/spaces/YK/pages/17837688354

Versions Compared

Old Version 7

New Version Current

Key

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request structure

Headers

Request data validation

Authorize

Validate request

Check channel

Validate user

Check doctor's limit

Declaration request status

Processing

Change declaration request status

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Technical modules where the method is used

Page Comparison

Versions Compared

Old Version 7

New Version Current

Key

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request structure

Headers

Request data validation

Authorize

Validate request

Check channel

Validate user

Check doctor's limit

Declaration request status

Processing

Change declaration request status

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Technical modules where the method is used