| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
...
| id | page_properties_method_REST API |
|---|
...
Document type
...
Метод REST API
...
Guideline ID
...
GUI-0011
...
Author
...
@
...
Document version
...
1
...
Document status
...
DRAFT
...
Date of creation
...
ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
...
Date of update
...
ХХ.ХХ.ХХХХ (дата зміни версії)
...
Method API ID
...
API-001-001-001-0001
...
Microservices (namespace)
...
MPI
...
Component
...
Auth
...
Component ID
...
COM-001-001
...
Link на API-специфікацію
...
...
Resource
...
{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package
...
Scope
...
Protocol type
...
Request type
...
Sync/Async
...
Public/Private
Purpose
Describe the purpose of the API method, add Key points (if necessary)
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
Provides a list of links to dictionaries that are available in Confluence
Input parameters
Description of input parameters
...
Input parameter
...
Mandatory
...
Type
...
Description
...
Example
...
composition_id
...
M
...
String ($uuid) (path)
...
Composition object ID
...
89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
...
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
...
| title | Example |
|---|
...
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
Request data validation
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
Description of the REST API response structure, example
...
| title | Example |
|---|
...
HTTP status codes
...
Response code
...
HTTP Status code
...
Message
...
Internal name
...
Description
...
Базові
...
1000
...
404
...
Composition not found
...
COMPOSITION_NOT_FOUND_404
...
Не знайдено медичний висновок
...
401
...
Unauthorized
...
Помилка підтвердження
...
Специфічні
...
| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
This API allows to cancel Care plan in cases it has been rejected or entered in error.
Процеси роботи з планом лікування (care plan) | Відміна плану лікування
Key points
It can be cancelled by author of the Care plan who has an Approval granted by the patient on write Care plan resource
Cancel should be signed with DS. So, all the Care plan data (without activities data) should be submitted.
Status of the Care plan changed in async way. The result of the job should be a link on the Care plan details.
Logic
This method must be used to cancel of existing patient's Care plan. Method receives signed message (pkcs7) that consists of signed content, digital signature and signer public key. All signature fields will be validated (including signer certificate authority)
Service logic
Save signed content to media storage
Update Care plan status (update also updated_at, updated_by)
Set $.status_reason and $.status_history
Configuration parameters
Care Plan dictionaries and configurable parameters_UA | Конфігураційні параметри
Medical Events Dictionaries and configurations | ME_ALLOWED_TRANSACTIONS_LE_TYPES
Dictionaries
eHealth/care_plan_categories
eHealth/care_plan_cancel_reasons
eHealth/care_plan_complete_reasons
eHealth/ICD10_AM/condition_codes
PROVIDING_CONDITION
Input parameters
Description of input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id |
| String | MPI identifier of the patient |
|
| 2 | id |
| String | Care Plan identifier |
|
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
Dummy Cancel Care plan
| Expand | ||
|---|---|---|
| ||
|
Headers
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer {{access_token}} | Authorization:Bearer {{access_token}} | ||
| 3 | API-key | {{mis_client_secret}} | API-key:{{mis_client_secret}} |
Request data validation
Validate legal entity
Extract client_id from token
Check legal entity status is ACTIVE
In case of error - return 409 ('Legal entity must be ACTIVE')
Check legal entity type in me_allowed_transactions_le_types config parameter
in case of error - return 409 ('Action is not allowed for the legal entity type')
Validate User
Extract user_id from token.
Check user has an active and approved employee that:
is specified as Author of the Care plan and has an active Approval granted by the Patient on write the Care plan resource (care plan id from URL)
Return 403 ('Access denied') in case employee has not specified as author of the care plan, or has no Approval on write
Validate data consistency
Ensure that submitted Care plan relates to the Patient (from URL)
Return 404 (not found) in case of error
Validate Digital Sign
Check DS is valid and not expired
Validate that DS belongs to the user
Check that DRFO from DS and user's party.tax_id matches
in case of error - return 409 (“Signer DRFO doesn't match with requester tax_id“)
Validate status transition
Get Care plan by id
Check status:
Care plan status should be changed according to Care plan status model.
Return 409 ('Care plan in status <cancelled/completed> cannot be cancelled') in case of error
Validate status reason
Validate value in the field $.status_reason, required
Validate field type is codeable concept
Check that codeable concept refers to
eHealth/care_plan_cancel_reasonsdictionaryValidate value within dictionary specified above
in case of error - return 422 ('value is not allowed in enum')
Validate activities
Get Care plan activities
Check Care plan has no activities or all activities has final status.
Return 409 ('Care plan has unfinished activities') in case if found at least one activity not in final status
Validate content
Signed content must match with Care plan in DB in order to be changed
Render Care plan from DB
Exclude $.status_reason from signed content
Compare rendered Care plan and signed content
In case both object doesn't match - return 422 ('Signed content doesn't match with previously created care plan')
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
| Expand | ||
|---|---|---|
| ||
|
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 201 | use payload from response | sync | ||
| 3 | 202 | use Get job details to get processing result. Response payload will be returned in the job details | async: default method | ||
| 4 | 401 | Invalid access token |
| ||
| 5 | 401 | Unauthorized | Помилка підтвердження | ||
| 6 | 403 | Access denied | invalid scope(s) | ||
| 7 | 403 | Your scope does not allow to access this resource. Missing allowances: care_plan:write | employee has no Approval on write | ||
| 8 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок |
| 9 | 404 | not found | The submitted Care Plan is not related to the Patient | ||
| 10 | 409 | Action is not allowed for the legal entity type | Validation error | ||
| 11 | 409 | Care plan in status <cancelled/completed> cannot be cancelled | |||
| 12 | 409 | Care plan has unfinished activities | |||
| 13 | 409 | Legal entity must be ACTIVE | |||
| 14 | 409 | Signer DRFO doesn't match with requester tax_id | |||
| 15 | 422 | Signed content doesn't match with previously created care plan | Validation error | ||
| 16 | 422 | value is not allowed in enum | |||
| 17 | Специфічні | ||||
| 18 | 422 | Only for active MPI record can be created medication request! | |||
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
| Page Properties Report | ||||
|---|---|---|---|---|
|
...