Purpose
This method must be used to complete of existing patient's Care plan.
Specification
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 |
| ||
id | Care Plan identifier |
|
Filters
No
Dictionaries
eHealth/care_plan_complete_reasons
Request structure
See on Apiary
Example:
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
Validate data consistency
Ensure that submitted Care plan relates to the Patient (from URL)
Return 404 (not found) in case of error
Validate status transition
Get Care plan by id
Check status: care plan status should be changed according to Care plan status model.
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
Validate field type is codeable concept
Check that codeable concept refers to
eHealth/care_plan_complete_reasonsdictionaryValidate value within dictionary specified above
in case of error - return 422 ('value is not allowed in enum')
Validate activities
Get Care plan activities
Check all activities has final status.
Return 409 (Care plan has scheduled or in-progress activities) in case if activities not in final statuses found
Check that Care plan has at least one activity in status=completed
Return 409 ('Care plan has no one completed activity') in case if completed activities not found
Processing
Service logic
Update Care plan status (update also updated_at, updated_by)
Set $.status_history
Response structure
See on Apiary
Example: