| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
...
| Page Properties | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||
|
...
Logic
...
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
Input parameters
Description of input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | subject |
| string($uuid) | subject's MPI ID (patientID - incompatible with focus) | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 2 | focus |
| string($uuid) | subject's MPI ID (patientID - incompatible with subject) | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
...
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer {token} | Authorization: Bearer {token} | ||
| 3 | api-key | {secret} | api-key: {secret} |
Request data validation
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
...
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 | Search results | |||
| 3 | 401 | Unauthorized | Помилка підтвердження | ||
| 4 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок |
| 5 | Специфічні | ||||
| 6 | 422 | Only for active MPI record can be created medication request! | |||
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
| Page Properties Report | ||||
|---|---|---|---|---|
|
...