Purpose*

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

Specification*

...

Link

...

https://medicaleventsmisapi.docs.apiary.io/#reference/care-plan/cancel-care-plan-activity/cancel-care-plan-activity

...

Resource

...

/api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities{{id}}/actions/cancel

...

Scope

...

care_plan:write

...

Components

...

Care plan

...

Microservices

...

API paragraph not found

...

Protocol type

...

REST

...

Request type

...

PATCH

...

Sync/Async

...

Async

...

Public/Private/Internal

...

Public

Logic*

This method must be used to cancel of existing activity from patient's Care plan. Method receives signed message (pkcs7) that consists of signed content, digital signature and signer public key. All signature fields will be validated (including signer certificate authority)

Important

1. Signed content of activity must be equal to activity stored in DB. See Get Care plan activity by ID

2. $.detail.status_reason must be changed in signed content

Please see Care plan status model and Dummy Cancel Care plan activity for more details

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

Key points

1. Status can be changed by employee who has an Approval granted by the patient on write Care plan resource.

2. Cancel should be signed with DS. So, all the activity data should be submitted.

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

...

Values

...

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

Request structure*

See on Apiary

Example:

{
  "signed_data": "ew0KICAicGVyaW9kIjogew0KIC..."
}

...

Purpose

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

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/2125038637/care+plan#%D0%92%D1%96%D0%B4%D0%BC%D1%96%D0%BD%D0%B0-%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

Preconditions

Sign message (pkcs7) that consists of signed content, digital signature, and signer public key

Important

1. Signed content of activity must be equal to activity stored in DB. See Get Care plan activity by ID

2. $.detail.status_reason must be changed in signed content

Logic

This method must be used to cancel of existing activity from patient's Care plan. Method receives signed message (pkcs7) that consists of signed content, digital signature and signer public key. All signature fields will be validated (including signer certificate authority)

Important

1. Signed content of activity must be equal to activity stored in DB. See Get Care plan activity by ID

2. $.detail.status_reason must be changed in signed content

Please see Care plan status model and Dummy Cancel Care plan activity for more details

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

Key points

1. Status can be changed by employee who has an Approval granted by the patient on write Care plan resource.

2. Cancel should be signed with DS. So, all the activity data should be submitted.

3. Activities status has changed in async way. The result of the job should be a link on the Care plan activity details.

Global and configurable parameters

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/2125039308/Care+Plan+dictionaries+and+configurable+parameters+UA#%D0%9A%D0%BE%D0%BD%D1%84%D1%96%D0%B3%D1%83%D1%80%D0%B0%D1%86%D1%96%D0%B9%D0%BD%D1%96-%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B8

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/583402009/Medical+Events+Dictionaries+and+configurations#ME_ALLOWED_TRANSACTIONS_LE_TYPES

Input parameters

Filters

No

Dictionaries

eHealth/care_plan_activity_cancel_reasons

eHealth/care_plan_activity_outcomes

eHealth/ICPC2/condition_codes

eHealth/ICD10_AM/condition_codes

eHealth/care_plan_activity_goals

eHealth/care_plan_activity_complete_reasons

eHealth/ucum/units

MEDICATION_UNIT

DAYS_OF_WEEK

EVENT_TIMING

SPECIALITY_TYPES_ALLOWED

PROVIDING_CONDITIONS_ALLOWED

INNM_DOSAGE

Request structure

See on Apiary

Example:

{
  "signed_data": "ew0KICAicGVyaW9kIjogew0KIC..."
}

Dummy Example:

{
  "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": "scheduled",
    "status_reason": {
      "coding": [
        {
          "system": "eHealth/care_plan_activity_cancel_reasons",
          "code": "some code"
        }
      ]
    }
  },
  "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"
}

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:write')

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

...

and processing

Validate legal entity

1. Extract client_id from token

2. Check legal entity status is ACTIVE

   1. In case of error - return 409 (Legal entity must be ACTIVE)

3. Check legal entity type in ME_ALLOWED_TRANSACTIONS_LE_TYPES config parameter

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

1. Extract user_id from token.

2. Check user has an active and approved employee that:

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

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

Validate data consistency

1. Ensure that submitted activity relates to the Patient and Care Plan (from URL)

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

Validate Digital Sign

1. Check DS is valid and not expired

2. Validate that DS belongs to the user

   1. Check that DRFO from DS and user's party.tax_id matches

      1. in case of error - return 409 (“Signer DRFO doesn't match with requester tax_id“)

Validate status transition

1. Get activity by id

2. Check activity.detail.status: activity status should be changed according to activity status

...

1. model.

   1. Return 409 (Invalid activity status) in case of error

2. Check activity.detail.status in (in_progress, scheduled)

   1. in case of error - return 409 ('Activity can be cancelled only if it has in_progress or scheduled status')

Validate status reason

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

1. Validate field type is codeable concept

2. Check that codeable concept refers to the eHealth/care_plan_activity_cancel_reasons dictionary

3. Validate value within dictionary specified above

   1. in case of error - return 422 ('value is not allowed in enum')

Validate related entities

...

1. if activity kind = medication_request:

   1. Check there is no medication request requests in status NEW based on the activity

      1. in case of error - return 409 (Unable to cancel activity with new Medication Request requests).

   2. Check there is no medication requests in status ACTIVE based on the activity

      1. in case of error - return 409 (Unable to cancel activity with active Medication requests).

2. if activity kind = service_request:

   1. 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 cancel activity with Service requests in status <status value> and program processing status is NULL or not completed)

      2. if program_processing_status

...

1. 1. 1. is defined, then needs to check that program_processing_status

...

1. 1. 1. = complete. Otherwise, return error 409 (Unable to cancel activity with Service requests in status <status value> and program processing status is NULL or not completed)

...

1. 1. Check all related service requests in final status: completed, recalled or entered_in_error.

      1. in case at least one is active - return error 409 (Unable to cancel activity with Service requests in active status)

2. if activity kind = device_request:

   • Check there is no device requests in status ACTIVE based on the activity

     • in case of error - return 409 (Unable to cancel activity with

...

1. • • active Device requests).

Validate content

Signed content must match with activity in DB in order to be changed

1. Render activity from DB

2. Exclude $.detail.status_reason from signed content

3. Compare rendered activity and signed content

   1. In case both object doesn't match - return 422 ('Signed content doesn't match with previously created activity')

Processing

...

Service logic

1. Save signed content to media storage

2. Update activity status (update also updated_at, updated_by)

3. Set detail.status_reason

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": "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" } ] } ] }, "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", "metatype": {"object", "coderequest_id": 202, "req-adasdoijasdojsda" "url": "http://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" } }

Post-processing processes*

API paragraph not found

HTTP status codes*

...

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

...

}
}

HTTP status codes