REST API method / Метод REST API (настанова) (/wiki/spaces/EN/pages/17591304241 (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-0219 |
Microservices (namespace) | ME |
Component | Care plan |
Component ID | COM-007-001 |
Link на API-специфікацію | https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/care-plan/get-care-plan-by-id/get-care-plan-by-id |
Resource | {{host}}/api/patients/{{patient_id}}/care_plans/{{id}} |
Scope | care_plan:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
...
Get activity by ID from care_plan_activities collection (MongoDB)
Validate data consistency:
Ensure that requested Care plan relates to requested Patient (from URL)
Return 404 ('not found') in case of error
Render a response according to specification
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
eHealth/care_plan_categories
...
Extract user_id from token.
Check user has an active and approved employee from legal entity (token) for which one of the conditions is TRUE:
has an active Approval granted by the Patient on write or read the Care plan resource (care plan id from URL)
Return 403 ('Access denied') in case employee has no Approval on read or write
has an active declaration with the patient
Return 403 ('Access denied') in case there no active declaration with patient and none of other conditions is true
user belongs to the legal entity where the care_plans were created
Return 403 ('Access denied') in case employee belongs to another legal_entity and none of conditions above is true
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 | ||