| Table of Contents | ||||
|---|---|---|---|---|
|
Purpose
This method must be used to complete of existing patient's Care plan.
Specification
...
Link
...
...
Resource
...
/api/patients/{{patient_id}}/care_plans/{{id}}/actions/complete
...
Scope
...
care_plan:write
...
Components
...
Care plan
...
Microservices
...
me/api-medical-events
me/event-consumer
me/kafka-consumer
il/api(rpc)
...
Protocol type
...
REST
...
Request type
...
PATCH
...
Sync/Async
...
Async
...
Public/Private/Internal
...
Public
Preconditions
A Care Plan should already be created
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.
Key points
Status can be changed by author of the Care plan who has an Approval granted by the patient on write Care plan resource
Complete performs without DS.
Status of the Care plan changed in async way. The result of the job should be a link on the Care plan details.
Input parameters
...
Input parameter
...
Values
...
Type
...
Description
...
Example
...
patient_id
...
MPI identifier of the patient
...
7c3da506-804d-4550-8993-bf17f9ee0402
...
id
...
Care Plan identifier
...
7c3da506-804d-4550-8993-bf17f9ee0403
Filters
No
Dictionaries
eHealth/care_plan_complete_reasons
Request structure
See on Apiary
Example:
| Expand | ||
|---|---|---|
| ||
|
Authorize
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 = 'care_plan:write')
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
Headers
Наприклад:
Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{mis_client_secret}}
Request data validation
Validate legal entity
Extract client_id from token
Check legal entity status is ACTIVE
In case of error - return 409 ('Legal entity must be ACTIVE')
Check legal entity type in me_allowed_transactions_le_types config parameter
in case of error - return 409 ('Action is not allowed for the legal entity type')
Validate User
...
Extract user_id from token.
Check user has an active and approved employee that:
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)
...
| Table of Contents | ||||
|---|---|---|---|---|
|
Purpose
This method must be used to complete of existing patient's Care plan.
Specification
| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Preconditions
A Care Plan should already be created
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.
Key points
Status can be changed by
author of the Care planemployee who has an Approval granted by the patient on write Care plan resourceComplete performs without DS.
Status of the Care plan changed in async way. The result of the job should be a link on the Care plan details.
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
patient_id | MPI identifier of the patient |
| ||
id | Care Plan identifier |
|
Filters
No
Dictionaries
eHealth/care_plan_complete_reasons
Request structure
See on Apiary
Example:
| Expand | ||
|---|---|---|
| ||
|
Authorize
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 = 'care_plan:write')
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
Headers
Наприклад:
Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{mis_client_secret}}
Request data validation
Validate legal entity
Extract client_id from token
Check legal entity status is ACTIVE
In case of error - return 409 ('Legal entity must be ACTIVE')
Check legal entity type in me_allowed_transactions_le_types config parameter
in case of error - return 409 ('Action is not allowed for the legal entity type')
Validate User
Extract user_id from token.
Check user has an active and approved employee that: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)Return 403 ('Access denied') in case employee has not specified as author of the care plan, or has no Approval on write
Get list of APPROVED employees with this user_id in current Legal Entity
Check that for user one of the conditions is TRUE:
user has an employee that specified as author of the care plan ($.care_plan.author.identifier.value is in the list of APPROVED employees) and has an approval granted by the patient with access_level:write for this care plan resource ($.approvals.granted_resources.identifier.value==$.care_plan._id AND $.approvals.granted_to.identifier.value==PRM.employees.id AND $.approvals.access_level='write')
OR check that user has an employee who belongs to the legal entity that owns this care plan (managing_organization), which has an approval granted by the patient with access_level:write for this care plan resource ($.approvals.granted_resources.identifier.value==$.care_plan._id AND $.approvals.granted_to.identifier.value==PRM.employees.id AND $.approvals.access_level='write')
otherwise, return error 409 "User is not allowed to cancel care plan"
Validate data consistency
...