...
...
Purpose
...
Return single short Encounter info
Specification
...
| Page Properties |
|---|
Project Name | COVID-certificate |
|---|
Project abreviation | SVC |
|---|
Developer | Розробник методу API. Наприклад, Edenlab |
|---|
Project Manager | @Єлизавета Гессен-Дармштадська |
|---|
Tech Lead | @Іоанн Воїнов |
|---|
Product Owner | @Нікодім Святогорцев |
|---|
Вusiness analyst | @Пантелеймон Нікомедійський |
|---|
Status | | Status |
|---|
colour |
|---|
| Green | | title | APPROVED |
|---|
Version | 1.0 |
|---|
Date of release | |
|---|
Link | https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-short-encounter-by-id | Resource | /api/patients/{{patient_id}}/summary/encounters/{{encounter_id}} | Scope | patient_summary:read | Components | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionPatient Summary | Microservices | Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found | Protocol type | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | GET | Sync/Async | Async | Метод є синхронним чи асинхронним? | Public/Private/Internal | Public |
|
Logic
...
The endpoint returns single short Encounter info
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
...
Request to process the request using a token in the headers
...
Наприклад:
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
Validate request*
...
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 | | |
|
...