/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
Properties of a REST API method document
Purpose
Return brief information in order not to disclose confidential and sensitive data.
Logic
This web service returns brief information in order not to disclose confidential and sensitive data. Access to full episode data is restricted by patient's approval. If you have an approval - you can obtain episode details and nested entities through /episode/:id/* web services.
Configuration parameters
N/A (Not applicable)
Dictionaries
N/A (Not applicable)
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id | M | String | Unique MPI patient identifier |
|
| 2 | period_start_from |
| String |
|
|
| 3 | period_start_to | String |
| ||
| 4 | period_end_from | String |
| ||
| 5 | period_end_to | String |
| ||
| 6 | page |
| Number | Page number |
|
| 7 | page_size |
| Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
|
Request structure
See on API-specification
Headers
See on Headers
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 = 'patient_summary:read')
Return 403 in case invalid scope(s)
Validate patient
Validate patient exists in MongoDB
In case of error return 404 not found
Processing
Get all patient's episodes
Filter using Forbidden Groups
Apply filters provided by user
Render reduced episode data
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 | Response | |||
| 3 | 401 | Access token validation failed | |||
| 4 | 401 | Access token expired | |||
| 5 | 403 |
| Invalid scope | ||
| 6 | 404 | Patient not found | |||
| 7 | Специфічні | ||||
Post-processing processes
N/A (Not applicable)
Technical modules where the method is used
N/A (Not applicable)