Table of Contents

minLevel	1
maxLevel	3

Purpose

This WS intended is designed to get return all records about the activities related to the specified Care plan.

Specification

Apiary

...

care plan in patient context

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/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%B5%D1%80%D0%B2%D0%B8%D0%BD%D0%BD%D0%BE%D0%B3%D0%BE-%D0%BF%D1%80%D0%B8%D0%B7%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%BD%D1%8F-%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

Link	MEDICAL EVENTS MIS API · Apiary
Resource	/api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities
Scope	care_plan:read
Components	Care plan
Microservices	me/api-medical-events me/event-consumer me/kafka-consumer il/api(rpc)
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private/Internal	Public

Logic

Returns all the activities related to the care plan in patient context

Input parameters

Input parameter	Values	Type	Description	Example
patient_id		String	MPI identifier of the patient	`7c3da506-804d-4550-8993-bf17f9ee0402`
care_plan_id		String	Care Plan identifier	`9183a36b-4d45-4244-9339-63d81cd08d9c`

Filters

Filter	Values	Type	Description	Example
author		String	author of the activity	`9183a36b-4d45-4244-9339-63d81cd08d9c`
kind	service_request medication_request	Enum	kind of the activity	`service_request`
status		String	Care plan activity status	`scheduled`
page		Number	Page number	`2`
page_size		Number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	`50`

Dictionaries

eHealth/care_plan_activity_outcomes

eHealth/ICD10_AM/condition_codes

eHealth/care_plan_activity_goals

eHealth/care_plan_activity_cancel_reasons

eHealth/care_plan_activity_complete_reasons

eHealth/ucum/units

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

...

for which one of the conditions is TRUE:
1. has an active Approval granted by the Patient

...

1. 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 belongs to another legal_entity and none of conditions above is true

Processing

Service logic

Service returns activity list within specified Care plan related to the patient:

Get activity list by Care plan identifier from care_plan_activities collection (MongoDB)
Validate data consistency:
1. Ensure that each requested activity in the list relates to requested Patient and Care Plan (from URL)
  1. 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": "75a5d991-0bf7-476f-b3cf-bec73f044b2e",
      "author": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "care_plan": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "care_plan"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "detail": {
        "kind": "service_request",
        "product_reference": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "service"
                }
              ],
              "text": ""
            },
            "value": "97d57238-ffbe-4335-92ea-28d4de117ea3"
          }
        },
        "reason_code": [
          {
            "coding": [
              {
                "system": "eHealth/ICD10_AM/condition_codes",
                "code": "X85"
              }
            ]
          }
        ],
        "reason_reference": [
          {
            "identifier": {
              "type": {
                "coding": [
                  {
                    "system": "eHealth/resources",
                    "code": "condition"
                  }
                ]
              },
              "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
            }
          }
        ],
        "goal": [
          {
            "coding": [
              {
                "system": "eHealth/care_plan_activity_goals",
                "code": "diabetes_treatment"
              }
            ]
          }
        ],
        "quantity": {
          "value": 13,
          "system": "MEDICATION_UNIT",
          "code": "MG",
          "unit": "мг"
        },
        "scheduled_timing": {
          "event": [
            "2018-08-02T10:45:16Z"
          ],
          "repeat": {
            "bounds_duration": {
              "value": 10,
              "comparator": ">",
              "unit": "доба",
              "system": "eHealth/ucum/units",
              "code": "day"
            },
            "count": 10,
            "count_max": 20,
            "duration": 15,
            "duration_max": 25,
            "duration_unit": "day",
            "frequency": 1,
            "frequency_max": 4,
            "period": 1,
            "period_max": 3,
            "period_unit": "day",
            "day_of_week": [
              "mon"
            ],
            "time_of_day": [
              "16:00:00"
            ],
            "when": [
              "WAKE"
            ],
            "offset": 20
          },
          "code": {
            "coding": [
              {
                "system": "TIMING_ABBREVIATION",
                "code": "Q4H"
              }
            ]
          }
        },
        "location": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "division"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          }
        },
        "performer": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "employee"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          }
        },
        "daily_amount": {
          "value": 13.5,
          "system": "MEDICATION_UNIT",
          "code": "MG",
          "unit": "мг"
        },
        "description": "Some activity description",
        "do_not_perform": false,
        "program": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "medical_program"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          }
        },
        "status": "completed",
        "status_reason": {
          "coding": [
            {
              "system": "eHealth/care_plan_activity_cancel_reasons",
              "code": "some code"
            }
          ]
        },
        "remaining_quantity": {
          "value": 12,
          "system": "MEDICATION_UNIT",
          "code": "MG",
          "unit": "мг"
        }
      },
      "outcome_reference": [
        {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "encounter"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          }
        }
      ],
      "outcome_codeable_concept": [
        {
          "coding": [
            {
              "system": "eHealth/care_plan_activity_outcomes",
              "code": "some code"
            }
          ]
        }
      ],
      "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"
    }
  ]
}

Post-processing processes

No

HTTP status codes

Page Properties

HTTP status code	Message	What caused the error
200	Response
401	Invalid access token	Invalid access token
403	Access denied Your scope does not allow to access this resource. Missing allowances: care_plan:read	Employee has no Approval on read or write Invalid scope(s)
404	Not found	Request data validation error

Versions Compared

Old Version 3

New Version Current

Key

Purpose

Specification

Specification

Logic

Input parameters

Filters

Dictionaries

Request structure

Authorize

Headers

Request data validation

Validate Patient

Validate Care plan

Validate User

Processing

Service logic

Response structure

Post-processing processes

HTTP status codes

Page Comparison

Versions Compared

Old Version 3

New Version Current

Key

Purpose

Specification

Specification

Logic

Input parameters

Filters

Dictionaries

Request structure

Authorize

Headers

Request data validation

Validate Patient

Validate Care plan

Validate User

Processing

Service logic

Response structure

Post-processing processes

HTTP status codes