ЕСОЗ - публічна документація
Qualify Service Request by id
Purpose
This method checks the possibility of using the direction according to the program.
Specification
Link | |
Resource | /api/service_requests/{{service_request_id}}/actions/qualify |
Scope | service_request:use |
Components | Service request |
Microservices | API paragraph not found |
Protocol type | REST |
Request type | POST |
Sync/Async | Async |
Public/Private/Internal | Public |
Logic
Перевірка та взяття в обробку направлення за програмою медичним закладом
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
service_request_id |
| String | Unique service request identifier |
|
Request structure
See on Apiary
Example:
Authorize
Request to process the request using a token in the headers
Verify the validity of access token
Return (401, 'unauthorized') in case of validation fails
Verify that token is not expired
in case of error - return (401, 'unauthorized')
Check user scopes in order to perform this action (scope = 'service_request:write')
Return (403, 'invalid scopes') in case of invalid scope(s)
Headers
Наприклад:
Content-Type:application/json
Authorization:Bearer: {{access_token}}
api-key: {{secret}}
Request data validation
Validate request using JSON Schema
Return 422 with the list of validation errors in case validation fails
Validate request
legal entity(client_id)
Check legal_entity.type in me_allowed_transactions_le_types config parameter and legal_entity.status = ACTIVE
in case of error return 409 "Action is not allowed for the legal entity"
service request
validate SR.program_processing_status in (new,In Queue,In Progress)
in case error return 409, “service request has wrong status“
validate SR.status = Active
in case error return 409, “service request has wrong status“
If SR.based_on is present:
Verify submitted Activity:
It has scheduled, in_progress status
in case of error return 409, "Invalid activity status")
if quantity was set, then validate remaining_quantity greater then zero:
in case of error return 409, "The number of available services according to the care plan activity has been exhausted"
Verify Care plan:
It should be in active status
in case of error return 409, "Care plan is not active"
Care plan's period end (if exist) should be greater than current date or equal.
in case of error return 409, “Care plan expired“
Validate remaining quantity of services is still available:
If SR has quantity:
Validate remaining_quantity within SR is greater then zero
in case of error return 409 (The number of available services according to the service request has been exhausted)
If SR has no quantity, but it is based on activity with quantity:
Validate remaining_quantity within Activity is greater then zero
in case of error return 409 (The number of available services according to the care plan activity has been exhausted)
program
For each program validate it is an existing service program with type=service
in case not found or is_active==false write result in Data collection according to apiary
in case type!= service write result in Data collection according to apiary - "Invalid program type"
For each program validate that service(or service_group) is an active member of the program
Select is_active from PRM.program_services where service_id(or group_id) == $.signed_content.code.identifier.value and program_id=$.program.identifier.value
if not found or is_active==false write result in Data collection according to apiary - "Service is not included in the program"
Processing
API paragraph not found
Response structure
See on Apiary
Example:
Prepare & return response data structure
For each program in array prepare response
If it is any or some errors from validations return “NOT VALID“ with error msg
Post-processing processes
API paragraph not found
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 |
|
|
401 | Unauthorized |
|
403 | Invalid scopes |
|
409 |
| Validation failed |
422 |
| Validation failed |
ЕСОЗ - публічна документація