| Table of Contents | ||||
|---|---|---|---|---|
|
...
This web service is designed to return observations by id (observation_id) related to the patient with patient_id.
Specification
| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
patient_id | String | Patient identifier |
| |
observation_id | String | Observation identifier |
|
Request structure
See on Apiary
...
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 = 'observation:read')
Return 403 in case invalid scope(s)
Headers
Наприклад:
Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{secret}}
Request data validation
API paragraph not found
Processing
...
Get observation by ID from observations collection (MongoDB)
Validate data consistency:
Ensure that requested observation relates to requested Patient (from URL)
Return 404 ('not found') in case of error
Render a response according to specification
Response structure
See on Apiary
...
API paragraph not found
HTTP status codes
HTTP status code | Message | What caused the error |
|---|---|---|
200 |
|
|
401 |
| Access token validation failed |
403 |
| Invalid scope |