| Table of Contents | ||||
|---|---|---|---|---|
|
Purpose
...
Purpose
This web service is designed to return encounters info by episode_id.
Specification
| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
API paragraph not foundThis web service is designed to return encounters info by episode_id.
Filters
Filter | Values | Type | Description | Example |
|---|---|---|---|---|
patient_id | String | Patient identifier |
| |
episode_id | String | Episode identifier |
| |
date_from | String |
| ||
incoming_referral | String |
| ||
date_to | String |
| ||
page | Number | Page number |
| |
page_size | Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
| |
origin_episode_id | String |
|
Request structure
API paragraph not found
Authorize
Request to process the request using a token in the headers
Headers
Наприклад:
API paragraph not found
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 = 'episode:read')
Return 403 in case invalid scope(s)
Headers
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqMapi{{access_token}}
API-key:aFBLVTZ6Z2dON1V{{secret}}
Request data validation
API paragraph not found
...
HTTP status code | Message | What caused the error |
|---|---|---|
200 |
|
|
401 |
| Access token validation failed |
403 |
| Invalid scope |