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-0220 |
Microservices (namespace) | ME |
Component | Care plan |
Component ID | COM-007-001 |
Link на API-специфікацію | https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/care-plan/get-care-plans-by-search-params/get-care-plans-by-search-params |
Resource | {{host}}/api/patients/{{patient_id}}/care_plans |
Scope | care_plan:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
...
Get all care plans by patient_id from care_plans collection (MongoDB)
Filter list above by submitted search parameters
Render a response according to specification with found Care plan entities. Care plans should be rendered without their activities.
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
PROVIDING_CONDITION
...
Request to process the request using a token in the headers
Access to the resource is also managed by ABAC rules (EN)
Validate Patient
Get Patient identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
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 | ||