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

Table of Contents

Info
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

Page Properties

id	page_properties_method_REST API

Document type	Метод REST API
Document title	[Document status] REST API [Назва методу] [ID методуDRAFT] Cancel Care Plan Activity [API-007-001-002-0228]
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-002-0228
Microservices (namespace)	ME
Component	Care plan
Component ID	COM-007-001
Link на API-специфікацію	https://medicaleventsmisapi.docs.apiary.io/#reference/care-plan/cancel-care-plan-activity/cancel-care-plan-activity
Resource	{{host}}/api/patients/{{patient_id}}/care_plans/{{care_plan_id}}/activities{{id}}/actions/cancel
Scope	care_plan:write
Protocol type	REST
Request type	PATCH
Sync/Async	Async(def)/Sync
Public/Private	Public

Purpose

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

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

Key points

Status can be changed by employee who has an Approval granted by the patient on write Care plan resource.
Cancel should be signed with DS. So, all the activity data should be submitted.
Activities status has changed in async way. The result of the job should be a link on the Care plan activity details.

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)

...

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

Service logic

Save signed content to media storage
Update activity status (update also updated_at, updated_by)
Set detail.status_reason

Configuration parameters

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

Medical Events Dictionaries and configurations | ME_ALLOWED_TRANSACTIONS_LE_TYPES

Dictionaries

eHealth/care_plan_activity_cancel_reasons

...

PROVIDING_CONDITIONS_ALLOWED

INNM_DOSAGE

Input parameters

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

Request structure

See on API-specification

Expand

title	Example

Code Block

language	json

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

...

Expand

title	Request Example

Code Block

language	json

{
  "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" ],
  "updatedinserted_at": "2017-04-20T19:14:13Z",
  "updatedinserted_by": "2922a240e1453f4c-63db1077-404e4e85-b7308c98-09222bfeb2ddc13ffca0063e"
}

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer {{access_token}}

...

Authorization:Bearer {{access_token}}

...

API-key

...

,
  "updated_at": "2017-04-20T19:14:13Z",
  "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
}

Headers

Request data validation

Authorize

Verify the validity of access token
1. Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
1. in case of error - return (401, 'Invalid access token')
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

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 ('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:
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

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

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 activity by id
Check activity.detail.status: activity status should be changed according to activity status model.
1. Return 409 (Invalid activity status) in case of error
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

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

Validate related entities

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).
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~~ ~~is defined, then needs to check that~~ ~~program_processing_status = 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)~~
2. 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)

Validate content

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

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

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

Response structure examples

See on API-specification

Expand

title	Response Example

Code Block

language	json

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

language	json

{
  "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
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		403	Access denied	invalid scope(s)
6		403	Your scope does not allow to access this resource. Missing allowances: care_plan:write	employee has no Approval on write
7		404	not found	The submitted activity is not related to the Patient Care Plan
8		409	Activity can be cancelled only if it has in_progress or scheduled status
9		409	client_id refers to legal entity that is not active	Validation error
10		409	client_id refers to legal entity with type that is not allowed to create medical events transactions
11		409	Invalid activity status
12		409	Legal entity must be ACTIVE
13		409	Signer DRFO doesn't match with requester tax_id
14		409	Unable to cancel activity with new Medication Request requests
15		409	Unable to cancel activity with active Medication requests
16		409	Unable to cancel activity with Service requests in active status
17		422	Signed content doesn't match with previously created activity	Validation error
18			Value is not allowed in enum
19	Специфічні
20

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical N/A

Technical modules where the method is used

Page Properties Report

headings	ID ТМ, Статус
cql	label = "tr-mis"

...

Versions Compared

Old Version 6

New Version 7

Key

Properties of a REST API method document

Purpose

Key points

Logic

Service logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Headers

Request data validation

Authorize

Validate legal entity

Validate User

Validate data consistency

Validate Digital Sign

Validate status transition

Validate status reason

Validate related entities

Validate content

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Technical modules where the method is used

Page Comparison

Versions Compared

Old Version 6

New Version 7

Key

Properties of a REST API method document

Purpose

Key points

Logic

Service logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Headers

Request data validation

Authorize

Validate legal entity

Validate User

Validate data consistency

Validate Digital Sign

Validate status transition

Validate status reason

Validate related entities

Validate content

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Technical modules where the method is used