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-0221 |
Microservices (namespace) | ME |
Component | Care plan |
Component ID | COM-007-001 |
Link на API-специфікацію | https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/care-plan/cancelget-care-plans-planby-requisition/get-care-plans-by-requisition |
Resource | {{host}}/api/patients/care_plans |
Scope | care_plan:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
...
Get all care plan by requisition from care_plans collection (MongoDB)
If submitted, filter list above by status
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
...
Verify the validity of access token
Return (401, 'unauthorized') in case of validation fails
Verify that token is not expired
in case of error - return (401, 'unauthorized')
Check user scopes in order to perform this action (scope = 'care_plan:read')
Return (403, 'invalid scopes') in case of invalid scope(s)
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 | ||