| Table of Contents | ||||
|---|---|---|---|---|
|
Purpose
This method intended to get all Devices in patient context by params
This web service is designed to return records about patient's devices by patient_id or search_params.
Specification
| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
...
Service returns specified all Devices in patient context:
Get data from devices (MongoDB)
Filter list above by submitted search parameters
It must be allowed to pass multiple comma-separated values for some query parameters:
type
definition
status
Sorting by inserted_at desc
Render a response according to specification.
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 |
| |
type | String |
| ||
encounter_id | String |
| ||
episode_id | String |
| ||
asserted_date_from | String |
| ||
asserted_date_to | String |
|
Request structure
API paragraph not found
...
Request to process the request using a token in the headers
Headers
Наприклад:
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
...
Check user scopes in order to perform this action (scope = 'device:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: device:read') in case of invalid scope(s)
Access to the resource is also managed by ABAC module
Validate Patient
Get Person identifier from the URL
Check it exists in DB
Return 404 ('not_found') in case of error
Processing
API paragraph not found
...
API paragraph not found
HTTP status codes
HTTP status code | Message | What caused the error |
|---|---|---|
200 |
|
|