Table of Contents |
---|
...
This WS allows to mark Specimen as entered-in-error.
Specification
Link | |
Resource | /api/patients/patient_id/specimens/id/actions/ |
Scope | specimen:cancel |
Components | Specimen |
Microservices |
|
Protocol type | REST |
Request type | PATCH |
Sync/Async | Async |
Public/Private/Internal | Public |
...
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
patient_id |
| String | Unique patient identifier |
|
id |
| String | Unique specimen identifier | aff00bf6-68bf-4b49-b66d-f031d48922b3 |
Dictionaries
specimen_cancel_reasons
https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/17629119370/RC.+Specimen+dictionaries+and+configurable+parameters#Dictionaries
Request structure
See on Apiary
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 = 'specimen:cancel')
return 403 (“Your scope does not allow to access this resource. Missing allowances: specimen:cancel”) in case of invalid scope(s)
If BLOCK_UNVERIFIED_PARTY_USERS is true, then check party's data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at > current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):
in case not match - return 403 ("Access denied. Party is not verified")
If BLOCK_DECEASED_PARTY_USERS is true, check that party is not deceased (party_verification record does not equal to: dracs_death_verification_status = VERIFIED and dracs_death_verification_reason = MANUAL_CONFIRMED):
in case of error - return 403 ("Access denied. Party is deceased")
...
is an author of the Specimen (registered_by)
has a Med_Admin employee type
has an approval granted by the patient with access_level:write for the Specimen resource (approvals.granted_resources) and has a DOCTOR or SPECIALIST employee type
in case of error - return 409 ("Employee is not the one who registered the performer of specimen, doesndon't have an has approval or required employee type")
...
Create job and return it’s id.
Update specimen record with following:
status = $.status
status_reason = $.status_reason
updated_at = current datetime
updated_by = user_id from token
Response structure
See on Apiary
HTTP status codes
HTTP status code | Message | What caused the error |
401 | Invalid access token |
|
403 | Your scope does not allow to access this resource. Missing allowances: specimen:cancel |
|
403 | Access denied. Party is not verified |
|
403 | Access denied. Party is deceased |
|
404 | not found |
|
409 | Does not match the signer drfo |
|
409 | client_id refers to legal entity that is not active |
|
409 | User is not allowed to perform actions with an enity that belongs to another legal entity |
|
409 | Employee is not the one who registered the specimen, doesn't have an approval or required employee type |
|
409 | Specimen in status <status> cannot be cancelled |
|
422 | Invalid signed content |
|
422 | value is not allowed in enum |
|
422 | Signed content doesn't match with previously created specimen |
|