...
| Page Properties |
|---|
|
Link | https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/search-streets/get-settlement-details-by-id | Посилання на Apiary або Swagger | Resource | /api/uaddresses/settlements/{{id}} | Посилання на ресурс, наприклад: /api/persons/create | Scope | address:read | Scope для доступу | Components | Uaddresses | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | API paragraph not found | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC | Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | GET | Тип запиту API, наприклад: GET, POST, PATCH… | Sync/Async | Sync | Метод є синхронним чи асинхронним? | Public/Private/Internal | Public | Потрібно зазначити тип методу за ступенем доступності |
|
Logic
Preconditions
Які передумови мають бути виконані системою/користувачем. Наприклад:
створений запис в MedicationRequest;
рецепт відпущений (COMPLETED)
Global and configurable parameters
Потрібно вказати глобальні та конфігураційні параметри.
Наприклад:
...
Variable
...
Values
...
Description
...
CARE_PLAN_<category>_ICD10_AM_CONDITIONS_ALLOWED
...
Values that matches with dictionaryeHealth/ICD10_AM/condition_codes
Example: “E10.32, E11.92”
...
(Example: CARE_PLAN_CLASS_1_ICD10_AM_CONDITIONS_ALLOWED)
Input parameters
Потрібно вказати вхідні параметри запиту. Наприклад, для GET /patients/composition/job/{{asyncJobId}} вхідний параметр: API paragraph not found
Input parameters
Input parameter | Values | Type | Description | Example |
|---|
asyncJobIdid | | String | Async Job Object ID |
Filters
Потрібно вказати фільтри. Наприклад, для GET /api/medication_requests/{{id}}/dispenses?status=PROCESSED фільтр:
...
Filter
...
Values
...
Type
...
Description
...
Example
...
status
...
String
...
Optional
...
PROCESSED
Dictionaries
Потрібно вказати довідники, які використовує метод API
Request structure*
...
Required | d290f1ee-6c54-4b01-90e6-d701748f0851 |
Request structure
API paragraph not found
Authorize
Request to process the request using a token in the headers
API paragraph not found
Request data validation
API paragraph not found
Processing
API paragraph not found
Response structure
Example:
| Expand |
|---|
| title | Request Response example |
|---|
|
| Code Block |
|---|
{
"categorymeta": {
"coding": [
{
"system": "eHealth/composition_categories",
"code": "LIVE_BIRTH"
}
]
}200,
"type": { "codingurl": [
{
"system": "eHealth/composition_types",
"code": "NEWBORN"
}
]
},
"event": [
{
"code": {
"coding": [
{
"system": "eHealth/composition_events",
"code": "COMPOSITION_VALIDITY_PERIOD"
}
]
},
"period": {
"start": "2020-06-26T15:22:53.403Z",
"end": "2020-07-26T15:22:53.403Z"
}
}
],
"subject": {"https://example.com/resource",
"type": {
"coding": [
{
"system": "eHealth/composition",
"object",
"coderequest_id": "string"
}
],
"text": "string"
},
"value": "e49abc30-6d17-11ea-b83c-673680173afa6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
},
"encounterdata": {
"typeid": {
"coding": [
{
"system": "eHealth/composition",
"code": "string"
}
],
"text": "string"
},
"value": "e49abc30-6d17-11ea-b83c-673680173afa"
},
"author": {
"type": {
"coding": [
{
"system": "eHealth/composition",
"code": "string"
}
],
"text": "string"
},
"value": "e49abc30-6d17-11ea-b83c-673680173afa"
},
"section": {
"focus": {
"type": {
"coding": [
{
"system": "eHealth/composition",
"b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
"region_id": "99310bc4-ac7c-4f1f-bc29-b3ae25bd96bc",
"region": "Київ",
"codedistrict": "string"
}
],
"text": "string"
},
"value": "e49abc30-6d17-11ea-b83c-673680173afa"
}
},
"extension": [
{
Києво-Святошинський",
"valueCode": "AUTHORIZE_WITH",
"valueUuid"district_id": "3fa85f6499310bc4-5717ac7c-45624f1f-b3fcbc29-2c963f66afa6"
}b3ae25bd96bc",
{
"valueCode": "IS_ACCIDENT",
"valueBoolean": true
},
{
"valueCode": "TREATMENT_VIOLATION",
"settlement_name": "Новосілки",
"valueString": "late_arrival"
},
{
"valueCode": "TREATMENT_VIOLATION_DATE",
mountain_group": "0",
"valueDatetype": "2020-12-12"
},
{СITY",
"valueCodekoatuu": "IS_INTOXICATED3520380802",
"valueBoolean": true
},
{
"valueCode": "IS_FOREIGN_TREATMENT",
"valueBoolean": true
},
{
"valueCode": "IS_FORCE_RENEW",
"valueBoolean": true
}
]
} |
|
Authorize*
Вимоги до авторизації: яким чином надається доступ до використання методу
Request to process the request using a token in the headers
Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
api-key:uXhEczJ56adsfh3Ri9SUkc4en
Request data validation*
Валідація даних
Наприклад:
Validate request using JSON schema
In case validation failed - generate 422 error
| Expand |
|---|
|
| Code Block |
|---|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"verification_code": {
"type": "string"
}
},
"required": [
"verification_code"
],
"additionalProperties": false
}
|
|
Processing*
Потрібно описати процеси, які відбуваються з даними
1. Using global parameters
Потрібно викликати глобальні параметри (Global parameters), щоб отримати наведені нижче параметри
Response structure*
See on Apiary
Example:
| Expand |
|---|
|
| Code Block |
|---|
{
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "PENDING",
"eta": "string",
"doneAt": "string""parent_settlement": "Берегово",
"parent_settlement_id": "99310bc4-ac7c-4f1f-bc29-b3ae25bd96bc"
},
"paging": {
"page_number": 2,
"linkspage_size": [
{
"entity": "eHealth/composition"50,
"href"total_entries": "composition/0daaad78-6cfb-11ea-9cd6-afab698838bc"1000,
"error"total_pages": "string"
23
}
]
}
} |
|
Post-processing processes
...
API paragraph not found
HTTP status codes
...
| Page Properties |
|---|
|
HTTP status code | Message | What caused the error |
|---|
| | | | | |
|
Backward compatibility
...