Versions Compared

Version Old Version 7 New Version 8
Changes made by

Anastasiia Prokhorova (SoE eHealth) (Unlicensed)

Anzhela Kovalenko (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

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

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методуDRAFT] Approve Declaration Request V3 [API-005-004-002-0075]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-005-004-002-0075

Microservices (namespace)

IL

Component

Declarations

Component ID

COM-005-004

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/declaration-requests/approve-declaration-request-v3

Resource

{{host}}/api/v3/declaration_requests/{{id}}/actions/approve

Scope

declaration_request:approve

Protocol type

REST

Request type

PATCH

Sync/Async

Sync

Public/Private

Public

...

  1. In case if persons current authentication method is OTP, request body must contain verification_code field with OTP.

  2. For any other authentication method, request body must be empty, but additional documents upload is needed for OFFLINE authentication method.

Logic

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

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 ConfluenceN/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

2

Request structure

See on API-specification

Expand
titleExample
Code Block

...

language

...

json

...

Value

...

Mandatory

...

Description

...

Example

...
Headers
Headers 
Request data validation
Authorize user
  1. Verify the validity of access token
  2. Check user scopes declaration_request:write in order to perform this action
    1. In case error - generate 401 response
Validate request
  1. Validate request using JSON schema
    1. In case validation failed - generate 422 error
JSON Schema 
 Expand
 Code Block
languagejson
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "verification_code": {
      "type": "string"
    }
  },
  "required": [
    "verification_code"
  ],
  "additionalProperties": false
}
Validate person verification status
  • validate patient's verification_status is not equal to NOT_VERIFIED.
    • in case of error return 409, "Patient is not verified"
Get declaration request details
Get declaration request from IL_DB.declaration_request
Determine authorization method
Get authorization_method from IL_DB.declaration_request
 Code Block
SELECT IL_DB.declaration_request.authentication_method
FROM   IL_DB.declaration_request
WHERE IL_DB.declaration_request.id = :id

If authentication_method_current is NULL - return Error
...
If authentication_method_current = NA - verify Parent declaration
Verify code
Invoke verification module to verify OTP
OTP Verification
Check uploaded documents
Invoke Media Content Storage to check documents exist
Verify Parent declaration
Get parent_declaration_id from IL_DB.declaration_requests.parent_declaration_id:
...
  1. Change entity status in IL_DB.declaration_request to APPROVED
  2. Set status_reason to doctor_confirmed
  3. Set is_shareable to true
  4. Set updated_at - now() (Get current date-time)
  5. Set updated_by - user_id (Extract user from token)
...
 Expand
titleExample
 Code Block
languagejson
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
201
 Response
 
3
401
 
Invalid scopes
4
404
Active parent declaration was not found
5
409
Patient is not verified
 
6
422
This doctor has X declarations and could not sign more
7
Специфічні
8
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
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...