| 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
This web service is designed to return allergy intolerances info by patient_id, episode_id or encouner_idlist for a specified patient.
Logic
N/A (Not applicable)
Configuration parameters
N/A (Not applicable)
Dictionaries
eHealth/resources - patient (parameter “patient_id“ in request)
eHealth/allergy_intolerance_codes(parameter “code“ in request / response)
eHealth/allergy_intolerance_clinical_statuses (parameter “clinical_status“ in response)
eHealth/allergy_intolerance_verification_statuses (parameter “verification_status“ in response)
eHealth/allergy_intolerance_types (parameter “type“ “type“ in response)
eHealth/allergy_intolerance_categories (parameter “category“ “category“ in response)
eHealth/allergy_intolerance_criticalities (parameter “criticality“ “criticality“ in response)
eHealth/resources - encounter (parameter “context“ in response)eHealth/allergy_intolerance_codes(parameter “ code“ in request / response)
eHealth/resources - employee (parameter “asserter“ in response)
eHealth/report_origins (parameter “report_origin“ in response)
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id | M | String | Unique MPI patient identifier |
|
| 2 | code |
| String | Allergy intolerances's code |
|
| 3 | onset_date_time_from |
| String |
|
|
| 4 | onset_date_time_to |
| String |
|
|
| 5 | page |
| Number | Page number |
|
| 6 | 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
...
Authorize
Request to process the request using a token in the headers
Request data validation
Validate token
Verify the validity of access token
Return 401 in case validation fails
Verify token is not expired
in case error return 401
Validate scopes
Check user scopes in order to perform this action (scope = 'allergy
patient_intolerancesummary:read')Return 403 in case invalid scope(s)
Access to the resource is also managed by ABAC module.
Validate patient
Validate patient exists in MongoDB
In case of error return 404 not found
Processing
...
Get all patient's allergy intolerances
Apply filters provided by user
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
Your scope does not allow to access this resource. Missing allowances: patient_summary:read | Forbiden | ||||
| 6 | 404 | Not found |
| ||
| 7 | Специфічні | ||||
Post-processing processes
N/A (Not applicable)
Technical modules where the method is used
N/A (Not applicable)