Table of Contents
minLevel1
maxLevel3

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

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

...

Specification*

Page Properties

Link

https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/care-plan/complete-care-plan/complete-care-plan

Resource

/api/patients/{{patient_id}}/care_plans/{{id}}/actions/complete

Scope

care_plan:write

Components

Care plan

Microservices

API paragraph not found

Protocol type

REST

Request type

PATCH

Sync/Async

Async

Public/Private/Internal

Public

...

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

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.

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

...

Request to process the request using a token in the headers

Headers*

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

  • api-key:aFBLVTZ6Z2dON1V

...

  • 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

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

  2. Set $.status_history

Response structure*

See on Apiary

...