REST API method / Метод REST API (настанова) (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 create a unique requisition number that can be later used as a Composition title in Create Composition method. Generated requisition number is stored in ME database until it is expired.

Logic

Service logic

1. Generate requisition number using Human readable requisition number algorithm based on patient_id

2. Use prefix from configuration instead of first 4 symbols: {{composition_type}}_TITLE_PREFIX (ex. ADOPTION_TITLE_PREFIX) If prefix can't be get from chart-parameters Return 500 error

3. Check that there is no Composition in ME.Compositions collection with such title

   1. if it already exists generate new requisition as it is described in Human readable requisition number | Solution section

4. Check that there is no record in ME.requisition_number with such requisition

   1. if it already exists generate new requisition as it is described in Human readable requisition number | Solution section

5. Save generated title in ME.requisition_number

   1. requisition_number = generated requisition

   2. patient_id = patient id from the request

   3. expiration_date = current datetime + COMPOSITION_TITLE_EXPIRATION_PERIOD (config parameter in ehealth.charts)

   4. composition_type = composition_type from query parameters

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Validations

1. Validate composition_type is COMPOSITION_TYPES dictionary

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

2. Check that сomposition_type is NOT from COMPOSITION_TYPE_BLACK_LIST

   1. Return 422 ("сomposition_type is not allowed by configuration") in case of error

Authorization

1. Verify the validity of access token

   1. in case of error - return 401 (“Invalid access token”) in case of validation fails

2. Verify that token is not expired

   1. in case of error - return 401 (“Invalid access token”)

3. Check user scopes in order to perform this action (scope = 'composition:create')

   1. return 403 (“Your scope does not allow to access this resource. Missing allowances: composition:create”) in case of invalid scope

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

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

Processing

N/A

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

[Job] Deactivate requisition numbers

Purpose

This procedure (automatic schedule task) is designed to deactivate Requisition numbers when it became expired.

Process configuration

Job logic

1. Delete records from ME.requisition_number, where:

   1. end_date < current_date()

2. Write changes to audit log

Technical modules where the method is used