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 declarations and filter them.

Key points

1. Declarations filtered by the user based on token details

Logic

Service logic

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

2. Get declaration’s details from ops.declarations table using person_id filter them by:

• status,

• start_date_from,

• start_date_to,

• end_date_from,

• end_date_to,

• page,

• page_size

3. Render response according to specification.

• Страница:

  RC (CSI-1758) Submit Encounter Package (E-Health)

  • episode-of-care_api

  • encounter-data-package_api

  • api_spec

• Страница:

  Submit Encounter Package (по шаблону) (Анжела Коваленко)

  • episode-of-care_api

  • encounter-data-package_api

  • api_spec

• Страница:

  Copy of Submit Encounter Package (Анжела Коваленко)

  • episode-of-care_api

  • encounter-data-package_api

  • api_spec

• Страница:

  (CSI-1713) Submit Encounter Package (CSI TEAM)

  • episode-of-care_api

  • encounter-data-package_api

  • api_spec

• Страница:

  (PCR-124) Submit Encounter Package (CSI TEAM)

  • episode-of-care_api

  • encounter-data-package_api

  • api_spec

• Страница:

  Submit Encounter Package (E-Health)

  • episode-of-care_api

  • encounter-data-package_api

  • api_spec

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

  • Return (403, 'Your scope does not allow to access this resource. Missing allowances: declaration: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