Table of Contents | ||||
---|---|---|---|---|
|
...
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
patiend_id | String | identifier of the patient |
| |
id | String | identifier of the approval |
|
Authorize
...
Headers
...
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9api-key:uXhEczJ56adsfh3Ri9SUkc4en
Authorization
Verify the validity of access token
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 = 'approval:cancel')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: approval:cancel') in case of invalid scope(s)
Validate Patient
Get Patient identifier from the URL
Check it exists in DB
Return 404 ('Person is not found') in case of error
Validate Approval
Get Approval identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Check approval status is active in DB
Return 409 ('Approval can be cancelled only if it has new or active status') in case of error
Validate User
Extract user_id from token.
Check user has an active declaration with a patient from URL (can cancel all approvals) or approval is granted to user (can cancel own approval):
Return 403 ('No active declaration with patient found or declaration is not from the same MSP') in case the employee doesn't have an active declaration with the patient
Response structure
See on Apiary
...
Expand | ||
---|---|---|
| ||
|
Service logic
Service allow to cancel of the patient approval:
Get approval by patient_id and approval id from approvals collection (MongoDB)
Update approvals status (update also updated_at, updated_by)
If patient's authentication method is OTP or third_person.OTP, send SMS to that patient with info about cancelling.
Render a response according to specification.
Add status to event manager
After status was changed (status = CANCELLED) - add new status to event_manager
field | value |
---|---|
|
|
| Approval |
| $.id |
| $.status |
| $.update_at |
| $. |
HTTP status codes
Page Properties | |||||||||
---|---|---|---|---|---|---|---|---|---|
|
...