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.

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/2125038637/care+plan#%D0%A1%D1%82%D0%B2%D0%BE%D1%80%D0%B5%D0%BD%D0%BD%D1%8F-%D0%BF%D0%B5%D1%80%D0%B2%D0%B8%D0%BD%D0%BD%D0%BE%D0%B3%D0%BE-%D0%BF%D1%80%D0%B8%D0%B7%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%BD%D1%8F-%D0%BF%D0%BB%D0%B0%D0%BD%D1%83-%D0%BB%D1%96%D0%BA%D1%83%D0%B2%D0%B0%D0%BD%D0%BD%D1%8F

Specification

...

Link

...

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.

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/2125038637/care+plan#%D0%A1%D1%82%D0%B2%D0%BE%D1%80%D0%B5%D0%BD%D0%BD%D1%8F-%D0%BF%D0%B5%D1%80%D0%B2%D0%B8%D0%BD%D0%BD%D0%BE%D0%B3%D0%BE-%D0%BF%D1%80%D0%B8%D0%B7%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%BD%D1%8F-%D0%BF%D0%BB%D0%B0%D0%BD%D1%83-%D0%BB%D1%96%D0%BA%D1%83%D0%B2%D0%B0%D0%BD%D0%BD%D1%8F

Specification

Logic

Render response with prequalification result in order to define whether the medical program could be applied in this particular case or not.

Key points

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

2. Activity shouldn’t be signed with DS

Global and configurable parameters

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/2125039308/Care+Plan+dictionaries+and+configurable+parameters+UA#%D0%9A%D0%BE%D0%BD%D1%84%D1%96%D0%B3%D1%83%D1%80%D0%B0%D1%86%D1%96%D0%B9%D0%BD%D1%96-%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B8

https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/583402009/Medical+Events+Dictionaries+and+configurations#ME_ALLOWED_TRANSACTIONS_LE_TYPES

Input parameters

Filters

No

Dictionaries

eHealth/care_plan_activity_outcomes

...

SPECIALITY_TYPES_ALLOWED

PROVIDING_CONDITIONS_ALLOWED

INNM_DOSAGE

Request structure

See on Apiary

Example:

...

...

_CONDITIONS_ALLOWED

INNM_DOSAGE

Request structure

See on Apiary

Example:

{
  "activity": {
    "author": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
{
  "activity": {
    "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": "servicemedication_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"
      },
      "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"
      },
      "description": "Some activity description",
      "do_not_perform": false,
      "status": "scheduled"
    }
  },
  "programs": [
    {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "medical_program"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    }
  ]
}

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)

Headers

Наприклад:

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

Request data validation

Validate legal entity

• Extract client_id from token

• Check legal entity status is ACTIVE

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

• Get Care plan identifier from the URL

• Check Care plan:

  • belongs to patient (from url)

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

  • is not in final status

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

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

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

Validate Patient

• Get person_id from URL

• Validate patient status is active

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

• If patient is a person - validate patient'sverification_status is not equal to NOT_VERIFIED.

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

Validate User

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

Validate care plan identifier

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

• Check value matches with care plan identifier from URL

  • 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

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

• Employee is:

  • an employee who has active Approval on write the Care plan

  • belongs to user

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

Validate activity detail

1. Kind

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

• Check value in enum: medication_request, service_request

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

2. Product

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

...

• Check that value is a reference on service or service_group

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

• Check service or service_group is active

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

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

3. Reason code

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

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

  • 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

• 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

• Check that value matches with values in eHealth/care_plan_activity_goals dictionary

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

6. Quantity

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

...

• 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 the $.detail.quantity.system field is not present.

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

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

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

• If $.detail.kind=service_request:

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

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

  • Check the $.detail.quantity.code = MINUTE If care plan category is class_23, class_24 or class_25:

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

      • Return 422 ('Code field of quantity object 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.

...

• Validate value with schema of the Period type

  • in case of error - return 422 schema validation error

• Check values within $.CarePlan.Period

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

  • 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

• Check the value is valid reference on division resource

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

  • Return 422 ('Division is not active')

9. Performer

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

• 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

• Check it is false

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

12. Status

Validate value in the field $.status

• Check it has value = scheduled

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

Validate programs

Validate value in the field $.programs

...

If program meets the requirements write status "VALID" according to apiary.

Processing

See Logic

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "program_id": "59781de0-2e64-4359-b716-bcc05a32c10f",
      "program_name": "Fee-For-Service",
      "status": "INVALID",
      "rejection_reason": "Service is not included in the program"
    }
  ],
  "urgent": {
    "authentication_method_current": {
      "type": "OTP",
      "number": "+38093*****85"
    }
  }
}

{
  "meta": {
    "code": "422",
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "error": {
    "type": "unverified",
    "message": "Patient is not active"
  }
}

Post-processing processes

API paragraph not found

HTTP status codes