Versions Compared

Old Version 2

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
REST API method / Метод REST API (настанова)
Info
Note

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

Info

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

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API
Scope

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методу]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-001005-001004-001002-00010077

Microservices (namespace)

MPIIL

Component

AuthDeclarations

Component ID

COM-001005-001004

Link на API-специфікацію

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/managedeclaration-client-configuration/get-client-detailsrequests/reject-declaration-request-v3

Resource

{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package

/v3/declaration_requests/{{id}}/actions/reject

Scope

declaration_request:reject

Protocol type

REST

Request type

PATCH

Sync/Async

Sync

Public/Private

Public

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessaryUse this method to reject previously created Declaration Request

Key features

  1. Only authenticated and authorized user can reject declaration request

  2. New and Approved declaration request can be rejected (/wiki/spaces/PCAB/pages/17513775491 )

  3. Declaration request can be rejected only by the employee who works in the same legal entity in which the request was created

  4. Declaration requests created by patient via PIS and assigned to legal entity could be rejected by legal entity as well

Logic

Update declaration request

  1. Change entity status in IL_DB.declaration_request to REJECTED

  2. Set status_reason:

    1. If channel = MIS - set status_reason to doctor_reject

    2. If channel = PIS - set status_reason to doctor_rejected_over_limit

  3. Set updated_at - now() (Current date-time)

  4. Set updated_by - user_id (Extract user from token)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input

...

parameters

Composition object ID

Input parameter

Mandatory

Type

Description

Example

1

composition_id

 M

String ($uuid) (path)

 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

2

Request structure

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

Description of the REST API request structure, example

Expand
titleExample
Code Block
Headers
Key
Value
Mandatory
Description
Example
1
2
Content-Type
application/json
M
Тип контенту
Content-Type:application/json
2
Authorization
Bearer c2778f3064753ea70de870a53795f5c9
M
Перевірка користувача
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
3
Request data validation
...
3
Request data validation
Authorization
  • Verify the validity of access token
    • in case of error - return 401 (“Invalid access token”) in case of validation fails
  • Verify that token is not expired
    • in case of error - return 401 (“Invalid access token”)
  • Check user scopes in order to perform this action (scope = 'declaration_request:reject')
    • return 403 (“Your scope does not allow to access this resource. Missing allowances: declaration_request:reject”) in case of invalid scope(s)
Validation declaration request
  1. Check that declaration request with such ID exists in the system (is_active = true)
    1. In case of error - return 404
  2. Check that declaration request is allowed to be processed on LE (channel == MIS OR is_shareable == True)
    1. In case of error - return 403
  3. Check that declaration request belongs to the same legal entity as the user
    1. In case of error - return 403
Validate transition
  1. Check transition according to /wiki/spaces/PCAB/pages/17513775491
    1. In case of error - return 409 (“Invalid transition“)
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
Description of the REST API response structure, exampleSee on API-specification 
 Expand
titleExample
 Code Block
HTTP status codes
Only for active MPI record can be created medication request!
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
201
1000 Response
404 
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
3
401
Unauthorized
Помилка підтвердження
4
Специфічні
5
422
3
401
 Access token validation failed
4
401
Invalid access token
5
403
Check that declaration request belongs to the same legal entity as the user failed
6
403
 Invalid scopes
7
403
Your scope does not allow to access this resource. Missing allowances: declaration_request:reject
8
404
Check that declaration request with such ID exists in the system (is_active = true) failed
9
409
Invalid transition
10
Специфічні
11
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...