/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
Properties of a REST API method document
Purpose
This web service is designed to return allergy intolerances info by patient_id, episode_id or encouner_id.
Logic
N/A
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | |||||
2 |
Request structure
See on API-specification
Headers
Request data validation
Authorize
Request to process the request using a token in the headers
Verify the validity of access token
Return 401 in case validation fails
Verify token is not expired
in case error return 401
Check user scopes in order to perform this action (scope = 'allergy_intolerance:read')
Return 403 in case invalid scope(s)
Access to the resource is also managed by ABAC module.
Processing
N/A
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 | 403 |
| Invalid scope | ||
5 | Специфічні | ||||
6 |
Post-processing processes
N/A