https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

• Properties of a REST API method document

• Purpose

• Logic

• Configuration parameters

• Dictionaries

• Input parameters

• Request structure

• Headers

• Request data validation

• Processing

• Response structure examples

• HTTP status codes

• Post-processing processes

• Technical modules where the method is used

Properties of a REST API method document

Purpose

This WS allows to mark Specimen as entered-in-error.

Key points

1. Only an employee who registered a Specimen, has an approval or a med_admin from the same legal entity, if they have an appropriate scope, are able to cancel the Specimen.

2. Request should be signed with DS.

3. The specimen is cancelled asynchronously

4. Signed content of a Specimen must be equal to the Specimen stored in DB. See Get Specimen details

5. status_reason must be added to signed content

6. status must be changed to entered_in_error for the purpose of displaying in the signed content

Logic

RC._Процеси роботи зі зразком біоматеріалу | Позначення Зразка помилковим без взаємодії з пацієнтом

Configuration parameters

N/A

Dictionaries

specimen_cancel_reasons
RC._Specimen dictionaries and configurable parameters_EN | Dictionaries

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

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")

Validate Digital Sign

• Validate request is signed

  • in case of error - return 422 (“Invalid signed content”)

• Check DS is valid and not expired

• Validate that DS belongs to the user

  • Check that DRFO from DS and user's party.tax_id matches

    • in case of error - return 409 (“Does not match the signer drfo“)

Validate legal entity

• Extract client_id from token

• Check legal entity status (status = ACTIVE)

  • In case of error - return 409 ('client_id refers to legal entity that is not active')

• Validate the Specimen belongs to the legal entity where the current user works

  • Check $.specimen.managing_organization==token.client_id

    • in case of error - return 409 ("User is not allowed to perform actions with an enity that belongs to another legal entity")

Validate user

Cancelation of a Specimen is allowed for a user if he has one of the following active and approved employee that:

• 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 performer of specimen, don't has approval or required employee type")

Validate data consistency

• Ensure that submitted Specimen relates to the Patient (from URL)

  • in case of error - return 404 (not found)

Validate status transition

• Get Specimen by id

• Check Specimen’s status is available, unsatisfactory or unavailable

  • in case of error - return 409 ('Specimen in status <status> cannot be cancelled')

Validate request

Validate request by schema and return 422 error code with the list of validation errors in case of fails. User fills following fields in the request:

1. Status reason

Validate value in the field $.status_reason, CodeableConcept type, required.

• Check that value is in allowed values from specimen_cancel_reasons dictionary.

  • in case of error - return 422 ('value is not allowed in enum')

2. Status

The target status value must be submitted in the order to display in the signed content (media storage)

1. Validate $.status is entered_in_error

   1. in case of error - return 422 ("value is not allowed in enum")

Validate content

Signed content must match to the specimen from DB in order to be canceled

1. Render the specimen from DB

2. Exclude $status, $.status_reason from signed content

3. Compare rendered specimen and signed content

   1. In case both object doesn't match - return 422 ('Signed content doesn't match with previously created specimen')

Processing

1. Create job and return it’s id.

2. Update specimen record with following:

   1. status = $.status

   2. status_reason = $.status_reason

   3. updated_at = current datetime

   4. updated_by = user_id from token

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used