Purpose

This WS allows prequalifying care plan activity in order to define whether the medical program could be applied in this particular case or not.

...

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

Headers

Наприклад:

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

...

• Extract user_id from token.

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

• Check user's employee is from the same legal entity (

  'Access denied') in case employee has no Approval on write

  token) as managing_organisation from the care_plan:

  • 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 activity

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

...

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

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

• Check that each reference:

  • is valid ME

  • belongs to the patient ($.subject)

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

• If $.detail.reason_reference=clinical_impression:

  • 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

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

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

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

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

    • if false - skip rule validation

5. Goal

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

...

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

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

  • Return 422 schema validation error

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

• If $.detail.kind=medication_request:

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

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

  • 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

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

• If $.detail.kind =is other than medication_request:

  • Check (by schemata) the $.detail.quantity.system field’s value is MEDICATION_UNITfield is not present.

    • Return 422 ('value System field of quantity object is not allowed in enumfor kind other than medication_request')

  • 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 = truefield is not present.

    • Return 422 ('Code field of quantity object should be equal to denumerator_unit of one of medication’s innmsis not allowed for kind other than medication_request')

• If $.detail.kind is other than medication=service_request:

  • Check the that $.detail.quantity.system field is not presentfield’s value is SERVICE_UNIT, if submitted.

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

    Check the

    • in enum')

  • If care plan category is class_23, class_24 or class_25:

    • Check $.detail.quantity.system and $.detail.quantity.code

    field is not present.

    • are set, $.detail.quantity.code = MINUTE

      • Return 422 ('Code field of quantity object

      is not allowed for kind other than medication_request

      • should be in MINUTE for care plan’s category <category code>')

7. Scheduled

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

...

• Check the value is valid reference o employee resource

• Check employee is active and approved

  • Return 422 ('Invalid employee status')

10. Daily amount

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

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

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

• Check activity kind is medication_request

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

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

• If $.detail.kind=medication_request:

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

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

  • 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

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

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

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

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

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

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

11. Do not perform flag

Validate value in the field $.do_not_perform

...