| 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
This method allows to get detailed information of the patient’s Clinical impression.
Logic
Configuration parameters
Dictionaries
eHealth/resources - clinical_impression (parameter “clinical_impression_id“ in request)
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 | clinical_impression_id | M | String | Unique Clinical impression identifier |
|
Request structure
See on API-specification
Headers
See on Headers
Request data validation
Authorize
Verify the validity of access token
Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
in case of error - return (401, 'Invalid access token')
Check user scopes in order to perform this action (scope = 'clinical_impression:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: clinical_impression:read') in case of invalid scope(s)
...
Request to process the request using a token in the headers
Validate Patient
Get Patient identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Validate Clinical impression
Get Clinical impression identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Check Clinical impression belongs to patient
Return 404 ('not found') in case of error
Processing
Service returns specified Clinical impression related to the patient:
Get Clinical impression by ID from clinical_impression collection (MongoDB)
Validate data consistency:
Ensure that requested Clinical impression relates to requested Patient (from URL)
Return 404 ('not found') in case of error
Render a response according to specification
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 |
| 200 |
| Response |
|
| 3 |
| 401 |
| Access token validation failed |
|
| 4 |
| 401 |
| Access token expired |
|
| 5 |
| 403 |
| Invalid scope |
|
| 6 |
| 404 |
| Patient not found | |
| 7 | Специфічні | ||||
Post-processing processes
N/A (Not applicable)
Technical modules where the method is used
N/A (Not applicable)