REST API method / Метод REST API (настанова) (remove the link block before publishing the document)
...
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [Document status] REST API [Назва методу] [ID методу] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-007-001-001-0223 |
Microservices (namespace) | ME |
Component | Care plan |
Component ID | COM-007-001 |
Link на API-специфікацію | https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/care-plan/complete-care-plan/complete-care-plan |
Resource | {{host}}/api/patients/{{patient_id}}/care_plans/{{id}}/actions/complete |
Scope | care_plan:write |
Protocol type | REST |
Request type | PATCH |
Sync/Async | Async(def)/Sync |
Public/Private | Public |
...
Update Care plan status (update also updated_at, updated_by)
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
...
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
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
...
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||