REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

Properties of a REST API method document

Document type	Метод REST API
Document title	[Document status] REST API [Назва методу] [ID методу]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-001-001-0222
Microservices (namespace)	ME
Component	Care plan
Component ID	COM-007-001
Link на API-специфікацію	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/care-plan/cancel-care-plan-activity/cancel-care-plan
Resource	{{host}}/api/patients/{{patient_id}}/care_plans/{{id}}/actions/cancel
Scope	care_plan:write
Protocol type	REST
Request type	PATCH
Sync/Async	Async(def)/Sync
Public/Private	Public

Purpose

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

Процеси роботи з планом лікування (care plan) | Відміна плану лікування

Key points

It can be cancelled by author of the Care plan who has an Approval granted by the patient on write Care plan resource
Cancel should be signed with DS. So, all the Care plan data (without activities data) should be submitted.
Status of the Care plan changed in async way. The result of the job should be a link on the Care plan details.

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)

Service logic

Save signed content to media storage
Update Care plan status (update also updated_at, updated_by)
Set $.status_reason and $.status_history

Configuration parameters

Care Plan dictionaries and configurable parameters_UA | Конфігураційні параметри

Medical Events Dictionaries and configurations | ME_ALLOWED_TRANSACTIONS_LE_TYPES

Dictionaries

eHealth/care_plan_categories

eHealth/care_plan_cancel_reasons

eHealth/care_plan_complete_reasons

eHealth/ICD10_AM/condition_codes

PROVIDING_CONDITION

Input parameters

Description of input parameters

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

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

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"
      }
    ]
  }
}

Headers

	Key	Value	Mandatory	Description	Example
1	Content-Type	application/json	M	Тип контенту	Content-Type:application/json
2	Authorization	Bearer {{access_token}}			Authorization:Bearer {{access_token}}
3	API-key	{{mis_client_secret}}			API-key:{{mis_client_secret}}

Request data validation

Validate legal entity

Extract client_id from token
Check legal entity status is ACTIVE
1. In case of error - return 409 ('Legal entity must be ACTIVE')
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

Extract user_id from token.
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

Ensure that submitted Care plan relates to the Patient (from URL)
1. Return 404 (not found) in case of error

Validate Digital Sign

Check DS is valid and not expired
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

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

Validate field type is codeable concept
Check that codeable concept refers to eHealth/care_plan_cancel_reasons dictionary
Validate value within dictionary specified above
1. in case of error - return 422 ('value is not allowed in enum')

Validate activities

Get Care plan activities
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

Render Care plan from DB
Exclude $.status_reason from signed content
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

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API response structure, example

Example

{
  "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"
  }
}

Response Examlpe

{
  "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"
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		201	use payload from response	sync
3		202	use Get job details to get processing result. Response payload will be returned in the job details	async: default method
4		401	Invalid access token	validation fails token is expired
5		401	Unauthorized		Помилка підтвердження
6		403	Access denied	invalid scope(s)
7		403	Your scope does not allow to access this resource. Missing allowances: care_plan:write	employee has no Approval on write
8	1000	404	Composition not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок
9		404	not found	The submitted Care Plan is not related to the Patient
10		409	Action is not allowed for the legal entity type	Validation error
11		409	Care plan in status <cancelled/completed> cannot be cancelled
12		409	Care plan has unfinished activities
13		409	Legal entity must be ACTIVE
14		409	Signer DRFO doesn't match with requester tax_id
15		422	Signed content doesn't match with previously created care plan	Validation error
16		422	value is not allowed in enum
17	Специфічні
18		422	Only for active MPI record can be created medication request!

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

Cancel Care Plan [API-007-001-001-0222]

Properties of a REST API method document

Purpose

Key points

Logic

Service logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Validate legal entity

Validate User

Validate data consistency

Validate Digital Sign

Validate status transition

Validate status reason

Validate activities

Validate content

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used