Required parameters are marked with "*"

...

Purpose*

This API allows to cancel Care plan in cases it has been rejected or entered in error.

Specification*

...

Link

...

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

...

Resource

...

/api/patients/{{patient_id}}/care_plans/{{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 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 care plan must be equal to care plan stored in DB. See Get Care plan by ID

2. Activities should not be presented in signed content.

3. $.status_reason must be added to signed content

Key points

1. It can be cancelled by author of the Care plan who has an Approval granted by the patient on write Care plan resource

2. Cancel should be signed with DS. So, all the Care plan data (without activities data) should be submitted.

3. Status of the Care plan changed in async way. The result of the job should be a link on the Care plan details.

Input parameters

...

Input parameter

...

Values

...

Type

...

Description

...

Example

Purpose

This API allows to cancel Care plan in cases it has been rejected or entered in error.

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%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

Preconditions

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

Important

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

2. Activities should not be presented in signed content.

3. $.status_reason must be added to signed content

Logic

This method must be used to cancel of existing 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)

Key points

1. It can be cancelled by author of the Care plan who has an Approval granted by the patient on write Care plan resource

2. Cancel should be signed with DS. So, all the Care plan data (without activities data) should be submitted.

3. Status of the Care plan changed in async way. The result of the job should be a link on the Care plan 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

Request structure*

See on Apiary

Example:

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

...

Filters

No

Dictionaries

eHealth/care_plan_categories

eHealth/care_plan_cancel_reasons

eHealth/care_plan_complete_reasons

eHealth/ICD10_AM/condition_codes

PROVIDING_CONDITION

Request structure

See on Apiary

Example:

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

Dummy Cancel Care plan

Example:

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

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 ('Action is not allowed for the legal entity type')

Validate User

1. Extract user_id from token.

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

   1. is specified as Author of the Care plan and 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 not specified as author of the care plan, or has no Approval on write

Validate data consistency

1. Ensure that submitted Care plan relates to the Patient (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

...

1. 1. 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 Care plan by id

2. Check status:

   1. Care plan status should be changed according to Care plan status model.

      1. Return 409 ('Care plan in status <cancelled/completed> cannot be cancelled') in case of error

Validate status reason

Validate value in the field $.status_reason, required

1. Validate field type is codeable concept

2. Check that codeable concept refers to eHealth/care_plan_cancel_reasons dictionary

3. Validate value within dictionary specified above

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

Validate activities

1. Get Care plan activities

2. Check Care plan has no activities or all activities has final status. 

   1. Return 409 ('Care plan has unfinished activities') in case if found at least one activity not in final status

Validate content

Signed content must match with Care plan in DB in order to be changed

1. Render Care plan from DB

2. Exclude $.status_reason from signed content

3. Compare rendered Care plan and signed content

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

Processing

...

Service logic

1. Save signed content to media storage

2. Update Care plan status (update also updated_at, updated_by)

3. Set $.status_reason and $.status_history

Response structure

...

See on Apiary

Example:

Expand
title Response example
Code Block { "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" }, "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", "codetype": 202"object", "urlrequest_id": "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

...

"req-adasdoijasdojsda"
  }
}

HTTP status codes