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

Returns care plan details by it's identifier in patient context. To obtain activity list for the Care plan Get Care Plan activities  should be used.

Процеси роботи з планом лікування (care plan) | Отримання інформації плану лікування

Logic

Returns care plan details by it's identifier in patient context

Service logic

Service returns specified Care plan related to the patient, but without Care plan’s activities:

1. Get activity by ID from care_plan_activities collection (MongoDB)

2. Validate data consistency:

   1. Ensure that requested Care plan relates to requested Patient (from URL)

      1. Return 404 ('not found') in case of error

3. Render a response according to specification

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

eHealth/care_plan_categories

eHealth/ICD10_AM/condition_codes

PROVIDING_CONDITION

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorize

1. Verify the validity of access token

   1. 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 = 'care_plan:read')

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

Request to process the request using a token in the headers

Validate Patient

1. Get Patient identifier from the URL

2. Check it exists in DB

   1. Return 404 ('not found') in case of error

Validate Care plan

1. Get Care plan identifier from the URL

2. Check it exists in DB

   1. Return 404 ('not found') in case of error

3. Check Care plan belongs to patient

   1. Return 404 ('not found') in case of error

Validate User

1. Extract user_id from token.

2. Check user has an active and approved employee from legal entity (token) for which one of the conditions is TRUE:

   1. has an active Approval granted by the Patient on write or read the Care plan resource (care plan id from URL)

      1. Return 403 ('Access denied') in case employee has no Approval on read or write

   2. has an active declaration with the patient

      1. Return 403 ('Access denied') in case there no active declaration with patient and none of other conditions is true

   3. user belongs to the legal entity where the care_plans were created

      1. Return 403 ('Access denied') in case employee belongs to another legal_entity and none of conditions above is true

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