...

PROVIDING_CONDITIONS_ALLOWED

INNM_DOSAGE

eHealth/activity_remaining_quantity_types

Request structure

See on Apiary

...

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

Headers

Наприклад:

Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{mis_client_secret}}

...

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“)

...

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

...

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

Check there is one of the required $.detail.product_[x] field is set: product_reference or product_codeable_concept.

...

1. If $detail.kind=medication_request:

   1. Check $.detail.product_reference field is submitted and has Reference type

      • in case it isn’t submitted - return 422 ('can't be blank')

      • in case of wrong type - return 422 ('type mismatch')

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

      1. Return 422 ('Cannot refer to <resource>for kind = medication_request')

   3. Check medication:

      1. is active

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

   4. type is INNM_DOSAGE

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

   5. 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 $.detail.product_reference field is submitted and has Reference type

      • in case it isn’t submitted - return 422 ('can't be blank')

      • in case of wrong type - return 422 ('type mismatch')

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

      1. Return 422 ('Cannot refer to <resource> for kind = service_request')

   3. Check service or service_group is active

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

3. If $.detail.kind=device_request:

   • Validate product_reference:

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

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

   • Validate product_reference:

   If $.detail.kind=device_request:

   • • Check there value is valid Reference on device_definition resource

       • Return 422 ('Cannot refer to <resource> for kind = device_request')

     • Check the device_definition is active

       • Return 422 ('Device definition is not active')

   • Validate product_codeable_concept:

     • Check that value matches with active values in device_definition_classification_type dictionary.

       • Return 422 ('value is not allowed in enum')

   Check there is no another activities (status=scheduled, in_progress) in the Care plan with the same product_reference or product_codeable_concept, and program = $.detail.program (including the equality of program absence/null value)

   • Return 422 (“Another activity with status ‘scheduled' or ‘in_progress' already exists in the current Care plan within current program value“)

...

• Check it is submitted if $.detail.kind=device_request and $.detail.program is set

  • Return 422 ('required property quantity was not present')

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

   1. Return 422 schema validation error

...

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. if $.detail.kind=device_request:

   • Check $.detail.quantity.value is not empty, is integer, greater than zero

     • Return 422 schema validation error

   • Check the $.detail.quantity.system is device_unit dictionary.

     • Return 422 ('value is not allowed in enum')

   • Check that $.detail.quantity.code matches to active values from $.detail.quantity.system.

     • Return 422 ('value is not allowed in enum')

   • Validate Device Definitions in case $.detail.product_codeable_concept and $.detail.program was set:

     • Find all active Device Definitions with packaging_unit that matches to $.detail.quantity.code

     • Check that there is at least one device definition where the remainder of division $.detail.quantity.value/packaging_count is equal to zero

       • Return 422 ('Not found any appropriate Device Definition')

   • Validate Device Definition in case $.detail.product_reference was set:

     • Get Device Definition in the $.detail.product_reference (depends on what was set)

     • Check it has packaging_unit that matches to $.quantity.code of the Activity

       • Return 422 ('Device Definition must have the same units of measure as pointed in the quantity of the Activity')

     • Check the remainder of division $.detail.quantity.value / device_definition.packaging_count is equal to zero

       • Return 422 ('The amount of devices in device request must be divisible to device package quantity')

5. 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.

...

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. С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) or medication itself is an active member of the program

         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"

   4. If product is code from device_definition_classification_type dictionary (product_codeable_concept was set) or product is device_definition (product_reference was set):

      • Find all program devices with:

        • is_active=true

        • care_plan_activity_allowed = true

        • period (start_date and end_date) that includes current date

        • max_daily_count >= $.quantity.value/($.detail.scheduled_period.end - $.detail.scheduled_period.start + 1). Count scheduled_period length in days, without taking into account time

        • related to the Device Definitions that has successfully passed Quantity and Product validations before

          • in case not found return 422 ('No appropriate participants found for this medical 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".

   5. if there is parameter device_request_allowed_code_types and activity kind=device_request, then check values in the array of values:

      • if it includes CLASSIFICATION_TYPE - it is allowed to set $.detail.product_codeable_concept in the activity

      • if it includes DEVICE_DEFINITION - it is allowed to set $.detail.product_reference in the activity

        • in case of a mismatch between the filled field and the config values - return 422 ("<Device definition/Device classification type> is not allowed to set for this medical program").

...

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 or device_request, then 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.

...