| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
...
| Page Properties |
|---|
| id | page_properties_method_REST API |
|---|
|
Document type | Метод REST API |
|---|
Document title | [Document status] REST API [Назва методу] [ID методу]DRAFT] Get Medication Statement by search params (Patient Summary) [API-007-008-010-0295] |
|---|
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-010-0295 |
|---|
Microservices (namespace) | ME |
|---|
Component | Patient Summary |
|---|
Component ID | COM-007-008 |
|---|
Link на API-специфікацію | https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-medication-statement-by-search-params |
|---|
Resource | {{host}}/api/patients/{{patient_id}}/summary/medication_statements/ |
|---|
Scope | patient_summary:read |
|---|
Protocol type | REST |
|---|
Request type | GET |
|---|
Sync/Async | Sync |
|---|
Public/Private | Public |
|---|
|
Purpose
Describe the purpose of the API method, add Key points (if necessary)
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
Logic
N/A
Configuration parameters
N/A (Not applicable)
Dictionaries
eHealth/resources - medication_request (parameter “based_on“ in response)
eHealth/medication_satement_statuses (parameter “status“ in response)
eHealth/resources - encounter (parameter “context“ in response)
eHealth/resources - employee (parameter “asserter“ in response)
eHealth/report_origins (parameter “report_origin“ in response)
eHealth/medical_statement_medications (parameter “medication_code“ in request/response)
Input parameters
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | patient_id | M | String | Unique MPI patient identifier | 70a9e15b-b71b-4caf-8f2e-ff247e8a5677
|
| 2 | medication_code | | String | | wex-10
|
| 3 | asserted_date_from | | String | | 2017-01-01
|
| 4 | asserted_date_to | | String | | 2017-01-01
|
| 5 | page | | Number | Page number | 2
|
| 6 | page_size | | Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 | 50
|
Request structure
See on API-specification
See on Headers
Request data validation
Authorize
Request to process the request using a token in the headersPI
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": "80a9e15b-b71b-4caf-8f2e-ff247e8a5600",
"based_on": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "medication_request"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
},
"asserted_date": "2018-08-02T10:45:00.000Z",
"status": "active",
"context": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "encounter"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
},
"primary_source": true,
"asserter": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
],
"text": ""
},
"value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
}
},
"effective_period": "Вживає з 2017-го року регулярно",
"medication_code": {
"coding": [
{
"system": "eHealth/medical_statement_medications",
"code": "Spine_board"
}
]
},
"note": "Some text",
"dosage": "5 ml/day",
"inserted_at": "2018-08-02T10:55:00.000Z",
"updated_at": "2018-08-02T10:55:00.000Z"
}
],
"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 | | 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
...