...

Specification

...

INNM_DOSAGE

Request structure

See on Apiary

Example:

{
  "signed_data": "ew0KICAicGVyaW9kIjogew0KIC..."
}

...

• 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 (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 Digital Sign

• Validate request is signed

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

• Check DS is valid and not expired

• Validate that DS belongs to the author of the activity

  • Check that DRFO from DS and user's party.tax_id matches

    • in case of error - return 409 (“Signer DRFO doesn't match with requester tax_id“)

...

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

    • 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

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

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

...

• 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. Medical program

Validate field exists for kind = medication_request

...

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:

   • Set care plan status = active

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

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

5. Create job and return it’s id.

Response structure

See on Apiary

Example:

{
  "data": {
    "id": "75a5d991-0bf7-476f-b3cf-bec73f044b2e",
    "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": "servicemedication"
              }
            ],
            "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",
        "unit": "мг"
      },
      "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": 136.5,
        "system": "MEDICATION_UNIT",
        "code": "MG",
        "unit": "мг"
      },
      "description": "Some activity description",
      "do_not_perform": false,
      "program": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "medical_program"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "status": "completedscheduled",
      "status_reason": {
        "coding": [
          {
            "system": "eHealth/care_plan_activity_cancel_reasons",
            "code": "some code"
          }
        ]
      },
      "remaining_quantity": {
        "value": 12,
        "system": "MEDICATION_UNIT",
        "code": "MG",
        "unit": "мг"
      }
    },
    "outcome_reference": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      }
    ],
    "outcome_codeable_concept": [
      {
        "coding": [
          {
            "system": "eHealth/care_plan_activity_outcomes",
            "code": "some code"
          }
        ]
      }
    ]
  },
  "meta": {
    "code": 201,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

...