Purpose
The endpoint returns single short Encounter info
Specification
| Page Properties |
|---|
|
Link | https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/patient-summary/get-short-encounter-by-id | Посилання на Apiary або Swagger | Resource | /api/patients/{{patient_id}}/summary/encounters/{{encounter_id}} | Посилання на ресурс, наприклад: /api/persons/create | Scope | patient_summary:read
| Scope для доступу | Components | | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC | Protocol type | | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | GET | Тип запиту API, наприклад: GET, POST, PATCH… | Sync/Async | | Метод є синхронним чи асинхронним? | Public/Private/Internal | | Потрібно зазначити тип методу за ступенем доступності |
|
Logic
API paragraph not found
Input parameters
Input parameter | Values | Type | Description | Example |
|---|
patient_id | | String | Unique patient identifier | e549c257-232e-4dab-9f1e-b2322cac3968
|
encounter_id | | String | Unique encounter identifier | 340b86fd-23f3-4a33-94c5-8ec19d116c33
|
Request structure
API paragraph not found
Authorize
API paragraph not found
API paragraph not found
Request data validation
Validate token
Verify the validity of access token
Verify token is not expired
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
Processing
Get all patient's encounters
Filter using Forbidden Groups
Apply filters provided by user
Response structure
API paragraph not foundRequest to process the request using a token in the headers
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
X-Custom-PSK:a2aa05c76f3f2d91870f923a53cc8aa8f23bbc01a8238d1c2c26d4299715a7e4
Request data validation
API paragraph not found
Processing
API paragraph not found
Response structure
See on Apiary
Example:
| Expand |
|---|
|
| Code Block |
|---|
{
"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"
}
]
}
},
"meta": {
"code": 200,
"url": "http://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
}
} |
|
Post-processing processes
API paragraph not found
HTTP status codes
...
| Page Properties |
|---|
|
HTTP status code | Message | What caused the error |
|---|
200 | | |
|