Table of Contents |
---|
...
Table of Contents |
---|
Purpose
This web service is designed to provide access to patient's Immunizations as a part of Patient Summary
Specification
Page Properties | ||
---|---|---|
|
...
Authorization
|
Logic
API paragraph not found
Filters
Filter | Values | Type | Description | Example |
---|---|---|---|---|
patient_id | String | Unique patient identifier |
| |
page | Number | Page number |
| |
page_size | Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
| |
vaccine_code | String |
| ||
date_from | String |
| ||
date_to | String |
|
Request structure
See on Apiary
Authorize
Request to process the request using a token in the headers
Headers
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
X-Custom-PSK:a2aa05c76f3f2d91870f923a53cc8aa8f23bbc01a8238d1c2c26d4299715a7e4
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 immunizations
Apply filters provided by user
Response structure
See on Apiary
Example:
Expand | ||
---|---|---|
| ||
|
Post-processing processes
API paragraph not found
HTTP status codes
Page Properties | ||||||
---|---|---|---|---|---|---|
| ||||||
|