ЕСОЗ - публічна документація
Complete Care plan activity
Purpose
This method must be used to complete of existing activity from patient's Care plan.
Процеси роботи з планом лікування (care plan) | Завершення первинного призначення
Specification
Link | |
Resource | /api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities/{{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
An activity from the Patient Care Plan must already be created
Logic
This method must be used to complete of existing activity from patient's Care plan.
It can be processed in both sync and async methods depends on Server decision.
Key points
Status can be changed by employee who has an Approval granted by the patient on write Care plan resource.
Activity completes without using DS.
Activities status has changed in async way. The result of the job should be a link on the Care plan activity details.
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
patient_id |
| String | MPI identifier of the patient |
|
care_plan_id |
| String | Care Plan identifier |
|
id |
| String | activity identifier |
|
Filters
No
Dictionaries
eHealth/care_plan_activity_complete_reasons
eHealth/care_plan_activity_outcomes
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 ('client_id refers to legal entity with type that is not allowed to create medical events transactions')
Validate User
Extract user_id from token.
Check user has an active and approved employee that:
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 no Approval on write
Validate data consistency
Ensure that submitted activity relates to the Patient and Care Plan (from URL)
Return 404 (not found) in case of error
Validate status transition
Get activity by id
Check activity.detail.status: activity status should be changed according to activity status model.
Return 409 (Invalid activity status) in case of error
Validate status reason
Validate value in the field $.detail.status_reason, required
Validate field type is codeable concept
Check that codeable concept refers to the
eHealth/care_plan_activity_complete_reasons
dictionaryValidate value within dictionary specified above
in case of error - return 422 ('value is not allowed in enum')
Validate related entities
if activity kind = medication_request:
Check there is no medication request requests in status
NEW
based on the activityin case of error - return 409 (Unable to complete activity with new Medication Request requests).
Check there is no medication requests in status
ACTIVE
based on the activityin case of error - return 409 (Unable to complete activity with active Medication requests).
if activity kind = service_request:
Check availability of service requests with status = active. If such service requests exist, then needs to check availability of service requests with program_processing_status:
if program_processing_status is undefined (NULL), then return error 409 (Unable to complete activity with Service requests in status <status value> and program processing status is NULL or not completed)
if program_processing_status is defined, then needs to check that program_processing_status = complete. Otherwise, return error 409 (Unable to complete activity with Service requests in status <status value> and program processing status is NULL or not completed)
Check all related service requests in final status: completed, recalled or entered_in_error.
in case at least one is active - return error 409 (Unable to complete activity with Service requests in active status)
if activity kind = device_request:
Check there is no device requests in status
ACTIVE
based on the activityin case of error - return 409 (Unable to complete activity with active Device requests).
Validate outcome
Validate value in the field $.outcome_codeable_concept, required
Validate field type is array of codeable concepts
Validate each value in array:
it refers to the
eHealth/care_plan_activity_outcomes
dictionaryvalue within dictionary
in case of error - return 422 ('value is not allowed in enum')
Processing
Service logic
Update activity status to completed (update also updated_at, updated_by)
Set outcome_codeable_concept
Response structure
See on Apiary
Example:
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
201 | use payload from response | sync |
202 | use Get job details to get processing result. Response payload will be returned in the job details | async: default method |
401 | Invalid access token |
|
403 |
|
|
404 | not found | The submitted activity is not related to the Patient Care Plan |
409 |
| Validation error |
422 |
| Validation error |
ЕСОЗ - публічна документація