| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
...
| Page Properties |
|---|
| id | page_properties_method_REST API |
|---|
|
Document type | Метод REST API |
|---|
Document title | [Document status] REST API [Назва методу] [ID методу]DRAFT] Get Short Encounter by id [API-007-008-007-0290] |
|---|
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-0290 |
|---|
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-encounter-by-id |
|---|
Resource | {{host}}/api/patients/{{patient_id}}/summary/encounters/{{encounter_id}} |
|---|
Scope | patient_summary:read |
|---|
Protocol type | REST |
|---|
Request type | GET |
|---|
Sync/Async | AsyncSync |
|---|
Public/Private | Public |
|---|
|
Purpose
...
eHealth/resources - encounter(parameter “encounter_id“ in request)
eHealth/encounter_statuses (parameter “status“ in response)
eHealth/resources - episode (parameter “episode “ in response)
eHealth/encounter_classes (parameter “class“ in response)
eHealth/encounter_types (parameter “type“ in response)
SPECIALITY_TYPE (parameter “performer_speciality“ in response)
Input parameters
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | patient_id | M | String | Unique patient identifier | e549c257-232e-4dab-9f1e-b2322cac3968
|
| 2 | encounter_id | M | String | Unique encounter identifier | 340b86fd-23f3-4a33-94c5-8ec19d116c33
|
Request structure
See on API-specification
See on Headers
Request data validation
Authorize
Request to process the request using a token in the headers
...
Validate patient exists in MongoDB
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST APIN/A
Response structure examples
See on API-specification
| 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"
}
} |
|
HTTP status codes
| Response code | HTTP Status code | Message | Internal name | Description |
|---|
| 1 | Базові |
| 2 | | 200 | | Response | |
| 3 | | 401 | | Access token validation failed | |
| 4 | | 401 | | Access token expired | |
| 5 | | 403 | | Invalid scope | |
| 6 | | 404 | | Patient not found | |
| 7 | Специфічні |
Post-processing processes
N/A (Not applicable)
Technical modules where the method is used
...