/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
Properties of a REST API method document
Purpose
Logic
Configuration parameters
N/A (Not applicable)
Dictionaries
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | patient_id | M | String | Unique MPI patient identifier |
|
2 | 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
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
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
---|---|---|---|---|---|
1 | Базові | ||||
2 | 200 | ||||
3 | Специфічні | ||||
4 |
Post-processing processes
N/A (Not applicable)
Technical modules where the method is used
N/A (Not applicable)