Table of Contents | ||||
---|---|---|---|---|
|
Required parameters are marked with "*"
...
Purpose
...
This web service is designed to return conditions by episode_id or encouner_ id.
Specification
...
Page Properties | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic*
...
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
patient_id | String | Patient identifier |
| |
condition_id | String | Condition identifier |
|
Request structure
...
See on Apiary
Authorize
...
Request to process the request using a token in the headers
Headers*
Наприклад:
...
...
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
...
Check user scopes in order to perform this action (scope = 'condition: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
Processing
...
In case episode_id was submitted as a search param:
Select all encounters.id where ME.patinents{patient_id}.encounters{*}.episode.identifier.value== episode_id
Select all conditions where ME.patients{patient_id}.conditions{*}.context.identifier.value == Select 1
Response structure
...
See on Apiary
Example:
Expand | ||
---|---|---|
| ||
|
Post-processing processes
...
API paragraph not found
HTTP status codes
...
HTTP status code | Message | What caused the error |
---|---|---|
200 |
|
|
401 |
| Access token validation failed |
403 |
| Invalid scope |