Table of Contents

minLevel	1
maxLevel	3

Purpose

This method must be used to complete of existing activity from patient's Care plan.

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/2125038637/care+plan#%D0%97%D0%B0%D0%B2%D0%B5%D1%80%D1%88%D0%B5%D0%BD%D0%BD%D1%8F-%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

Specification

Page Properties

Link	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/care-plan/complete-care-plan-activity/complete-care-plan-activity
Resource	/api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities/{{id}}/actions/complete
Scope	care_plan:write
Components	Care plan
Microservices	me/api-medical-events me/event-consumer me/kafka-consumer il/api(rpc)
Protocol type	REST
Request type	PATCH
Sync/Async	Async
Public/Private/Internal	Public

Preconditions

An activity from the Patient Care Plan must already be created

Logic

This method must be used to complete of existing activity from patient's Care plan.

It can be processed in both sync and async methods depends on Server decision.

Key points

Status can be changed by employee who has an Approval granted by the patient on write Care plan resource.
Activity completes without using DS.
Activities status has changed in async way. The result of the job should be a link on the Care plan activity details.

Input parameters

Input parameter	Type	Description	Example
patient_id	String	MPI identifier of the patient	`7c3da506-804d-4550-8993-bf17f9ee0402`
care_plan_id	String	Care Plan identifier	`7c3da506-804d-4550-8993-bf17f9ee0403`
id	String	activity identifier	`7c3da506-804d-4550-8993-bf17f9ee0404`

Filters

No

Dictionaries

eHealth/care_plan_activity_complete_reasons

eHealth/care_plan_activity_outcomes

Request structure

See on Apiary

Example:

Expand

title	Request example

Code Block

{
  "outcome_codeable_concept": [
    {
      "coding": [
        {
          "system": "eHealth/care_plan_activity_outcomes",
          "code": "some code"
        }
      ]
    }
  ],
  "detail": {
    "status_reason": {
      "coding": [
        {
          "system": "eHealth/care_plan_activity_complete_reasons",
          "code": "some code"
        }
      ]
    }
  }
}

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:write')
- Return (403, 'Your scope does not allow to access this resource. Missing allowances: care_plan:write') 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 legal entity

Extract client_id from token
Check legal entity status is ACTIVE
- In case of error - return 409 (Legal entity must be ACTIVE)
Check legal entity type in ME_ALLOWED_TRANSACTIONS_LE_TYPES config parameter
- in case of error - return 409 ('client_id refers to legal entity with type that is not allowed to create medical events transactions')

Validate User

Extract user_id from token.
Check user has an active and approved employee that:
- has an active Approval granted by the Patient on write the Care plan resource (care plan id from URL)
  - Return 403 ('Access denied') in case employee has no Approval on write

Validate data consistency

Ensure that submitted activity relates to the Patient and Care Plan (from URL)
- Return 404 (not found) in case of error

Validate status transition

Get activity by id
Check activity.detail.status: activity status should be changed according to activity status model.
- Return 409 (Invalid activity status) in case of error

Validate status reason

Validate value in the field $.detail.status_reason, required

Validate field type is codeable concept
Check that codeable concept refers to the eHealth/care_plan_activity_complete_reasons dictionary
Validate value within dictionary specified above

Validate related entities

if activity kind = medication_request:
- Check there is no medication request requests in status NEW based on the activity
  - in case of error - return 409 (Unable to complete activity with new Medication Request requests).
- Check there is no medication requests in status ACTIVE based on the activity
  - in case of error - return 409 (Unable to complete activity with active Medication requests).
if activity kind = service_request:
- ~~Check availability of service requests with~~ ~~status = active~~~~. If such service requests exist, then needs to check availability of service requests with~~ ~~program_processing_status~~:
  1. if ~~program_processing_status~~ ~~is undefined (~~~~NULL~~~~), then return error 409 (Unable to complete activity with Service requests in status <status value> and program processing status is NULL or not completed)~~
  2. if ~~program_processing_status~~ ~~is defined, then needs to check that~~ ~~program_processing_status = complete~~~~. Otherwise, return error 409 (Unable to complete activity with Service requests in status <status value> and program processing status is NULL or not completed)~~
- Check all related service requests in final status: completed, recalled or entered_in_error.
  - in case at least one is active - return error 409 (Unable to complete activity with Service requests in active status)

Validate outcome

Validate value in the field $.outcome_codeable_concept, required

Validate field type is array of codeable concepts
Validate each value in array:
- it refers to the eHealth/care_plan_activity_outcomes dictionary
- value within dictionary

Processing

Service logic

Update activity status to completed (update also updated_at, updated_by)
Set outcome_codeable_concept

Response structure

See on Apiary

Example:

Expand

title	Response example

Code Block

{
  "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": "medication_request",
      "product_reference": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "medication"
              }
            ],
            "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": 6.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_complete_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"
          }
        ]
      }
    ]
  },
  "meta": {
    "code": 201,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Expand

title	Response example

Code Block

{
  "data": {
    "status": "pending",
    "eta": "2018-08-02T10:45:16.000Z",
    "links": [
      {
        "entity": "job",
        "href": "/Jobs/NBXk9EyErUZv1RhXgyvgg"
      }
    ]
  },
  "meta": {
    "code": 202,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Post-processing processes

API paragraph not found

HTTP status codes

Page Properties

HTTP status code	Message	What caused the error
201	use payload from response	sync
202	use Get job details to get processing result. Response payload will be returned in the job details	async: default method
401	Invalid access token	validation fails token is expired
403	Your scope does not allow to access this resource. Missing allowances: care_plan:write Access denied	invalid scope(s) employee has no Approval on write
404	not found	The submitted activity is not related to the Patient Care Plan
409	Legal entity must be ACTIVE client_id refers to legal entity with type that is not allowed to create medical events transactions Invalid activity status Unable to cancel activity with new Medication Request requests Unable to cancel activity with active Medication requests ~~Unable to cancel activity with Service requests in status <status value> and program processing status is NULL or not completed~~ Unable to cancel activity with Service requests in active status	Validation error

Versions Compared

Old Version 6

New Version Current

Key

Purpose

Specification

Preconditions

Logic

Key points

Input parameters

Filters

Dictionaries

Request structure

Authorize

Headers

Request data validation

Validate legal entity

Validate User

Validate data consistency

Validate status transition

Validate status reason

Validate related entities

Validate outcome

Processing

Service logic

Response structure

Post-processing processes

HTTP status codes

Page Comparison

Versions Compared

Old Version 6

New Version Current

Key

Purpose

Specification

Preconditions

Logic

Key points

Input parameters

Filters

Dictionaries

Request structure

Authorize

Headers

Request data validation

Validate legal entity

Validate User

Validate data consistency

Validate status transition

Validate status reason

Validate related entities

Validate outcome

Processing

Service logic

Response structure

Post-processing processes

HTTP status codes