REST API method / Метод REST API (настанова) (remove the link block before publishing the document)
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | Create Declaration Request online |
Guideline ID | GUI-0011 |
Author | |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-005-010-002-0194 |
Microservices (namespace) | IL |
Component | Patient Cabinet |
Component ID | COM-005-010 |
Link на API-специфікацію | |
Resource | {{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package |
Scope | declaration_request:write |
Protocol type | REST |
Request type | POST |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This method is used to create Declaration Request online (as part of Declaration creation process)
Logic
Global and configurable parameters
Get global parameters
Invoke Global parameters to get following parameters:
ADULT_AGE
DECLARATION_TERM
cURL example
curl -X GET \
{:host}/prm/api/global_parameters
Configuration parameters
N/A
Dictionaries
EMPLOYEE_TYPE
DOCUMENT_TYPE
ADDRESS_TYPE
SETTLEMENT_TYPE
STREET_TYPE
PHONE_TYPE
DOCUMENT_RELATIONSHIP_TYPE
POSITION
LEGAL_FORM
ACCREDITATION_CATEGORY
DIVISION_TYPE
GENDER
AUTHENTICATION_METHOD
PREFERRED_WAY_COMMUNICATION
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | |||||
| 2 |
|
|
|
|
|
Request structure
See on API-specification
Headers
Request data validation
Authorize
Verify the validity of access token
Return 401 in case validation fails
Check user scopes in order to perform this action (scope = 'declaration_request:write')
Return 403 in case invalid scope(s)
Authorize
Verify the validity of access token
Return 401 in case validation fails
Check user scopes in order to perform this action (scope = 'declaration_request:write')
Return 403 in case invalid scope(s)
Validate request
Validate request according to JSON Schema
Return 422 with list of validation errors in case of validation fails (422 EView)
Get Person from token
Extract person_id from token.
Validate Person
User can create declaration request via cabinet only for himself
Check that person_id from request ($.person_id) matches with person_id from token
Check tax_id from users.tax_id=persons.tax_id
Check that person_id exists
In case error - return 422 error:
{:error, [{%{
description: "Invalid person",
params: [],
rule: :invalid
}, "$.person_id"}]}
Validate Employee
Validate that employee_id exists
In case error - return 422 error:
{:error, [{%{
description: "Employee not found",
params: [],
rule: :invalid
}, "$.employee_id"}]}
Validate Division
Validate that division_id exists
In case error - return 422 error:
{:error, [{%{
description: "Division not found",
params: [],
rule: :invalid
}, "$.division_id"}]}
Calculate patient age
Calculate patient age
age = MONTHS_BETWEEN (now(), Person.birth_date) / 12
Check that doctor speciality meets the patient age requirements
Check age requirements according to values in response from previous step.
Doctor speciality | Age |
|---|---|
FAMILY DOCTOR | All ages |
THERAPIST | Greater or equal to $.data.adult_age |
PEDIATRICIAN | Less than $.data.adult_age |
Processing
Calculate declaration end/start date
Start date:
start_date = Current_date()
End date:
if (person.age < 18) {
end_date = min(birth_date + 18y - 1d, start_date + declaration_term);
} else {
end_date = start_date + declaration_term;
}
Set default authorization method
Do not check current authorization method in MPI
Set default value to "NA" for all declaration requests online (cabinet)
Generate printout form
Invoke MAN to render print form.
Declaration request printout template:
DECLARATION_REQUEST_PRINTOUT_FORM_TEMPLATE_ID: "4"
Set IL.declaration_request.printout_content as MANResponse.$.data
Save request to DB
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 201 | Response |
| ||
| 3 | 401 | Validation fails | |||
| 4 | 403 | Invalid scope(s) | |||
| 5 | 422 | Division not found | |||
| 6 | 422 | Employee not found | |||
| 7 |
| 422 | Invalid person | ||
| 8 | 422 | Validation failed | |||
| 9 | Специфічні | ||||
| 10 |
| ||||
Post-processing processes
N/A
Technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||