Purpose
This method must be used to cancel of existing activity from patient's Care plan.
Specification
Preconditions
Sign message (pkcs7) that consists of signed content, digital signature, and signer public key
Important
Signed content of activity must be equal to activity stored in DB. See Get Care plan activity by ID
$.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
Signed content of activity must be equal to activity stored in DB. See Get Care plan activity by ID
$.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
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.
Global and configurable parameters
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
patient_id | String | MPI identifier of the patient |
| |
care_plan_id | String | Care Plan identifier |
| |
id | String | activity identifier |
|
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:
Dummy Example:
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 and processing
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 Digital Sign
Check DS is valid and not expired
Validate that DS belongs to the user
Check that DRFO from DS and user's party.tax_id matches
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.
Return 409 (Invalid activity status) in case of error
Check activity.detail.status in (in_progress, scheduled)
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_reasonsdictionaryValidate value within dictionary specified above
in case of error - return 422 ('value is not allowed in enum')
Validate related entities
if activity kind = medication_request:
Check there is no medication request requests in status
NEWbased on the activityin case of error - return 409 (Unable to cancel activity with new Medication Request requests).
Check there is no medication requests in status
ACTIVEbased on the activityin case of error - return 409 (Unable to cancel 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:
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)
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)
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
In case both object doesn't match - return 422 ('Signed content doesn't match with previously created activity')
Processing
Service logic
Save signed content to media storage
Update activity status (update also updated_at, updated_by)
Set detail.status_reason
Response structure
See on Apiary
Example: