Versions Compared

Old Version 22

changes.mady.by.user Serhii.Matiushyn

Saved on

compared with

New Version 23

changes.mady.by.user Nickolay Kolotov (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

...

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

...

  • 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

...

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

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

    • Return 422 schema validation error

...

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

Processing

See Logic

Response structure

See on Apiary

...

Expand
titleResponse example. Code: 422
Code Block
{
  "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
 Page Properties
HTTP status code
Message
What caused the error
200
  • Medication is not included in the program
  • Service is not included in the program
  • Service group is not included in the program
  • Author’s specialty doesn't allow to create activity with medical program from request
  • Care plan diagnosis is not allowed for the medical program
  • Care plan’s terms of service are not allowed for the medical program
  • Clinical impression with patient category should be present in request for this medical program
 Programs validation error
401
Invalid access token
  • validation fails
  • token is expired
403
  • Your scope does not allow to access this resource. Missing allowances: care_plan:write
  • Access denied
  • invalid scope(s)
409
  • client_id refers to legal entity that is not active
  • client_id refers to legal entity with type that is not allowed to create medical events transactions
  • Person is not active
  • Patient is not verified
  • Care Plan from url does not match to Care Plan ID specified in body
Validation error
422
  • Care plan with such id is not found
  • Invalid care plan status
  • Care Plan end date is expired
  • User is not allowed to create care plan activity for the employee
  • Value is not allowed in enum
  • Cannot refer to service for kind = medication_request
  • Medication should be active
  • Medication does not exist
  • Another activity with status ‘scheduled' or ‘in_progress' already exists in the current Care plan
  • Cannot refer to medication for kind = service_request
  • <Service/Service group> should be active
  • Another activity with status ‘scheduled' or ‘in_progress' already exists in the current Care plan
  • <medical event type> with such ID is not found
  • Clinical impression with patient category does not correspond to rule engine rule
  • Code field of quantity object should be equal to denumerator_unit of one of medication’s innms
  • System field of quantity object is not allowed for kind other than medication_request
  • Code field of quantity object is not allowed for kind other than medication_request
  • Only one of the parameters must be present
  • Event is not within care plan period range
  • Period end time must be within care plan period range, after period start date
  • Period start time must be within care plan period range
  • Bounds duration must be within care plan period range
  • Low must be within care plan period range, less than high, have the same code as high
  • High must be within care plan period range
  • String does not match pattern
  • Division is not active
  • Invalid employee status
  • Field is allowed for medication request activities only
  • Code field of daily_amount object should be equal to denumerator_unit of one of medication’s innms
  • System field of daily_amount object is not allowed for kind other than medication_request
  • Code field of daily_amount object is not allowed for kind other than medication_request
  • Program not found
  • Forbidden to create care plan activity for this medication!
  • Clinical impression with patient category exceeds validity period
Validation error