| Table of Contents | ||||
|---|---|---|---|---|
|
...
This web service is designed to return observations by patient_id, episode_id, diagnostic_report_id or encouner_id.
Specification
| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
...
Filters
Filter | Values | Type | Description | Example |
|---|---|---|---|---|
page | Number | Page number |
| |
page_size | Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
| |
code | String |
| ||
encounter_id | String |
| ||
diagnostic_report_id | String |
| ||
episode_id | String |
| ||
issued_from | String |
| ||
issued_to | String |
|
Request structure
API paragraph not foundSee on Apiary
Authorize
Request to process the request using a token in the headers
Headers
Наприклад:
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
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 = 'observation:read')
Return 403 in case invalid scope(s)'observation:read')
Return 403 in case invalid scope(s)
Headers
Наприклад:
Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{secret}}
Request data validation
Access to the resource is also managed by
Validate patient
Validate patient exists in MongoDB
In case of error return 404 not found
Access to the resource is also managed by ABAC module.
Processing
In case episode_id was submitted as a search param:
...
API paragraph not found
HTTP status codes
HTTP status code | Message | What caused the error |
|---|---|---|
200 |
|
|
401 |
| Access token validation failed |
403 |
| Invalid scope |