/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
eHealth/resources - employee (parameter “asserter“ 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 parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id |
| String | Unique MPI patient identifier |
|
| 2 | id |
| String | Unique condition identifier |
|
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
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 |
| 200 |
|
|
|
| 3 |
| 401 |
| Access token validation failed |
|
| 4 |
| 401 |
| Access token expired |
|
| 5 |
| 403 |
| Invalid scope |
|
| 6 | Специфічні | ||||
Post-processing processes
N/A (Not applicable)
Technical modules where the method is used
N/A (Not applicable)