| Info |
|---|
| Note |
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
Return a list of short Encounter info filtered by search params
Logic
The endpoint returns a list of short Encounter info filtered by search params
Configuration parameters
N/A (Not applicable)
Dictionaries
eHealth/encounter_statuses (parameter “status“ in request / response)
eHealth/resources - episode (parameter “episode “ in response)
eHealth/encounter_typesclasses (parameter “type“ “class“ in request / response):
eHealth/encounter_classestypes (parameter “class“ “type“ in request / response):
SPECIALITY_TYPE (parameter “performer_speciality“ in request / response):
Input
...
parameters
Input parameter | Mandatory | Type | Description | Example | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | patient_id | M | String | Patient Unique patient identifier |
| 2 | page |
| Number | Page number | ||
| 2 | 3 | page_size |
| Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
| 4 | period_start_from |
| String |
|
|
| 53 | period_start_to |
| String |
|
| |||||||
| 64 | period_end_from |
| String |
|
| |||||||
| 75 | period_end_to |
| String |
|
| |||||||
| 86 | episode_id | String | Episode identifier |
| ||||||||
| 97 | status | String | Encounter status |
| ||||||||
| 108 | type | String | Encounter type |
| ||||||||
| 119 | class | String | Encounter class |
| ||||||||
| 1210 | performer_speciality | String |
|
Request structure
...
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer mF_9.B5f-4.1JqM
...
Authorization:Bearer mF_9.B5f-4.1JqM
...
api-key
...
aFBLVTZ6Z2dON1V
...
api-key:aFBLVTZ6Z2dON1V
...
| 11 | page |
| Number | Page number |
|
| 12 | page_size |
| Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
|
Request structure
See on API-specification
Headers
See on Headers
Request data validation
Authorize
Request to process the request using a token in the headers
Validate token
Verify the validity of access token
Return 401 in case validation fails
Verify token is not expired
in case error return 401
Validate scopes
Check user scopes in order to perform this action (scope = 'patient_summary:read')
Return 403 in case invalid scope(s)
Validate patient
Validate patient exists in MongoDB
In case of error return 404 not found
Processing
Get all patient's encounters
Filter using Forbidden Groups
Apply filters provided by user
Response structure examples
...
See on API-specification (посилання на сторінку з API-специфікацією)
...
| title | Example |
|---|
...
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 | Response | |||
| 3 | 401 | Unauthorized | Помилка підтвердження | ||
| 4 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок |
| 5 | Специфічні | ||||
| 6 | 422 | Only for active MPI record can be created medication request!Access token validation failed | |||
| 4 | 401 | Access token expired | |||
| 5 | 403 |
| Invalid scope | ||
| 6 | 404 | Patient not found | |||
| 7 | Специфічні | ||||
Post-processing processes
Description of actions performed on data after processingN/A (Not applicable)
Technical modules where the method is used
List of pages describing technical modules where the method is used
...
N/A (Not applicable)