Purpose
...
Необхідно зазначити призначення методу, а також посилання на бізнес процеси, в яких він задіяний
Наприклад: This method allows to receive active person declarations issued by the current legal entity (based on access_token)
...
API paragraph not found
Specification
| Page Properties |
|---|
|
Link | https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/patient-summary/get-medication-statement-by-id | Посилання на Apiary або Swagger | Resource | /api/patients/{{patient_id}}/summary/medication_statements/{{medication_statement_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 | | Потрібно зазначити тип методу за ступенем доступності |
|
...
Які передумови мають бути виконані системою/користувачем. Наприклад:
створений запис в MedicationRequest;
рецепт відпущений (COMPLETED)
Logic
...
Потрібно по пунктах описати логіку методу API або додати діаграму
Global and configurable parameters
Потрібно вказати посилання на сторінки з описом глобальних та конфігураційних параметрів
Input parameters
Потрібно вказати вхідні параметри запиту. Наприклад, для GET /patients/composition/job/{{asyncJobId}} вхідний параметр: API paragraph not found
Input parameters
Input parameter | Values | Type | Description | Example |
|---|
asyncJobIdpatient_id | | 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
...
Unique patient identifier | e549c257-232e-4dab-9f1e-b2322cac3968
|
medication_statement_id | | String | Unique device identifier | 40b86fd-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
X-Custom-PSK:a2aa05c76f3f2d91870f923a53cc8aa8f23bbc01a8238d1c2c26d4299715a7e4
Request data validation
API paragraph not found
Processing
API paragraph not found
Response structure
See on Apiary
Example:
| Expand |
|---|
| title | Request Response example |
|---|
|
| Code Block |
|---|
{
"categorydata": {
"codingid": [
{
"system": "eHealth/composition_categories",
"80a9e15b-b71b-4caf-8f2e-ff247e8a5600",
"code": "LIVE_BIRTH"
}
]
},
"type""based_on": {
"coding": [ {
"system"identifier": "eHealth/composition_types",{
"codetype": "NEWBORN"{
} ]
},
"event"coding": [
{ "code": {
"coding":
[ { "system": "eHealth/composition_eventsresources",
"code": "COMPOSITIONmedication_VALIDITY_PERIODrequest"
} }
] ]
}, "period": {},
"startvalue": "20209183a36b-06-26T15:22:53.403Z",
"end": "2020-07-26T15:22:53.403Z4d45-4244-9339-63d81cd08d9c"
}
},
], "subjectasserted_date": {
"type": {
"coding": [
{
"system": "eHealth/composition",
"2018-08-02T10:45:00.000Z",
"status": "active",
"codecontext": "string"{
}
],
"text"identifier": "string"{
}, "valuetype": "e49abc30-6d17-11ea-b83c-673680173afa"{
}, "encounter": { "typecoding": {[
"coding": [ {
{ "system": "eHealth/compositionresources",
"code":
"string" } ],
"text"code": "stringencounter"
}, "value": "e49abc30-6d17-11ea-b83c-673680173afa" },
"author": { "type": { ]
"coding": [ {
"system": "eHealth/composition"},
"codevalue": "string"
9183a36b-4d45-4244-9339-63d81cd08d9c"
}
]},
"textprimary_source": "string"
}true,
"valueasserter": "e49abc30-6d17-11ea-b83c-673680173afa"{
}, "sectionidentifier": {
"focus": {
"type": {
"coding": [
{
"system": "eHealth/compositionresources",
"code": "stringemployee"
}
],
"text": "string"
},
"value": "e49abc3097d57238-6d17ffbe-11ea4335-b83c92ea-673680173afa28d4de117ea2"
} },
"extension": [
{ },
"valueCodeeffective_period": "AUTHORIZE_WITH",Вживає з 2017-го року "valueUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}регулярно",
{
"valueCode"medication_code": "IS_ACCIDENT",{
"valueBooleancoding": true[
}, {
"valueCode": "TREATMENT_VIOLATION", "valueStringsystem": "late_arrival"
},
eHealth/medical_statement_medications",
{ "valueCodecode": "TREATMENTSpine_VIOLATION_DATEboard",
"valueDate": "2020-12-12" },
{ ]
"valueCode": "IS_INTOXICATED"},
"valueBooleannote": true
},
{
"valueCode": "IS_FOREIGN_TREATMENT""Some text",
"valueBooleandosage": true
},
{
"valueCode": "IS_FORCE_RENEW"5 ml/day",
"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
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",inserted_at": "2018-08-02T10:55:00.000Z",
"updated_at": "2018-08-02T10:55:00.000Z"
},
"meta": {
"doneAtcode": "string"200,
"linksurl": [
{ "entity": "eHealth/composition"http://example.com/resource",
"hreftype": "composition/0daaad78-6cfb-11ea-9cd6-afab698838bcobject",
"error"request_id": "string"
}
req-adasdoijasdojsda"
] }
} |
|
Post-processing processes
...
API paragraph not found
HTTP status codes
...
| Page Properties |
|---|
|
HTTP status code | Message | What caused the error |
|---|
| 200 | | | | |
|
Backward compatibility
...