| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
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)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
...
Logic
Configuration parameters
N/A (Not applicable)
Dictionaries
eHealth/clinical_impression_statuses(parameter “status“ in response)
eHealth/clinical_impression_patient_categories(parameter “code“ in response)
eHealth/resources - encounter (parameter “encounter “ in response)
eHealth/resources - employee (parameter “asserter“ in response)
eHealth/resources - clinical_impression (parameter “previous“ in response)
eHealth/resources - condition(parameter “problems“ in response)
eHealth/resources - condition | observation (parameter “findings“ in response)
eHealth/resources - condition | observation | diagnostic_report | encounter (parameter “supporting_info“ in response)
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id | M | String | Unique MPI patient identifier |
|
| 2 |
Request structure
See on API-specification
...
| title | Example |
|---|
...
Headers
Key
Value
Mandatory
Description
Example
Content-Type
application/json
M
Тип контенту
Content-Type:application/json
Authorization
Bearer mF_9.B5f-4.1JqM
encounter_id | String | Identifier of the encounter in Clinical impression |
| ||
| 3 | episode_id |
| String | Identifier of the episode in Clinical impression |
|
| 4 | code | String | Clinical impression's code |
| |
| 5 | status |
| String | Clinical impression's status |
|
| 6 | page |
| Number | Page number |
|
| 7 | page_size |
| Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
|
Request structure
See on API-specification
Headers
See on Headers
Request data validation
Authorize
Request to process the request using a token in the headers
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
...
See on API-specification
...
| title | Example |
|---|
...
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | |||||||||||
| 2 |
| 200 |
| Response |
| |||||||
| 3 | Специфічні | 4 |
| 401 |
| Access token validation failed |
| |||||
| 4 |
| 401 |
| Access token expired |
| |||||||
| 5 |
| 403 |
| Invalid scope |
| |||||||
| 6 | 404 |
| Patient not found | |||||||||
| 7 | Специфічні | |||||||||||
Post-processing processes
Description of actions performed on data after processingN/A (Not applicable)
Technical modules where the method is used
List of pages describing technical modules where the method is used
...
N/A (Not applicable)