Table of Contents | ||||
---|---|---|---|---|
|
...
This web service is designed to return observations by patient_ id , episode(observation_id or encouner) related to the patient with patient_id.
Specification
Page Properties | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
API paragraph not found
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
patient_id | String | Patient identifier |
| |
observation_id | String | Observation identifier |
|
Request structure
API paragraph not foundSee on Apiary
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 = 'observation:read')
Return 403 in case invalid scope(s)
Headers
Наприклад:
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM{{access_token}}
API-key:{{secret}}
Request data validation
API paragraph not found
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 observations where ME.patients{patient_id}.observationd{*}.context.identifier.value == Select 1Get 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 |