| Table of Contents | ||||
|---|---|---|---|---|
|
Required parameters are marked with "*"
...
| Table of Contents | ||||
|---|---|---|---|---|
|
Purpose
Returns care plan details by it's identifier in patient context. To obtain activity list for the Care plan Get Care Plan activities should be used.
https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/2125039149 should be used.2125038637/care+plan#%D0%9E%D1%82%D1%80%D0%B8%D0%BC%D0%B0%D0%BD%D0%BD%D1%8F-%D1%96%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D1%96%D1%97-%D0%BF%D0%BB%D0%B0%D0%BD%D1%83-%D0%BB%D1%96%D0%BA%D1%83%D0%B2%D0%B0%D0%BD%D0%BD%D1%8F
Specification
...
| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
...
Returns care plan details by it's identifier in patient context
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
patient_id | String | MPI identifier of the patient |
| |
id | String | Care Plan identifier |
|
Filters
No
Dictionaries
eHealth/care_plan_categories
eHealth/ICD10_AM/condition_codes
PROVIDING_CONDITION
Request structure
...
Authorize
...
Verify the validity of access token
Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
in case of error - return (401, 'Invalid access token')
Check user scopes in order to perform this action (scope = 'care_plan:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: care_plan:read') in case of invalid scope(s)
Request to process the request using a token in the headers
Headers
...
Наприклад:
Content-Type:application/json
Authorization:Bearer
...
{{access_token}}
API-key:{{mis_client_secret}}
Request data validation
...
Validate Patient
Get Patient identifier from the URL
Check it exists
...
in DB
Return 404 ('not found') in case of error
Validate Care plan
Get Care plan identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Check Care plan belongs to patient
Return 404 ('not found') in case of error
Validate
...
Get Care plan identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Check Care plan belongs to patient
Return 404 ('not found') in case of error
Validate User
...
Extract user_id from token.
Check user has an active and approved employee from legal entity (token) that:
...
User
Extract user_id from token.
Check user has an active and approved employee from legal entity (token) for which one of the conditions is TRUE:
has an active Approval granted by the Patient on write or read the Care plan resource (care plan id from URL)
Return 403 ('Access denied') in case employee has no Approval on read or write
has an active declaration with the patient
Return 403 ('Access denied') in case there no active declaration with patient and none of other conditions is true
user belongs to the legal entity where the care_plans were created
Return 403 ('Access denied') in case employee
...
has an active declaration with the patient
...
belongs to another legal_entity and none of conditions above is true
Processing
Service logic
Service returns specified Care plan related to the patient, but without Care plan’s activities:
Get activity by ID from care_plan_activities collection (MongoDB)
Validate data consistency:
Ensure that requested Care plan 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
Example:
| Expand | ||
|---|---|---|
| ||
|
Post-processing processes
...
API paragraph not found
HTTP status codes*
...
HTTP status code
...
Message
...
What caused the error
...
200
...
...
No
HTTP status codes
| Page Properties | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|