/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
...
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [Document status] REST API [Назва методу] [ID методу] |
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-004-0285 |
Microservices (namespace) | ME |
Component | Patient Summary |
Component ID | COM-007-008 |
Link на API-специфікацію | https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-conditionsdevices-by-search-params |
Resource | {{host}}/api/patients/{{patient_id}}/summary/conditionsdevices |
Scope | patient_summary:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private | Public |
...
N/A (Not applicable)
Dictionaries
eHealth/resources external_system - employee (parameter “asserteridentifier“ in response)
eHealth/report_origins (parameter “patient“ in response)
eHealth/resources - encounter (parameter “context“ in response)
eHealth/ICD10/condition_codes(parameter “code“ in response)
eHealth/condition_clinical_statuses (parameter “clinical_status“ in response)
eHealth/condition_verification_statuses (parameter “verification_status“ in response)
eHealth/condition_severities (parameter “severity“ in response)
eHealth/body_sites(parameter “body_sites“ in response)
eHealth/condition_stages(parameter “body_sites“ in response)
eHealth/ICPC2/reasons(parameter “evidences:codes“ in response)
eHealth/resources - observations (parameter “evidences:details“ in response)
...
Input parameter | Mandatory | Type | Description | Example | ||
|---|---|---|---|---|---|---|
| 1 | patient_id | M | String | Unique MPI patient identifier |
| |
| 2 | codetype |
| String | Condition code |
|
|
| 3 | onsetasserted_date_time_from |
| String |
|
| |
| 4 | onsetasserted_date_time_to |
| String |
|
| |
| 5 | page |
| Number | Page number |
| |
| 6 | page_size |
| Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
|
...
Access to the resource is also managed by ABAC module
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
...