...
| Page Properties |
|---|
| id | page_properties_method_REST API |
|---|
|
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-008-007-0289 |
|---|
Microservices (namespace) | ME |
|---|
Component | Patient Summary |
|---|
Component ID | COM-007-008 |
|---|
Link на API-специфікацію | https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-short-encounters-by-search-params |
|---|
Resource | {{host}}/api/patients/{{patient_id}}/summary/encounters |
|---|
Scope | patient_summary:read |
|---|
Protocol type | REST |
|---|
Request type | GET |
|---|
Sync/Async | Async |
|---|
Public/Private | Public |
|---|
|
...
eHealth/encounter_statuses (parameter “status“ in request / response)
eHealth/encounter_types (parameter “type“ in request / response)
eHealth/encounter_classes (parameter “class“ in request / response)
SPECIALITY_TYPE (parameter “performer_speciality“ in request / response)
Input parameters
...
parameters
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | patient_id | M | String | Patient identifier | 70a9e15b-b71b-4caf-8f2e-ff247e8a5677
|
| 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 | 50
|
| 4 | period_start_from | | String | | 2017-01-01
|
| 5 | period_start_to | | String | | 2017-01-01
|
| 6 | period_end_from | | String | | 2017-01-01
|
| 7 | period_end_to | | String | | 2017-01-01
|
| 8 | episode_id | | String | | f48d1b6c-a021-4d6a-a5a4-aee93e152ecc
|
| 9 | status | | String | | finished
|
| 10 | type | | String | | discharge
|
| 11 | class | | String | | INPATIENT
|
| 12 | performer_speciality | | String | | VIROLOGY
|
Request structure
See on API-specification
| Key | Value | Mandatory | Description | Example |
|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer {{access_token}} | M | Перевірка користувача | Authorization:Bearer {{access_token}} |
| 3 | api-key | {{secret}} | | Секретний ключ | api-key:{{secret}} |
| 4 | X-Custom-PSK | {{secret}} | | Секретний ключ МІС | X-Custom-PSK:{{secret}} |
...
Response structure examples
See on API-specification
| Expand |
|---|
|
| Code Block |
|---|
{
"meta": {
"code": 200,
"url": "http://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
},
"data": [
{
"id": "465fb6fe-2dea-4b8a-9ef7-58379d1eaab0",
"status": "finised",
"date": "2018-08-02T10:45:16.000Z",
"episode": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "episode"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
},
"class": {
"system": "eHealth/encounter_classes",
"code": "inpatient"
},
"type": {
"coding": [
{
"system": "eHealth/encounter_types",
"code": "discharge"
}
]
},
"performer_speciality": {
"coding": [
{
"system": "SPECIALITY_TYPE",
"code": "VIROLOGY"
}
]
}
}
],
"paging": {
"page": 2,
"page_size": 50,
"total_entries": 1000,
"total_pages": 20
}
} |
|
...
Technical modules where the method is used
List of pages describing technical modules where the method is used
| Page Properties Report |
|---|
| headings | ID ТМ, Статус |
|---|
| cql | label = "tr-mis" |
|---|
|
...