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 method must be used to complete of existing patient's Care plan.

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

Key points

1. Status can be changed by author of the Care plan who has an Approval granted by the patient on write Care plan resource

2. Complete performs without DS. 

3. Status of the Care plan changed in async way. The result of the job should be a link on the Care plan details.

Logic

This method must be used to complete of existing patient's Care plan.

Please see Care plan status model

It can be processed in both sync and async methods depends on Server decision.

Service logic

1. Update Care plan status (update also updated_at, updated_by)

2. Set $.status_history

Configuration parameters

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

Dictionaries

eHealth/care_plan_complete_reasons

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

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

Request to process the request using a token in the headers

Validate legal entity

1. Extract client_id from token

2. Check legal entity status is ACTIVE

   1. In case of error - return 409 ('Legal entity must be ACTIVE')

3. Check legal entity type in me_allowed_transactions_le_types config parameter

   1. in case of error - return 409 ('Action is not allowed for the legal entity type')

Validate User

1. Extract user_id from token.

2. Check user has an active and approved employee that:

   1. is specified as Author of the Care plan and has an active Approval granted by the Patient on write the Care plan resource (care plan id from URL)

      1. Return 403 ('Access denied') in case employee has not specified as author of the care plan, or has no Approval on write

Validate data consistency

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

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

Validate status transition

1. Get Care plan by id

2. Check status: care plan status should be changed according to Care plan status model.

   1. Return 409 ('Care plan in status <cancelled/completed> cannot be completed') in case of error

Validate status reason

Validate value in the field $.status_reason, required

1. Validate field type is codeable concept

2. Check that codeable concept refers to eHealth/care_plan_complete_reasons dictionary

3. Validate value within dictionary specified above

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

Validate activities

1. Get Care plan activities

2. Check all activities has final status. 

   1. Return 409 (Care plan has scheduled or in-progress activities) in case if activities not in final statuses found

3. Check that Care plan has at least one activity in status=completed

   1. Return 409 ('Care plan has no one completed activity') in case if completed activities not found

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used