| Info |
|---|
REST API method / Метод REST API (настанова) (| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
Properties of a REST API method document
| Page Properties |
|---|
| id | page_properties_method_REST API |
|---|
|
Document type | Метод REST API |
|---|
Document title | [Document status] REST API [Назва методу] [ID методуDRAFT] Get conditions in episode context [API-007-004-003-0250] |
|---|
Guideline ID | GUI-0011 |
|---|
Author | @ |
|---|
Document version | 1 |
|---|
Document status | DRAFT |
|---|
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
|---|
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
|---|
Method API ID | API-007-004-003-0250 |
|---|
Microservices (namespace) | ME |
|---|
Component | EDP |
|---|
Component ID | COM-007-004 |
|---|
Link на API-специфікацію | https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/episode-of-care/get-conditions-in-episode-context |
|---|
Resource | {{host}}/api/patients/{{patient_id}}/episodes/{{episode_id}}/conditions |
|---|
Scope | episode:read |
|---|
Protocol type | REST |
|---|
Request type | GET |
|---|
Sync/Async | Sync |
|---|
Public/Private | Public |
|---|
|
Purpose
This web service is designed to return conditions by episode_id.
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)N/A
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
Provides a list of links to dictionaries that are available in ConfluenceN/A
Dictionaries
N/A
Input parameters
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | | | | | |
| 2 | | | | | |
Request structure
See on ApiarySee on API-specification
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer {{access_token}}
...
Authorization:Bearer {{access_token}}
...
API-key
...
{{secret}}
...
Headers
Request data validation
Authorize
Request to process the request using a token in the headers
...
Check user scopes in order to perform this action (scope = 'episode:read')
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 |
|---|
| {
"meta": {
"code": 200,
"url": "http://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
},
"data": [
{
"id": "6fe6d880-f100-4e39-a278-1d14eb8472ef",
"primary_source": true,
"asserter": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
],
"text": ""
},
"value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
}
},
"context": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "encounter"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"code": {
"coding": [
{
"system": "eHealth/ICD10/condition_codes",
"code": "K87"
}
]
},
"clinical_status": "active",
"verification_status": "provisional",
"severity": {
"coding": [
{
"system": "eHealth/condition_severities",
"code": "55604002"
}
]
},
"body_sites": [
{
"coding": [
{
"system": "eHealth/body_sites",
"code": "head"
}
]
}
],
"onset_date": "2018-10-08T09:46:37.694Z",
"asserted_date": "2018-10-08T09:46:37.694Z",
"inserted_at": "2018-08-02T10:45:16.000Z",
"updated_at": "2018-08-02T10:45:16.000Z",
"stage": {
"summary": {
"coding": [
{
"system": "eHealth/condition_stages",
"code": "14803004"
}
]
}
},
"evidences": [
{
"codes": [
{
"coding": [
{
"system": "eHealth/ICPC2/reasons",
"code": "169068008"
}
]
}
],
"details": [
{
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "observation"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
}
]
}
]
}
],
"paging": {
"page": 2,
"page_size": 50,
"total_entries": 1000,
"total_pages": 20
}
} |
|
HTTP status codes
| Response code | HTTP Status code | Message | Internal name | Description |
|---|
| 1 | Базові |
| 2 | | 200 | | | |
| 3 | | 401 | | Access token validation failed | |
| 4 | | 403 | | Invalid scope | |
| 5 | Специфічні |
| 6 | | | | | |
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
| Page Properties Report |
|---|
| headings | ID ТМ, Статус |
|---|
| cql | label = "tr-mis" |
|---|
|
...