| Table of Contents | ||||
|---|---|---|---|---|
|
...
This web service is designed to return encounters by patient_idsearch params.
Specification
| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
API paragraph not found
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 |
| |
date_from | String |
| ||
date_to | String |
| ||
episode_id | String |
| ||
incoming_referral_id | String |
| ||
origin_episode_id | String |
|
Request structure
API paragraph not foundSee on Apiary
Authorize
Request to process the request using a token in the 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 = 'encounter: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 ABAC module.
...
HTTP status code | Message | What caused the error |
|---|---|---|
200 |
|
|
401 |
| Access token validation failed |
403 |
| Invalid scope |