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

This method allows to find patient's declaration requests and filter them.

Key points

1. Declaration requests filtered by the user based on token details

Logic

Service logic

1. Get person_id from token (x-person-id header)

2. Get patient's declaration requests from il.declaration_requests table using person_id. Return records where is_shareable= true or channel = PIS

3. Filter records by:

• status,

• start_date_from,

• start_date_to,

• end_date_from,

• end_date_to,

• page,

• page_size

• channel

4. Render response according to specification.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

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 = 'declaration_request:read_pis')

  • Return (403, 'Your scope does not allow to access this resource. Missing allowances: declaration_request:read_pis ') in case of invalid scope(s)

Validate Person

• Get person_id from token (x-person-id header)

• Validate patient status is active (status = ‘active' & is_active = 'true’)

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

Processing

N/A

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used