Properties of a REST API method document

Purpose

This WS allows to add activity to the specified Care plan.

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

Key points

1. One request can add only one activity to the Care plan

2. Activity can be added by the employee who has Approval granted by the patient on write Care plan resource

3. Activity adds in async way. The result of the activity addition job should be link on the created activity (look at Get Care plan activity by ID).

4. Activity should be signed with DS. Signed content stores in the media storage.

Logic

This method adds activity to an 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 will store signed copy of Care Plan activity in Media Content Storage if all checks is passed.

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

Configuration parameters

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

Medical Events Dictionaries and configurations | ME_ALLOWED_TRANSACTIONS_LE_TYPES

Dictionaries

eHealth/care_plan_activity_outcomes

eHealth/ICPC2/condition_codes

eHealth/ICD10_AM/condition_codes

eHealth/care_plan_activity_goals

eHealth/care_plan_activity_cancel_reasons

eHealth/care_plan_activity_complete_reasons

eHealth/ucum/units

MEDICATION_UNIT

DAYS_OF_WEEK

EVENT_TIMING

SPECIALITY_TYPES_ALLOWED

PROVIDING_CONDITIONS_ALLOWED

INNM_DOSAGE

eHealth/activity_remaining_quantity_types

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorize

1. Verify the validity of access token

   • Return (401, 'Invalid access token') in case of validation fails

2. Verify that token is not expired

   • in case of error - return (401, 'Invalid access token')

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

4. If BLOCK_UNVERIFIED_PARTY_USERS is true, then check party's data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at <= current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):

   • in case not match - return 403 ("Access denied. Party is not verified")

Validate legal entity

1. Extract client_id from token

2. Check legal entity status is ACTIVE

   1. In case of error - return 409 ('client_id refers to legal entity that is not 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 Care plan

1. Get Care plan identifier from the URL

2. Check Care plan:

   1. belongs to patient (from url)

      1. in case of error - return 422 ('Care plan with such id is not found')

   2. is not in final status

      1. in case of error - return 422 ('Invalid care plan status')

   3. Care plan’s period.end >= current date.

      1. in case of error - return 422 ('Care Plan end date is expired')

Validate Patient

1. Get person_id from URL

2. Validate patient status is active

   1. in case of error - return 409 ('Person is not active')

3. If patient is a person - validate patient's verification_status is not equal to NOT_VERIFIED.

   1. in case NOT_VERIFIED - return error 409, "Patient is not verified"

Validate User

1. Extract user_id from token.

2. Check user has an active and approved employee from legal entity (token) 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

3. Check user's employee is from the same legal entity (token) as managing_organisation from the care_plan:

   1. Return 422 ('User is not allowed to create care plan activity for this care plan') in case employee’s legal_entity do not match managing_organisation of related care_plan

Validate Digital Sign

1. Validate request is signed

   1. in case of error - return 422 (“document must be signed by 1 signer but contains 0 signatures”)

2. Check DS is valid and not expired

3. Validate that DS belongs to the author of the activity

   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 activity

Activity should be validated. User fills following fields in the activity:

Validate activity identifier

Validate value in the field $.id, required

1. Check it is unique within Care plan and has UUID format

   1. Return 422 ("Activity with such id already exists")

Validate care plan identifier

As care plan identifier should be contained in signed content, $.care_plan required in the request body.

1. Check value matches with care plan identifier from URL

   1. in case of error - return 409 ('Care Plan from url does not match to Care Plan ID specified in body')

Validate activity author

Validate value in the field $.author, required

1. Check employee belongs to the user and legal entity (from token)

2. Employee is:

   1. an employee who has active Approval on write the Care plan

   2. belongs to user

      1. in case of error - return 422 ('User is not allowed to create care plan activity for the employee')

3. Check employee_type is value from list of employee_types in configuration: ACTIVITY_AUTHOR_EMPLOYEE_TYPES_ALLOWED

   • in case of error - return 422 ('Invalid employee type')

Validate activity detail

1. Kind

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

1. Check value in enum: medication_request, service_request

   1. Return 422 ('value is not allowed in enum')

2. Product

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

1. If $detail.kind=medication_request:

   1. Check the value is valid reference on medication resource.

      1. Return 422 ('Cannot refer to service for kind = medication_request')

   2. Check medication:

      1. is active

         1. in case of error - return 422 ('Medication should be active')

   3. type is INNM_DOSAGE

      1. in case of error - return 422 ('Medication does not exist')

   4. Check there is no duplicated activities (status=scheduled, in_progress) with the same medication in the Care plan

      1. Return 422 (“Another activity with status ‘scheduled' or ‘in_progress' already exists in the current Care plan”)

2. If $.detail.kind=service_request:

   1. Check that value is a reference on service or service_group

      1. Return 422 ('Cannot refer to medication for kind = service_request')

   2. Check service or service_group is active

      1. Return 422 ('<Service/Service group> should be active')

   3. Check there is no activities (status=scheduled, in_progress) with the same service or service_group in the Care plan

      1. Return 422 (“Another activity with status ‘scheduled' or ‘in_progress' already exists in the current Care plan“)

3. Reason code

Validate value in the field $.detail.reason_code, if submitted

1. Check that value matches with values in eHealth/ICD10_AM/condition_codes dictionary

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

4. Reason reference

Validate value in the field $.detail.reason_reference, if submitted

1. Check that value is an array with references of condition, observation, diagnostic report or clinical impression types.

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

2. Check that each reference:

   1. is valid ME

   2. belongs to the patient ($.subject)

      1. in case of error - return 422 ('<medical event type> with such ID is not found')

3. If $.detail.reason_reference=clinical_impression:

   1. Check that clinical impression is valid based on clinical_impression.code.coding.code and CLINICAL_IMPRESSION_PATIENT_CATEGORIES_<CODE.VALUE>_VALIDITY_PERIOD chart parameter: difference between now() and $.clinical_impression.effective_date_time OR $.clinical_impression.effective_period.end date must be less than a value in chart parameter (pointed in config for a corresponding care plan category) for clinical impression code

      1. in case of error - return 422 ("Clinical impression with patient category exceeds validity period")

   2. Check that clinical impression is based on active rule engine rule (exists record in rule_engine_rules collection with is_active=true, code.code=clinical_impression.code.coding.code, code.system=clinical_impression.code.coding.system)

      1. if true - check that clinical impression still corresponds to configured rule

         1. in case of error - return 422 (“Clinical impression with patient category does not correspond to rule engine rule“)

      2. if false - skip rule validation

5. Goal

Validate value in the field $.detail.goal, if submitted

1. Check that value matches with values in eHealth/care_plan_activity_goals dictionary

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

6. Quantity

Validate value in the field $.detail.quantity, if submitted

1. Check $.detail.quantity.value is not empty, is fractional, greater than zero

   1. Return 422 schema validation error

Validate $.detail.quantity.system, $.detail.quantity.code fields and their values in the object $.detail.quantity

1. If $.detail.kind=medication_request:

   1. Check (by schemata) the $.detail.quantity.system field’s value is MEDICATION_UNIT.

      1. Return 422 ('value is not allowed in enum')

   2. Check the $.detail.quantity.code field’s value equals to dosage.denumerator_unit of one of INNMs of a INNM_DOSAGE where innms with is_primary = true

      1. Return 422 ('Code field of quantity object should be equal to denumerator_unit of one of medication’s innms')

2. If $.detail.kind is other than medication_request:

   1. Check the $.detail.quantity.system field is not present.

      1. Return 422 ('System field of quantity object is not allowed for kind other than medication_request')

   2. Check the $.detail.quantity.code field is not present.

      1. Return 422 ('Code field of quantity object is not allowed for kind other than medication_request')

3. If $.detail.kind=service_request:

   1. Check that $.detail.quantity.system field’s value is SERVICE_UNIT, if submitted.

      1. Return 422 ('value is not allowed in enum')

   2. If care plan category is class_23, class_24 or class_25:

      1. Check $.detail.quantity.system and $.detail.quantity.code are set, $.detail.quantity.code = MINUTE

         1. Return 422 ('Code field of quantity object should be in MINUTE for care plan’s category <category code>')

4. Set remaining_quantity.value = $.detail.quantity.value, and use for remaining_quantity.system, remaining_quantity.code, remaining_quantity.unit fields, which were specified in $.detail.quantity object.

7. Scheduled

1. If submitted, validate there is one of the $.detail.scheduled_[x] field: scheduled_timing, scheduled_period or scheduled_string.

   1. Return 422 ('Only one of the parameters must be present') in case more then one submitted

Validate value in scheduled_timing, if submitted:

1. Validate value with schema of Timing type

   1. in case of error - return 422 schema validation error

2. If submitted, check values of the event within $.CarePlan.Period value

   1. in case of error - return 422 ('event is not within care plan period range')

3. If submitted, check bounds_period within $.CarePlan.Period value

   1. in case of bounds_period.end validation error - return 422 ('Period end time must be within care plan period range, after period start date')

   2. in case of bounds_period.start validation error - return 422 ('Period start time must be within care plan period range')

4. If submitted, check bounds_duration within $.CarePlan.Period value. Calculate bounds start date as care plan period start date if activity creates before care plan has started, else if activity creates during care plan performing - bound start date calculates as activity creation date. Bounds end date as bounds start date plus count of days specified in bounds_duration.

   1. If comparator field in bounds_duration - use it to compare bounds_duration value and care plan duration (possible values >, >=, =, <=, <)

   2. in case of error - return 422 ('Bounds duration must be within care plan period range')

5. If submitted, check when field values are in EVENT_TIMING dictionary

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

6. If submitted, check bounds_range within $.CarePlan.Period value: calculate bounds start - end date for bounds_range.low and bounds_range.high as described for bounds_duration (but w/o comparator field). Also, validate low.code = high.code, high.value > low.value

   1. in case bounds_range.low validation error - return 422 ('low must be within care plan period range, less than high, have the same code as high')

   2. in case bounds_range.high validation error - return 422 ('high must be within care plan period range')

7. if submitted, check day_of_week field values are in DAYS_OF_WEEK dictionary

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

8. if submitted, check time_of_day match regex ^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?$

   1. in case of error - return 422 ('string does not match pattern')

Validate value in scheduled_period, if submitted:

1. Validate value with schema of the Period type

   1. in case of error - return 422 schema validation error

2. Check values within $.CarePlan.Period

   1. in case period.end validation error - return 422 ('Period end time must be within care plan period range, after period start date')

   2. in case period.start validation error - return 422 ('Period start time must be within care plan period range')

8. Location

Validate value in the field $.detail.location, if submitted

1. Check the value is valid reference on division resource

2. Check the division is active and division’s legal entity has active status

   1. Return 422 ('Division is not active')

9. Performer

Validate value in the field $.detail.performer, if submitted

1. Check the value is valid reference o employee resource

2. Check employee is active and approved

   1. Return 422 ('Invalid employee status')

10. Daily amount

1. If submitted, check $.detail.daily_amount has the same code and system as quantity field.

   1. Return 422 ('Units of daily_amount field should be equal to units of quantity field')

2. Validate value in the field $.detail.daily_amount, if submitted.

3. Check activity kind is medication_request

   1. Return 422 ('Field is allowed for medication request activities only') in case kind is not medication_request

4. Validate $.detail.daily_amount.system, $.detail.daily_amount.code fields and their values in the object $.detail.daily_amount

5. If $.detail.kind=medication_request:

   1. Check (by schemata) the $.detail.daily_amount.system field’s value is MEDICATION_UNIT.

      1. Return 422 ('value is not allowed in enum')

   2. Check the $.detail.daily_amount.code field’s value equals to dosage.denumerator_unit of one of INNMs of a INNM_DOSAGE where innms with is_primary = true

      1. Return 422 ('Code field of daily_amount object should be equal to denumerator_unit of one of medication’s innms')

6. If $.detail.kind is other than medication_request:

   1. Check the $.detail.daily_amount.system field is not present.

      1. Return 422 ('System field of daily_amount object is not allowed for kind other than medication_request')

   2. Check the $.detail.daily_amount.code field is not present.

      1. Return 422 ('Code field of daily_amount object is not allowed for kind other than medication_request')

11. Medical program

Validate field exists for kind = medication_request

1. If $.detail.kind=medication_request, check that $.program is submitted

   1. in case of error - return 422 ("Medical program must be submitted for kind = medication_request")

Validate value in the field $.program, if submitted

1. Сheck program exists and active

   1. in case not found or is_active==false return 404 "Program not found"

2. Validate product is program participant:

   1. If product is medication - validate:

      1. that medication has brand that is an active member of the program (program_medications table)

         1. in case not found or is_active==false return 422 "Medication is not included in the program"

      2. that care_plan_activity_allowed for program medication == true

         1. in case ==false return 422 "Forbidden to create care plan activity for this medication!"

   2. If product is service - validate that service is an active member of the program

      1. in case not found or is_active==false return 422 "Service is not included in the program"

   3. if product is service_group - validate that service group is an active member of the program

      1. in case not found or is_active==false return 422 "Service group is not included in the program"

3. Validate medical program settings (prm.medical_programs table):

   1. if there is a parameter SPECIALITY_TYPES_ALLOWED:

      1. Check author’s speciality is present in SPECIALITY_TYPES_ALLOWED

         1. in case of error - return 422 “Author’s specialty doesn't allow to create activity with medical program from request”

   2. if there is a parameter CONDITIONS_ICD10_AM_ALLOWED or/and CONDITIONS_ICPC2_ALLOWED:

      1. Check related Care plan has condition codes in addresses field that correspond to codes pointed in CONDITIONS_ICD10_AM_ALLOWED or/and CONDITIONS_ICPC2_ALLOWED (depending on dictionary - eHealth/ICD10_AM/condition_codes or eHealth/ICPC2/condition_codes)

         1. in case of error - return 422 “Care plan diagnosis is not allowed for the medical program“

   3. If there is a parameter PROVIDING_CONDITIONS_ALLOWED:

      1. Check related Care plan has a value in terms_of_service field that is included in the list of PROVIDING_CONDITIONS_ALLOWED parameter

         1. in case of error - return 422 “Care plan’s terms of service are not allowed for the medical program“

   4. if there is a parameter patient_categories_allowed:

      1. check that patient_categories_allowed has codes in $.detail.reason_reference.[].clinical_impression.code.[].code that correspond to codes pointed in patient_categories_allowed

         1. in case of error - return 422 "Clinical impression with patient category should be present in request for this medical program".

12. Do not perform flag

Validate value in the field $.do_not_perform

1. Check it is false

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

13. Status

Validate value in the field $.status

1. Check it has value = scheduled

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

Processing

1. Save signed content to media storage

2. Save data to care_plan_activities collection in DB according to Care plan data model

   1. for kind = medication_request

      1. add unit (and its value) field into quantity, daily_amount, objects based on system, code out of MEDICATION_UNIT or SERVICE_UNIT dictionary.

      2. add system, code, unit fields into remaining_quantity based on quantity object

3. Save link from media storage to the $.signed_content_links field in care plan activities collection

4. If Care plan has status = new:

   1. Set care plan status = active

   2. Check if patient has another active or/and new Care plans with such condition code in the addresses field and the same terms of service:

      1. If such Care plans found - set these Care plans statuses to TERMINATED (related activities doesn`t change their status)

5. Set $.details.remaining_quantity_type:

   1. If $.details.kind = medication_request check $.details.quantity:

      1. if $.details.quantity = null then set $.details.remaining_quantity_type = null

      2. if $.details.quantity is not null then:

         1. set $.details.remaining_quantity_type = for_request

   2. If $.details.kind = service_request check $.details.quantity:

      1. if $.details.quantity = null then set $.details.remaining_quantity_type = null

      2. if $.details.quantity is not null then check $.details.quantity.code:

         1. if $.details.quantity.code is not null then set $.details.remaining_quantity_type = for_request

         2. if $.details.quantity.code = null then set $.details.remaining_quantity_type = for_use

6. Create job and return it’s id.

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used