| Table of Contents | ||||
|---|---|---|---|---|
|
Required parameters are marked with "*"
...
| Table of Contents | ||||
|---|---|---|---|---|
|
Purpose
This WS is designed to return care plan's activity details by it's identifier within care plan and patient context
Specification
| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
Returns care plan's activity details by it's identifier within care plan and patient context
Specification*
...
Project Name
...
COVID-certificate
...
Project abreviation
...
SVC
...
Developer
...
Розробник методу API. Наприклад, Edenlab
...
Project Manager
...
@Єлизавета Гессен-Дармштадська
...
Tech Lead
...
@Іоанн Воїнов
...
Product Owner
...
@Нікодім Святогорцев
...
Вusiness analyst
...
@Пантелеймон Нікомедійський
...
Status
| Status | ||||
|---|---|---|---|---|
|
...
Version
...
1.0
...
Date of release
...
...
Link
...
Посилання на Apiary або Swagger
...
Resource
...
/api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities/{{id}}
...
Scope
...
care_plan:read
...
Components
...
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
...
Microservices
...
Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC
...
Protocol type
...
Тип протоколу, який використовується запитом, наприклад: SOAP | REST
...
Request type
...
GET
...
Sync/Async
...
Метод є синхронним чи асинхронним?
Logic*
Returns care plan's activity details by it's identifier within care plan and patient context
Input parameters
...
Input parameter
...
Values
...
Type
...
Description
...
Example
...
patient_id
...
String
...
MPI identifier of the patient
...
7c3da506-804d-4550-8993-bf17f9ee0402
...
care_plan_id
...
String
...
Care Plan identifier
...
9183a36b-4d45-4244-9339-63d81cd08d9c
...
id
...
String
...
75a5d991-0bf7-476f-b3cf-bec73f044b2e
Request structure*
API paragraph not found
Authorize*
Request to process the request using a token in the headers
Headers*
Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
api-key:uXhEczJ56adsfh3Ri9SUkc4en
Validate request*
API paragraph not found
Request data validation*
API paragraph not found
Processing*
API paragraph not found
...
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
patient_id | String | MPI identifier of the patient |
| |
care_plan_id | String | Care Plan identifier |
| |
id | String | System identifier of the activity |
|
Dictionaries
eHealth/care_plan_activity_outcomes
eHealth/ICD10_AM/condition_codes
eHealth/care_plan_activity_goals
eHealth/care_plan_activity_cancel_reasons
eHealth/care_plan_activity_complete_reasons
eHealth/ucum/units
Request structure
Authorize
Verify the validity of access token
Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
in case of error - return (401, 'Invalid access token')
Check user scopes in order to perform this action (scope = 'care_plan:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: care_plan:read') in case of invalid scope(s)
Request to process the request using a token in the headers
Headers
Наприклад:
Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{mis_client_secret}}
Request data validation
Validate Patient
Get Patient identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Validate Care plan
Get Care plan identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Validate User
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
Response structure
See on Apiary
Example:
| Expand | ||
|---|---|---|
| ||
|
Post-processing processes*
...
|
HTTP status codes
...
| Page Properties | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|