Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose

...

*

Returns care plan details by it's identifier in patient context. To obtain activity list for the Care plan API. Get Care Plan activities_EN https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/2125039149 should be used.

Specification

...

Apiary

...

*

Page Properties

Link	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/care-plan/get-care-plan-by-id/get-care-plan-by-id
Resource	/api/patients/{{patient_id}}/care_plans/{{id}}
Scope	care_plan:read
Components	Care plan
Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Async

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	`7c3da506-804d-4550-8993-bf17f9ee0402`
id		String	Care Plan identifier	`7c3da506-804d-4550-8993-bf17f9ee0403`

Request structure*

API paragraph not found

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 c2778f3064753ea70de870a53795f5c9
api-key:uXhEczJ56adsfh3Ri9SUkc4en

Request data validation*

Validate Patient

Get Patient identifier from the URL
Check it exists in DB
- Return 404 ('not found') in case of error

...

Extract user_id from token.
Check user has an active and approved employee from legal entity (token) that:
- 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

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

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*

Page Properties

HTTP status code	Message	What caused the error
200

Versions Compared

Old Version 3

New Version 4

Key

Required parameters are marked with "*"

Purpose

*

Specification

*

Logic*

Input parameters

Request structure*

Authorize*

Headers*

Request data validation*

Validate Patient

Processing*

Service logic

Response structure*

Post-processing processes*

HTTP status codes*

Page Comparison

Versions Compared

Old Version 3

New Version 4

Key

Required parameters are marked with "*"

Purpose

*

Specification

*

Logic*

Input parameters

Request structure*

Authorize*

Headers*

Request data validation*

Validate Patient

Processing*

Service logic

Response structure*

Post-processing processes*

HTTP status codes*