| Table of Contents | ||||
|---|---|---|---|---|
|
Required parameters are marked with "*"
...
Purpose*
API paragraph not found
Specification*
...
Link
...
...
Resource
...
/api/patients/{{patient_id}}/observations
...
Scope
...
observation:read
...
Components
...
Observation, Encounter
...
Microservices
...
API paragraph not found
...
Protocol type
...
REST
...
Request type
...
GET
...
Sync/Async
...
Async
...
| Table of Contents | ||||
|---|---|---|---|---|
|
Required parameters are marked with "*"
Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.
Purpose*
This web service is designed to return observations by patient_id, episode_id or encouner_id.
Specification*
| Page Properties | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic*
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 |
| |
code | String |
| ||
encounter_id | String |
| ||
diagnostic_report_id | String |
| ||
episode_id | String |
| ||
issued_from | String |
| ||
issued_to | String |
|
Request structure*
API paragraph not found
Filters
...
Filter
...
Values
...
Type
...
Description
...
Example
...
page
...
Number
...
Page number
...
1
...
page_size
...
Number
...
A limit on the number of objects to be returned, between 1 and 100. Default: 50
...
50
...
code
...
String
...
10569-2
...
encounter_id
...
String
...
09dc3ed7-2169-45d8-8fa3-d918c6839bf9
...
diagnostic_report_id
...
String
...
09dc3ed7-2169-45d8-8fa3-d918c6839bf9
...
episode_id
...
String
...
f48d1b6c-a021-4d6a-a5a4-aee93e152ecc
...
issued_from
...
String
...
1990-01-01
...
issued_to
...
String
...
2000-01-01
Request structure*
API paragraph not found
Authorize*
Request to process the request using a token in the headers
Headers*
Наприклад:
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
Request data validation*
API paragraph not found
Processing*
...
Authorize*
Request to process the request using a token in the headers
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 = 'observation:read')
Return 403 in case invalid scope(s)
Validate patient
Validate patient exists in MongoDB
In case of error return 404 not found
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 observations where ME.patients{patient_id}.observationd{*}.context.identifier.value == Select 1
Response structure*
See on Apiary
...