Required parameters are marked with "*"

...

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

Logic

...

Returns care plan details by it's identifier in patient context

Input parameters

Filters

No

Dictionaries

eHealth/care_plan_categories

eHealth/ICD10_AM/condition_codes

PROVIDING_CONDITION

Request structure

...

Authorize

...

1. Verify the validity of access token

   1. Return (401, 'Invalid access token') in case of validation fails

2. Verify that token is not expired

   1. in case of error - return (401, 'Invalid access token')

3. Check user scopes in order to perform this action (scope = 'care_plan:read')

   1. 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

1. Get Patient identifier from the URL

2. Check it exists

...

1. in DB

   1. Return 404 ('not found') in case of error

Validate Care plan

1. Get Care plan identifier from the URL

2. Check it exists in DB

   1. Return 404 ('not found') in case of error

3. Check Care plan belongs to patient

   1. 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

1. Extract user_id from token.

2. Check user has an active and approved employee from legal entity (token) for which one of the conditions is TRUE:

   1. has an active Approval granted by the Patient on write or read the Care plan resource (care plan id from URL)

      1. Return 403 ('Access denied') in case employee has no Approval on read or write

   2. has an active declaration with the patient

      1. Return 403 ('Access denied') in case there no active declaration with patient and none of other conditions is true

   3. user belongs to the legal entity where the care_plans were created

      1. Return 403 ('Access denied') in case employee

...

has an active declaration with the patient

...

1. 1. 1. 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:

1. Get activity by ID from care_plan_activities collection (MongoDB)

2. Validate data consistency:

   1. Ensure that requested Care plan relates to requested Patient (from URL)

      1. Return 404 ('not found') in case of error

3. Render a response according to specification

Response structure

...

See on Apiary

Example:

Expand
title Response example
Code Block { "meta": { "code": 200, "url": "http://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": { "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600", "based_on": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "care_plan" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" } }, "part_of": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "care_plan" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" } }, "category": { "coding": [ { "system": "eHealth/care_plan_categories", "code": "diabetics" } ] }, "title": "Diabetics health plan", "description": "Some description of the care plan", "period": { "start": "2018-08-02T10:45:16.000Z", "end": "2018-08-02T11:00:00.000Z" }, "supporting_info": [ { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "episode_of_care" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" } } ], "note": "Some notes", "intent": "order", "encounter": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "encounter" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" } }, "addresses": [ { "coding": [ { "system": "eHealth/ICD10_AM/condition_codes", "code": "E11.9" } ] } ], "author": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "employee" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" } }, "contributor": [ { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "employee" } ] }, "value": "9183a36b-4d45-4244-9339-63d81cd08d9c" } } ], "terms_of_service": { "coding": [ { "system": "PROVIDING_CONDITION", "code": "INPATIENT" } ] }, "inform_with": { "auth_method_id": "cc949559-5dfe-420f-ac05-065e443b2cc6" }, "status": "active", "subject": { "identifier": { "type": { "coding": [ { "system": "eHealth/resources", "code": "patient" } ] }, "value": "7c3da506-804d-4550-8993-bf17f9ee0403" } }, "status_history": [ { "status": "active", "status_reason": { "coding": [ { "system": "eHealth/care_plan_cancel_reasons", "code": "some code" } ] }, "inserted_at": "2018-08-02T10:45:16.000Z", "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e" } ], "requisition": "0123-4567-89AB-CEIK", "inserted_at": "2017-04-20T19:14:13Z", "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e", "updated_at": "2017-04-20T19:14:13Z", "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd" }, "urgent": { "informing_method_current": { "type": "OTP", "phone_number": "+38093*****85" } } }

Post-processing processes

...

API paragraph not found

HTTP status codes*

...

HTTP status code

...

Message

...

What caused the error

...

 200

...

...

No

HTTP status codes